Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified	Actions
📁 ..	-	2025-05-25 12:27
📄 applicationGateway.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}": { "delete": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_Delete", "x-ms-examples": { "Delete ApplicationGateway": { "$ref": "./examples/ApplicationGatewayDelete.json" } }, "description": "Deletes the specified application gateway.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Request successful. Resource with the specified name does not exist." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_Get", "x-ms-examples": { "Get ApplicationGateway": { "$ref": "./examples/ApplicationGatewayGet.json" } }, "description": "Gets the specified application gateway.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns an ApplicationGateway resource.", "schema": { "$ref": "#/definitions/ApplicationGateway" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } } }, "put": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_CreateOrUpdate", "description": "Creates or updates the specified application gateway.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ApplicationGateway" }, "description": "Parameters supplied to the create or update application gateway operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting ApplicationGateway resource.", "schema": { "$ref": "#/definitions/ApplicationGateway" } }, "200": { "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", "schema": { "$ref": "#/definitions/ApplicationGateway" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create Application Gateway": { "$ref": "./examples/ApplicationGatewayCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_UpdateTags", "x-ms-examples": { "Update Application Gateway tags": { "$ref": "./examples/ApplicationGatewayUpdateTags.json" } }, "description": "Updates the specified application gateway tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update application gateway tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", "schema": { "$ref": "#/definitions/ApplicationGateway" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_List", "x-ms-examples": { "Lists all application gateways in a resource group": { "$ref": "./examples/ApplicationGatewayList.json" } }, "description": "Lists all application gateways in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns a list of ApplicationGateway resources.", "schema": { "$ref": "#/definitions/ApplicationGatewayListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAll", "x-ms-examples": { "Lists all application gateways in a subscription": { "$ref": "./examples/ApplicationGatewayListAll.json" } }, "description": "Gets all the application gateways in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns a list of ApplicationGateway resources.", "schema": { "$ref": "#/definitions/ApplicationGatewayListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": { "post": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_Start", "x-ms-examples": { "Start Application Gateway": { "$ref": "./examples/ApplicationGatewayStart.json" } }, "description": "Starts the specified application gateway.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation starts the ApplicationGateway resource." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": { "post": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_Stop", "x-ms-examples": { "Stop Application Gateway": { "$ref": "./examples/ApplicationGatewayStop.json" } }, "description": "Stops the specified application gateway in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation stops the ApplicationGateway resource." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": { "post": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_BackendHealth", "description": "Gets the backend health of the specified application gateway in a resource group.", "x-ms-examples": { "Get Backend Health": { "$ref": "./examples/ApplicationGatewayBackendHealthGet.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." } ], "responses": { "200": { "description": "Request successful.", "schema": { "$ref": "#/definitions/ApplicationGatewayBackendHealth" } }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand": { "post": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_BackendHealthOnDemand", "description": "Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.", "x-ms-examples": { "Test Backend Health": { "$ref": "./examples/ApplicationGatewayBackendHealthTest.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the application gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." }, { "name": "probeRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ApplicationGatewayOnDemandProbe" }, "description": "Request body for on-demand test probe operation." } ], "responses": { "200": { "description": "Request successful.", "schema": { "$ref": "#/definitions/ApplicationGatewayBackendHealthOnDemand" } }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAvailableServerVariables", "x-ms-examples": { "Get Available Server Variables": { "$ref": "./examples/ApplicationGatewayAvailableServerVariablesGet.json" } }, "description": "Lists all available server variables.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns a list of all available server variables.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableServerVariablesResult" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAvailableRequestHeaders", "x-ms-examples": { "Get Available Request Headers": { "$ref": "./examples/ApplicationGatewayAvailableRequestHeadersGet.json" } }, "description": "Lists all available request headers.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns a list of all available request headers.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableRequestHeadersResult" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAvailableResponseHeaders", "x-ms-examples": { "Get Available Response Headers": { "$ref": "./examples/ApplicationGatewayAvailableResponseHeadersGet.json" } }, "description": "Lists all available response headers.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns a list of all available response headers.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableResponseHeadersResult" } }, "default": { "description": "Unexpected error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAvailableWafRuleSets", "x-ms-examples": { "Get Available Waf Rule Sets": { "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json" } }, "description": "Lists all available web application firewall rule sets.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns a list of all available web application firewall rule sets.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAvailableSslOptions", "x-ms-examples": { "Get Available Ssl Options": { "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" } }, "description": "Lists available Ssl options for configuring Ssl policy.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns all available Ssl options for configuring Ssl policy.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies", "x-ms-examples": { "Get Available Ssl Predefined Policies": { "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "description": "Lists all SSL predefined policies for configuring Ssl policy.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Success. The operation returns a lists of all Ssl predefined policies for configuring Ssl policy.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": { "get": { "tags": [ "ApplicationGateways" ], "operationId": "ApplicationGateways_GetSslPredefinedPolicy", "x-ms-examples": { "Get Available Ssl Predefined Policy by name": { "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json" } }, "description": "Gets Ssl predefined policy with the specified policy name.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "predefinedPolicyName", "in": "path", "required": true, "type": "string", "description": "Name of Ssl predefined policy." } ], "responses": { "200": { "description": "Success. The operation returns a Ssl predefined policy with the specified policy name.", "schema": { "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } } } } }, "definitions": { "ApplicationGatewayOnDemandProbe": { "properties": { "protocol": { "$ref": "#/definitions/ApplicationGatewayProtocol", "description": "The protocol used for the probe." }, "host": { "type": "string", "description": "Host name to send the probe to." }, "path": { "type": "string", "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>." }, "timeout": { "type": "integer", "format": "int32", "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." }, "pickHostNameFromBackendHttpSettings": { "type": "boolean", "description": "Whether the host header should be picked from the backend http settings. Default value is false." }, "match": { "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", "description": "Criterion for classifying a healthy probe response." }, "backendAddressPool": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to backend pool of application gateway to which probe request will be sent." }, "backendHttpSettings": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to backend http setting of application gateway to be used for test probe." } }, "description": "Details of on demand test probe request." }, "ApplicationGatewayBackendHealthOnDemand": { "properties": { "backendAddressPool": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", "description": "Reference to an ApplicationGatewayBackendAddressPool resource." }, "backendHealthHttpSettings": { "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings", "description": "Application gateway BackendHealthHttp settings." } }, "description": "Result of on demand test probe." }, "ApplicationGatewayBackendHealth": { "properties": { "backendAddressPools": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" }, "description": "A list of ApplicationGatewayBackendHealthPool resources." } }, "description": "Response for ApplicationGatewayBackendHealth API service call." }, "ApplicationGatewayBackendHealthPool": { "properties": { "backendAddressPool": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", "description": "Reference to an ApplicationGatewayBackendAddressPool resource." }, "backendHttpSettingsCollection": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings" }, "description": "List of ApplicationGatewayBackendHealthHttpSettings resources." } }, "description": "Application gateway BackendHealth pool." }, "ApplicationGatewayBackendHealthHttpSettings": { "properties": { "backendHttpSettings": { "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings", "description": "Reference to an ApplicationGatewayBackendHttpSettings resource." }, "servers": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHealthServer" }, "description": "List of ApplicationGatewayBackendHealthServer resources." } }, "description": "Application gateway BackendHealthHttp settings." }, "ApplicationGatewayBackendHealthServer": { "properties": { "address": { "type": "string", "description": "IP address or FQDN of backend server." }, "ipConfiguration": { "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", "description": "Reference to IP configuration of backend server." }, "health": { "type": "string", "description": "Health of backend server.", "enum": [ "Unknown", "Up", "Down", "Partial", "Draining" ], "x-ms-enum": { "name": "ApplicationGatewayBackendHealthServerHealth", "modelAsString": true } }, "healthProbeLog": { "type": "string", "description": "Health Probe Log." } }, "description": "Application gateway backendhealth http settings." }, "ApplicationGatewaySku": { "properties": { "name": { "type": "string", "description": "Name of an application gateway SKU.", "enum": [ "Standard_Small", "Standard_Medium", "Standard_Large", "WAF_Medium", "WAF_Large", "Standard_v2", "WAF_v2" ], "x-ms-enum": { "name": "ApplicationGatewaySkuName", "modelAsString": true } }, "tier": { "type": "string", "description": "Tier of an application gateway.", "enum": [ "Standard", "WAF", "Standard_v2", "WAF_v2" ], "x-ms-enum": { "name": "ApplicationGatewayTier", "modelAsString": true } }, "capacity": { "type": "integer", "format": "int32", "description": "Capacity (instance count) of an application gateway." } }, "description": "SKU of an application gateway." }, "ApplicationGatewaySslPolicy": { "properties": { "disabledSslProtocols": { "type": "array", "description": "Ssl protocols to be disabled on application gateway.", "items": { "type": "string", "$ref": "#/definitions/ProtocolsEnum" } }, "policyType": { "type": "string", "description": "Type of Ssl Policy.", "enum": [ "Predefined", "Custom" ], "x-ms-enum": { "name": "ApplicationGatewaySslPolicyType", "modelAsString": true } }, "policyName": { "$ref": "#/definitions/PolicyNameEnum", "description": "Name of Ssl predefined policy." }, "cipherSuites": { "type": "array", "items": { "$ref": "#/definitions/CipherSuitesEnum" }, "description": "Ssl cipher suites to be enabled in the specified order to application gateway." }, "minProtocolVersion": { "$ref": "#/definitions/ProtocolsEnum", "description": "Minimum version of Ssl protocol to be supported on application gateway." } }, "description": "Application Gateway Ssl policy." }, "ApplicationGatewayIPConfigurationPropertiesFormat": { "properties": { "subnet": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to the subnet resource. A subnet from where application gateway gets its private address." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the application gateway IP configuration resource." } }, "description": "Properties of IP configuration of an application gateway." }, "ApplicationGatewayIPConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat", "description": "Properties of the application gateway IP configuration." }, "name": { "type": "string", "description": "Name of the IP configuration that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." }, "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { "properties": { "data": { "type": "string", "description": "Certificate public data." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the authentication certificate resource." } }, "description": "Authentication certificates properties of an application gateway." }, "ApplicationGatewayAuthenticationCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat", "description": "Properties of the application gateway authentication certificate." }, "name": { "type": "string", "description": "Name of the authentication certificate that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Authentication certificates of an application gateway." }, "ApplicationGatewayTrustedRootCertificatePropertiesFormat": { "properties": { "data": { "type": "string", "description": "Certificate public data." }, "keyVaultSecretId": { "type": "string", "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the trusted root certificate resource." } }, "description": "Trusted Root certificates properties of an application gateway." }, "ApplicationGatewayTrustedRootCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat", "description": "Properties of the application gateway trusted root certificate." }, "name": { "type": "string", "description": "Name of the trusted root certificate that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Trusted Root certificates of an application gateway." }, "ApplicationGatewaySslCertificatePropertiesFormat": { "properties": { "data": { "type": "string", "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." }, "password": { "type": "string", "description": "Password for the pfx file specified in data. Only applicable in PUT request." }, "publicCertData": { "readOnly": true, "type": "string", "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." }, "keyVaultSecretId": { "type": "string", "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the SSL certificate resource." } }, "description": "Properties of SSL certificates of an application gateway." }, "ApplicationGatewaySslCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat", "description": "Properties of the application gateway SSL certificate." }, "name": { "type": "string", "description": "Name of the SSL certificate that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "SSL certificates of an application gateway." }, "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { "properties": { "privateIPAddress": { "type": "string", "description": "PrivateIPAddress of the network interface IP Configuration." }, "privateIPAllocationMethod": { "$ref": "./network.json#/definitions/IPAllocationMethod", "description": "The private IP address allocation method." }, "subnet": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to the subnet resource." }, "publicIPAddress": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to the PublicIP resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the frontend IP configuration resource." } }, "description": "Properties of Frontend IP configuration of an application gateway." }, "ApplicationGatewayFrontendIPConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat", "description": "Properties of the application gateway frontend IP configuration." }, "name": { "type": "string", "description": "Name of the frontend IP configuration that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Frontend IP configuration of an application gateway." }, "ApplicationGatewayFrontendPortPropertiesFormat": { "properties": { "port": { "type": "integer", "format": "int32", "description": "Frontend port." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the frontend port resource." } }, "description": "Properties of Frontend port of an application gateway." }, "ApplicationGatewayFrontendPort": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat", "description": "Properties of the application gateway frontend port." }, "name": { "type": "string", "description": "Name of the frontend port that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Frontend port of an application gateway." }, "ApplicationGatewayBackendAddress": { "properties": { "fqdn": { "type": "string", "description": "Fully qualified domain name (FQDN)." }, "ipAddress": { "type": "string", "description": "IP address." } }, "description": "Backend address of an application gateway." }, "ApplicationGatewayBackendAddressPoolPropertiesFormat": { "properties": { "backendIPConfigurations": { "readOnly": true, "type": "array", "items": { "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" }, "description": "Collection of references to IPs defined in network interfaces." }, "backendAddresses": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayBackendAddress" }, "description": "Backend addresses." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the backend address pool resource." } }, "description": "Properties of Backend Address Pool of an application gateway." }, "ApplicationGatewayBackendAddressPool": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat", "description": "Properties of the application gateway backend address pool." }, "name": { "type": "string", "description": "Name of the backend address pool that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Backend Address Pool of an application gateway." }, "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { "properties": { "port": { "type": "integer", "format": "int32", "description": "The destination port on the backend." }, "protocol": { "$ref": "#/definitions/ApplicationGatewayProtocol", "description": "The protocol used to communicate with the backend." }, "cookieBasedAffinity": { "type": "string", "description": "Cookie based affinity.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "ApplicationGatewayCookieBasedAffinity", "modelAsString": true } }, "requestTimeout": { "type": "integer", "format": "int32", "description": "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds." }, "probe": { "$ref": "./network.json#/definitions/SubResource", "description": "Probe resource of an application gateway." }, "authenticationCertificates": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "Array of references to application gateway authentication certificates." }, "trustedRootCertificates": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "Array of references to application gateway trusted root certificates." }, "connectionDraining": { "$ref": "#/definitions/ApplicationGatewayConnectionDraining", "description": "Connection draining of the backend http settings resource." }, "hostName": { "type": "string", "description": "Host header to be sent to the backend servers." }, "pickHostNameFromBackendAddress": { "type": "boolean", "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." }, "affinityCookieName": { "type": "string", "description": "Cookie name to use for the affinity cookie." }, "probeEnabled": { "type": "boolean", "description": "Whether the probe is enabled. Default value is false." }, "path": { "type": "string", "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the backend HTTP settings resource." } }, "description": "Properties of Backend address pool settings of an application gateway." }, "ApplicationGatewayBackendHttpSettings": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat", "description": "Properties of the application gateway backend HTTP settings." }, "name": { "type": "string", "description": "Name of the backend http settings that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Backend address pool settings of an application gateway." }, "ApplicationGatewayHttpListenerPropertiesFormat": { "properties": { "frontendIPConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "Frontend IP configuration resource of an application gateway." }, "frontendPort": { "$ref": "./network.json#/definitions/SubResource", "description": "Frontend port resource of an application gateway." }, "protocol": { "$ref": "#/definitions/ApplicationGatewayProtocol", "description": "Protocol of the HTTP listener." }, "hostName": { "type": "string", "description": "Host name of HTTP listener." }, "sslCertificate": { "$ref": "./network.json#/definitions/SubResource", "description": "SSL certificate resource of an application gateway." }, "requireServerNameIndication": { "type": "boolean", "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the HTTP listener resource." }, "customErrorConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayCustomError" }, "description": "Custom error configurations of the HTTP listener." }, "firewallPolicy": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to the FirewallPolicy resource." }, "hostNames": { "type": "array", "items": { "type": "string" }, "description": "List of Host names for HTTP Listener that allows special wildcard characters as well." } }, "description": "Properties of HTTP listener of an application gateway." }, "ApplicationGatewayHttpListener": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat", "description": "Properties of the application gateway HTTP listener." }, "name": { "type": "string", "description": "Name of the HTTP listener that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Http listener of an application gateway." }, "ApplicationGatewayPathRulePropertiesFormat": { "properties": { "paths": { "type": "array", "items": { "type": "string" }, "description": "Path rules of URL path map." }, "backendAddressPool": { "$ref": "./network.json#/definitions/SubResource", "description": "Backend address pool resource of URL path map path rule." }, "backendHttpSettings": { "$ref": "./network.json#/definitions/SubResource", "description": "Backend http settings resource of URL path map path rule." }, "redirectConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "Redirect configuration resource of URL path map path rule." }, "rewriteRuleSet": { "$ref": "./network.json#/definitions/SubResource", "description": "Rewrite rule set resource of URL path map path rule." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the path rule resource." }, "firewallPolicy": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to the FirewallPolicy resource." } }, "description": "Properties of path rule of an application gateway." }, "ApplicationGatewayPathRule": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat", "description": "Properties of the application gateway path rule." }, "name": { "type": "string", "description": "Name of the path rule that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Path rule of URL path map of an application gateway." }, "ApplicationGatewayProbePropertiesFormat": { "properties": { "protocol": { "$ref": "#/definitions/ApplicationGatewayProtocol", "description": "The protocol used for the probe." }, "host": { "type": "string", "description": "Host name to send the probe to." }, "path": { "type": "string", "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to <Protocol>://<host>:<port><path>." }, "interval": { "type": "integer", "format": "int32", "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." }, "timeout": { "type": "integer", "format": "int32", "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." }, "unhealthyThreshold": { "type": "integer", "format": "int32", "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." }, "pickHostNameFromBackendHttpSettings": { "type": "boolean", "description": "Whether the host header should be picked from the backend http settings. Default value is false." }, "minServers": { "type": "integer", "format": "int32", "description": "Minimum number of servers that are always marked healthy. Default value is 0." }, "match": { "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", "description": "Criterion for classifying a healthy probe response." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the probe resource." }, "port": { "type": "integer", "format": "int32", "description": "Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.", "minimum": 1, "maximum": 65535 } }, "description": "Properties of probe of an application gateway." }, "ApplicationGatewayProbeHealthResponseMatch": { "properties": { "body": { "type": "string", "description": "Body that must be contained in the health response. Default value is empty." }, "statusCodes": { "type": "array", "items": { "type": "string" }, "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." } }, "description": "Application gateway probe health response match." }, "ApplicationGatewayProbe": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat", "description": "Properties of the application gateway probe." }, "name": { "type": "string", "description": "Name of the probe that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Probe of the application gateway." }, "ApplicationGatewayRequestRoutingRulePropertiesFormat": { "properties": { "ruleType": { "type": "string", "description": "Rule type.", "enum": [ "Basic", "PathBasedRouting" ], "x-ms-enum": { "name": "ApplicationGatewayRequestRoutingRuleType", "modelAsString": true } }, "priority": { "type": "integer", "format": "int32", "minimum": 1, "exclusiveMinimum": false, "maximum": 20000, "exclusiveMaximum": false, "description": "Priority of the request routing rule." }, "backendAddressPool": { "$ref": "./network.json#/definitions/SubResource", "description": "Backend address pool resource of the application gateway." }, "backendHttpSettings": { "$ref": "./network.json#/definitions/SubResource", "description": "Backend http settings resource of the application gateway." }, "httpListener": { "$ref": "./network.json#/definitions/SubResource", "description": "Http listener resource of the application gateway." }, "urlPathMap": { "$ref": "./network.json#/definitions/SubResource", "description": "URL path map resource of the application gateway." }, "rewriteRuleSet": { "$ref": "./network.json#/definitions/SubResource", "description": "Rewrite Rule Set resource in Basic rule of the application gateway." }, "redirectConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "Redirect configuration resource of the application gateway." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the request routing rule resource." } }, "description": "Properties of request routing rule of the application gateway." }, "ApplicationGatewayRequestRoutingRule": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat", "description": "Properties of the application gateway request routing rule." }, "name": { "type": "string", "description": "Name of the request routing rule that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Request routing rule of an application gateway." }, "ApplicationGatewayRewriteRuleSet": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat", "description": "Properties of the application gateway rewrite rule set." }, "name": { "type": "string", "description": "Name of the rewrite rule set that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Rewrite rule set of an application gateway." }, "ApplicationGatewayRewriteRuleSetPropertiesFormat": { "properties": { "rewriteRules": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayRewriteRule" }, "description": "Rewrite rules in the rewrite rule set." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the rewrite rule set resource." } }, "description": "Properties of rewrite rule set of the application gateway." }, "ApplicationGatewayRewriteRule": { "properties": { "name": { "type": "string", "description": "Name of the rewrite rule that is unique within an Application Gateway." }, "ruleSequence": { "type": "integer", "description": "Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet." }, "conditions": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayRewriteRuleCondition" }, "description": "Conditions based on which the action set execution will be evaluated." }, "actionSet": { "type": "object", "$ref": "#/definitions/ApplicationGatewayRewriteRuleActionSet", "description": "Set of actions to be done as part of the rewrite Rule." } }, "description": "Rewrite rule of an application gateway." }, "ApplicationGatewayRewriteRuleCondition": { "properties": { "variable": { "type": "string", "description": "The condition parameter of the RewriteRuleCondition." }, "pattern": { "type": "string", "description": "The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition." }, "ignoreCase": { "type": "boolean", "description": "Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison." }, "negate": { "type": "boolean", "description": "Setting this value as truth will force to check the negation of the condition given by the user." } }, "description": "Set of conditions in the Rewrite Rule in Application Gateway." }, "ApplicationGatewayRewriteRuleActionSet": { "properties": { "requestHeaderConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" }, "description": "Request Header Actions in the Action Set." }, "responseHeaderConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" }, "description": "Response Header Actions in the Action Set." }, "urlConfiguration": { "$ref": "#/definitions/ApplicationGatewayUrlConfiguration", "description": "Url Configuration Action in the Action Set." } }, "description": "Set of actions in the Rewrite Rule in Application Gateway." }, "ApplicationGatewayHeaderConfiguration": { "properties": { "headerName": { "type": "string", "description": "Header name of the header configuration." }, "headerValue": { "type": "string", "description": "Header value of the header configuration." } }, "description": "Header configuration of the Actions set in Application Gateway." }, "ApplicationGatewayUrlConfiguration": { "properties": { "modifiedPath": { "type": "string", "description": "Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null." }, "modifiedQueryString": { "type": "string", "description": "Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null." }, "reroute": { "type": "boolean", "description": "If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false." } }, "description": "Url configuration of the Actions set in Application Gateway." }, "ApplicationGatewayRedirectConfigurationPropertiesFormat": { "properties": { "redirectType": { "type": "string", "$ref": "#/definitions/RedirectTypeEnum", "description": "HTTP redirection type." }, "targetListener": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to a listener to redirect the request to." }, "targetUrl": { "type": "string", "description": "Url to redirect the request to." }, "includePath": { "type": "boolean", "description": "Include path in the redirected url." }, "includeQueryString": { "type": "boolean", "description": "Include query string in the redirected url." }, "requestRoutingRules": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "Request routing specifying redirect configuration." }, "urlPathMaps": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "Url path maps specifying default redirect configuration." }, "pathRules": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "Path rules specifying redirect configuration." } }, "description": "Properties of redirect configuration of the application gateway." }, "ApplicationGatewayRedirectConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat", "description": "Properties of the application gateway redirect configuration." }, "name": { "type": "string", "description": "Name of the redirect configuration that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Redirect configuration of an application gateway." }, "ApplicationGatewayPropertiesFormat": { "properties": { "sku": { "$ref": "#/definitions/ApplicationGatewaySku", "description": "SKU of the application gateway resource." }, "sslPolicy": { "$ref": "#/definitions/ApplicationGatewaySslPolicy", "description": "SSL policy of the application gateway resource." }, "operationalState": { "readOnly": true, "type": "string", "description": "Operational state of the application gateway resource.", "enum": [ "Stopped", "Starting", "Running", "Stopping" ], "x-ms-enum": { "name": "ApplicationGatewayOperationalState", "modelAsString": true } }, "gatewayIPConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayIPConfiguration" }, "description": "Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "authenticationCertificates": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" }, "description": "Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "trustedRootCertificates": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificate" }, "description": "Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "sslCertificates": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewaySslCertificate" }, "description": "SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "frontendIPConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" }, "description": "Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "frontendPorts": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayFrontendPort" }, "description": "Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "probes": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayProbe" }, "description": "Probes of the application gateway resource." }, "backendAddressPools": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" }, "description": "Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "backendHttpSettingsCollection": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" }, "description": "Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "httpListeners": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayHttpListener" }, "description": "Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "urlPathMaps": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayUrlPathMap" }, "description": "URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "requestRoutingRules": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" }, "description": "Request routing rules of the application gateway resource." }, "rewriteRuleSets": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayRewriteRuleSet" }, "description": "Rewrite rules for the application gateway resource." }, "redirectConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" }, "description": "Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." }, "webApplicationFirewallConfiguration": { "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration", "description": "Web application firewall configuration." }, "firewallPolicy": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to the FirewallPolicy resource." }, "enableHttp2": { "type": "boolean", "description": "Whether HTTP2 is enabled on the application gateway resource." }, "enableFips": { "type": "boolean", "description": "Whether FIPS is enabled on the application gateway resource." }, "autoscaleConfiguration": { "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration", "description": "Autoscale Configuration." }, "resourceGuid": { "readOnly": true, "type": "string", "description": "The resource GUID property of the application gateway resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the application gateway resource." }, "customErrorConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayCustomError" }, "description": "Custom error configurations of the application gateway resource." }, "forceFirewallPolicyAssociation": { "type": "boolean", "description": "If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config." } }, "description": "Properties of the application gateway." }, "ApplicationGateway": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayPropertiesFormat", "description": "Properties of the application gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "zones": { "type": "array", "items": { "type": "string" }, "description": "A list of availability zones denoting where the resource needs to come from." }, "identity": { "$ref": "./network.json#/definitions/ManagedServiceIdentity", "description": "The identity of the application gateway, if configured." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Application gateway resource." }, "ApplicationGatewayListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGateway" }, "description": "List of an application gateways in a resource group." }, "nextLink": { "type": "string", "description": "URL to get the next set of results." } }, "description": "Response for ListApplicationGateways API service call." }, "ApplicationGatewayUrlPathMapPropertiesFormat": { "properties": { "defaultBackendAddressPool": { "$ref": "./network.json#/definitions/SubResource", "description": "Default backend address pool resource of URL path map." }, "defaultBackendHttpSettings": { "$ref": "./network.json#/definitions/SubResource", "description": "Default backend http settings resource of URL path map." }, "defaultRewriteRuleSet": { "$ref": "./network.json#/definitions/SubResource", "description": "Default Rewrite rule set resource of URL path map." }, "defaultRedirectConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "Default redirect configuration resource of URL path map." }, "pathRules": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayPathRule" }, "description": "Path rule of URL path map resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the URL path map resource." } }, "description": "Properties of UrlPathMap of the application gateway." }, "ApplicationGatewayUrlPathMap": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat", "description": "Properties of the application gateway URL path map." }, "name": { "type": "string", "description": "Name of the URL path map that is unique within an Application Gateway." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." }, "ApplicationGatewayWebApplicationFirewallConfiguration": { "properties": { "enabled": { "type": "boolean", "description": "Whether the web application firewall is enabled or not." }, "firewallMode": { "type": "string", "description": "Web application firewall mode.", "enum": [ "Detection", "Prevention" ], "x-ms-enum": { "name": "ApplicationGatewayFirewallMode", "modelAsString": true } }, "ruleSetType": { "type": "string", "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." }, "ruleSetVersion": { "type": "string", "description": "The version of the rule set type." }, "disabledRuleGroups": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" }, "description": "The disabled rule groups." }, "requestBodyCheck": { "type": "boolean", "description": "Whether allow WAF to check request Body." }, "maxRequestBodySize": { "type": "integer", "format": "int32", "maximum": 128, "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, "description": "Maximum request body size for WAF." }, "maxRequestBodySizeInKb": { "type": "integer", "format": "int32", "maximum": 128, "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, "description": "Maximum request body size in Kb for WAF." }, "fileUploadLimitInMb": { "type": "integer", "format": "int32", "minimum": 0, "exclusiveMinimum": false, "description": "Maximum file upload size in Mb for WAF." }, "exclusions": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallExclusion" }, "description": "The exclusion list." } }, "required": [ "enabled", "firewallMode", "ruleSetType", "ruleSetVersion" ], "description": "Application gateway web application firewall configuration." }, "ApplicationGatewayAutoscaleConfiguration": { "properties": { "minCapacity": { "type": "integer", "format": "int32", "minimum": 0, "exclusiveMinimum": false, "description": "Lower bound on number of Application Gateway capacity." }, "maxCapacity": { "type": "integer", "format": "int32", "minimum": 2, "exclusiveMinimum": false, "description": "Upper bound on number of Application Gateway capacity." } }, "required": [ "minCapacity" ], "description": "Application Gateway autoscale configuration." }, "ApplicationGatewayConnectionDraining": { "properties": { "enabled": { "type": "boolean", "description": "Whether connection draining is enabled or not." }, "drainTimeoutInSec": { "type": "integer", "format": "int32", "maximum": 3600, "exclusiveMaximum": false, "minimum": 1, "exclusiveMinimum": false, "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." } }, "required": [ "enabled", "drainTimeoutInSec" ], "description": "Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration." }, "ApplicationGatewayFirewallDisabledRuleGroup": { "properties": { "ruleGroupName": { "type": "string", "description": "The name of the rule group that will be disabled." }, "rules": { "type": "array", "items": { "type": "integer", "format": "int32", "x-nullable": false }, "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." } }, "required": [ "ruleGroupName" ], "description": "Allows to disable rules within a rule group or an entire rule group." }, "ApplicationGatewayAvailableServerVariablesResult": { "type": "array", "items": { "type": "string" }, "description": "Response for ApplicationGatewayAvailableServerVariables API service call." }, "ApplicationGatewayAvailableRequestHeadersResult": { "type": "array", "items": { "type": "string" }, "description": "Response for ApplicationGatewayAvailableRequestHeaders API service call." }, "ApplicationGatewayAvailableResponseHeadersResult": { "type": "array", "items": { "type": "string" }, "description": "Response for ApplicationGatewayAvailableResponseHeaders API service call." }, "ApplicationGatewayFirewallExclusion": { "properties": { "matchVariable": { "type": "string", "description": "The variable to be excluded." }, "selectorMatchOperator": { "type": "string", "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." }, "selector": { "type": "string", "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." } }, "required": [ "matchVariable", "selectorMatchOperator", "selector" ], "description": "Allow to exclude some variable satisfy the condition for the WAF check." }, "ApplicationGatewayAvailableWafRuleSetsResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet" }, "description": "The list of application gateway rule sets." } }, "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call." }, "ApplicationGatewayFirewallRuleSet": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat", "description": "Properties of the application gateway firewall rule set." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "A web application firewall rule set." }, "ApplicationGatewayFirewallRuleSetPropertiesFormat": { "properties": { "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the web application firewall rule set." }, "ruleSetType": { "type": "string", "description": "The type of the web application firewall rule set." }, "ruleSetVersion": { "type": "string", "description": "The version of the web application firewall rule set type." }, "ruleGroups": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" }, "description": "The rule groups of the web application firewall rule set." } }, "required": [ "ruleSetType", "ruleSetVersion", "ruleGroups" ], "description": "Properties of the web application firewall rule set." }, "ApplicationGatewayFirewallRuleGroup": { "properties": { "ruleGroupName": { "type": "string", "description": "The name of the web application firewall rule group." }, "description": { "type": "string", "description": "The description of the web application firewall rule group." }, "rules": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallRule" }, "description": "The rules of the web application firewall rule group." } }, "required": [ "ruleGroupName", "rules" ], "description": "A web application firewall rule group." }, "ApplicationGatewayFirewallRule": { "properties": { "ruleId": { "type": "integer", "format": "int32", "description": "The identifier of the web application firewall rule." }, "description": { "type": "string", "description": "The description of the web application firewall rule." } }, "required": [ "ruleId" ], "description": "A web application firewall rule." }, "ApplicationGatewayAvailableSslOptions": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat", "description": "Properties of the application gateway available SSL options." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Response for ApplicationGatewayAvailableSslOptions API service call." }, "ApplicationGatewayAvailableSslOptionsPropertiesFormat": { "properties": { "predefinedPolicies": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "List of available Ssl predefined policy." }, "defaultPolicy": { "$ref": "#/definitions/PolicyNameEnum", "description": "Name of the Ssl predefined policy applied by default to application gateway." }, "availableCipherSuites": { "type": "array", "items": { "$ref": "#/definitions/CipherSuitesEnum" }, "description": "List of available Ssl cipher suites." }, "availableProtocols": { "type": "array", "items": { "$ref": "#/definitions/ProtocolsEnum" }, "description": "List of available Ssl protocols." } }, "description": "Properties of ApplicationGatewayAvailableSslOptions." }, "ApplicationGatewayAvailableSslPredefinedPolicies": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" }, "description": "List of available Ssl predefined policy." }, "nextLink": { "type": "string", "description": "URL to get the next set of results." } }, "description": "Response for ApplicationGatewayAvailableSslOptions API service call." }, "ApplicationGatewaySslPredefinedPolicy": { "properties": { "name": { "type": "string", "description": "Name of the Ssl predefined policy." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat", "description": "Properties of the application gateway SSL predefined policy." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "An Ssl predefined policy." }, "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": { "properties": { "cipherSuites": { "type": "array", "items": { "$ref": "#/definitions/CipherSuitesEnum" }, "description": "Ssl cipher suites to be enabled in the specified order for application gateway." }, "minProtocolVersion": { "$ref": "#/definitions/ProtocolsEnum", "description": "Minimum version of Ssl protocol to be supported on application gateway." } }, "description": "Properties of ApplicationGatewaySslPredefinedPolicy." }, "ApplicationGatewayCustomError": { "properties": { "statusCode": { "type": "string", "description": "Status code of the application gateway customer error.", "enum": [ "HttpStatus403", "HttpStatus502" ], "x-ms-enum": { "name": "ApplicationGatewayCustomErrorStatusCode", "modelAsString": true } }, "customErrorPageUrl": { "type": "string", "description": "Error page URL of the application gateway customer error." } }, "description": "Customer error of an application gateway." }, "PolicyNameEnum": { "type": "string", "description": "Ssl predefined policy name enums.", "enum": [ "AppGwSslPolicy20150501", "AppGwSslPolicy20170401", "AppGwSslPolicy20170401S" ], "x-ms-enum": { "name": "ApplicationGatewaySslPolicyName", "modelAsString": true } }, "ProtocolsEnum": { "type": "string", "description": "Ssl protocol enums.", "enum": [ "TLSv1_0", "TLSv1_1", "TLSv1_2" ], "x-ms-enum": { "name": "ApplicationGatewaySslProtocol", "modelAsString": true } }, "CipherSuitesEnum": { "type": "string", "description": "Ssl cipher suites enums.", "enum": [ "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_256_GCM_SHA384", "TLS_RSA_WITH_AES_128_GCM_SHA256", "TLS_RSA_WITH_AES_256_CBC_SHA256", "TLS_RSA_WITH_AES_128_CBC_SHA256", "TLS_RSA_WITH_AES_256_CBC_SHA", "TLS_RSA_WITH_AES_128_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_3DES_EDE_CBC_SHA", "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" ], "x-ms-enum": { "name": "ApplicationGatewaySslCipherSuite", "modelAsString": true } }, "RedirectTypeEnum": { "type": "string", "description": "Redirect type enum.", "enum": [ "Permanent", "Found", "SeeOther", "Temporary" ], "x-ms-enum": { "name": "ApplicationGatewayRedirectType", "modelAsString": true } }, "ApplicationGatewayProtocol": { "type": "string", "description": "Application Gateway protocol.", "enum": [ "Http", "Https" ], "x-ms-enum": { "name": "ApplicationGatewayProtocol", "modelAsString": true } } } }	99.83 KB	2025-05-25 12:27
📄 applicationSecurityGroup.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}": { "delete": { "tags": [ "ApplicationSecurityGroups" ], "operationId": "ApplicationSecurityGroups_Delete", "description": "Deletes the specified application security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the application security group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Delete application security group": { "$ref": "./examples/ApplicationSecurityGroupDelete.json" } } }, "get": { "tags": [ "ApplicationSecurityGroups" ], "operationId": "ApplicationSecurityGroups_Get", "description": "Gets information about the specified application security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the application security group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the specified application security group resource.", "schema": { "$ref": "#/definitions/ApplicationSecurityGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get application security group": { "$ref": "./examples/ApplicationSecurityGroupGet.json" } } }, "put": { "tags": [ "ApplicationSecurityGroups" ], "operationId": "ApplicationSecurityGroups_CreateOrUpdate", "description": "Creates or updates an application security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the application security group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ApplicationSecurityGroup" }, "description": "Parameters supplied to the create or update ApplicationSecurityGroup operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting application security group resource.", "schema": { "$ref": "#/definitions/ApplicationSecurityGroup" } }, "200": { "description": "Update successful. The operation returns the resulting application security group resource.", "schema": { "$ref": "#/definitions/ApplicationSecurityGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Create application security group": { "$ref": "./examples/ApplicationSecurityGroupCreate.json" } } }, "patch": { "tags": [ "applicationSecurityGroups" ], "operationId": "ApplicationSecurityGroups_UpdateTags", "description": "Updates an application security group's tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "applicationSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the application security group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update application security group tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting ApplicationSecurityGroup resource.", "schema": { "$ref": "#/definitions/ApplicationSecurityGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update application security group tags": { "$ref": "./examples/ApplicationSecurityGroupUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups": { "get": { "tags": [ "ApplicationSecurityGroups" ], "operationId": "ApplicationSecurityGroups_ListAll", "description": "Gets all application security groups in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of application security group resources.", "schema": { "$ref": "#/definitions/ApplicationSecurityGroupListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List all application security groups": { "$ref": "./examples/ApplicationSecurityGroupListAll.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups": { "get": { "tags": [ "ApplicationSecurityGroups" ], "operationId": "ApplicationSecurityGroups_List", "description": "Gets all the application security groups in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of application security group resources.", "schema": { "$ref": "#/definitions/ApplicationSecurityGroupListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List load balancers in resource group": { "$ref": "./examples/ApplicationSecurityGroupList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "ApplicationSecurityGroup": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat", "description": "Properties of the application security group." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "An application security group in a resource group." }, "ApplicationSecurityGroupPropertiesFormat": { "properties": { "resourceGuid": { "readOnly": true, "type": "string", "description": "The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the application security group resource." } }, "description": "Application security group properties." }, "ApplicationSecurityGroupListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ApplicationSecurityGroup" }, "description": "A list of application security groups." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "A list of application security groups." } } }	13.23 KB	2025-05-25 12:27
📁 examples	-	2025-05-25 12:27
📄 loadBalancer.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}": { "delete": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancers_Delete", "description": "Deletes the specified load balancer.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete load balancer": { "$ref": "./examples/LoadBalancerDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancers_Get", "description": "Gets the specified load balancer.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting LoadBalancer resource.", "schema": { "$ref": "#/definitions/LoadBalancer" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get load balancer": { "$ref": "./examples/LoadBalancerGet.json" } } }, "put": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancers_CreateOrUpdate", "description": "Creates or updates a load balancer.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LoadBalancer" }, "description": "Parameters supplied to the create or update load balancer operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting LoadBalancer resource.", "schema": { "$ref": "#/definitions/LoadBalancer" } }, "200": { "description": "Update successful. The operation returns the resulting LoadBalancer resource.", "schema": { "$ref": "#/definitions/LoadBalancer" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create load balancer": { "$ref": "./examples/LoadBalancerCreate.json" }, "Create load balancer with Standard SKU": { "$ref": "./examples/LoadBalancerCreateStandardSku.json" }, "Create load balancer with Frontend IP in Zone 1": { "$ref": "./examples/LoadBalancerCreateWithZones.json" }, "Create load balancer with inbound nat pool": { "$ref": "./examples/LoadBalancerCreateWithInboundNatPool.json" }, "Create load balancer with outbound rules": { "$ref": "./examples/LoadBalancerCreateWithOutboundRules.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancers_UpdateTags", "description": "Updates a load balancer tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update load balancer tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting LoadBalancer resource.", "schema": { "$ref": "#/definitions/LoadBalancer" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update load balancer tags": { "$ref": "./examples/LoadBalancerUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancers_ListAll", "description": "Gets all the load balancers in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer resources.", "schema": { "$ref": "#/definitions/LoadBalancerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all load balancers": { "$ref": "./examples/LoadBalancerListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancers_List", "description": "Gets all the load balancers in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer resources.", "schema": { "$ref": "#/definitions/LoadBalancerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List load balancers in resource group": { "$ref": "./examples/LoadBalancerList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerBackendAddressPools_List", "description": "Gets all the load balancer backed address pools.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer BackendAddressPool resources.", "schema": { "$ref": "#/definitions/LoadBalancerBackendAddressPoolListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerBackendAddressPoolList": { "$ref": "./examples/LoadBalancerBackendAddressPoolList.json" }, "Load balancer with BackendAddressPool containing BackendAddresses": { "$ref": "./examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerBackendAddressPools_Get", "description": "Gets load balancer backend address pool.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "backendAddressPoolName", "in": "path", "required": true, "type": "string", "description": "The name of the backend address pool." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns LoadBalancer BackendAddressPool resource.", "schema": { "$ref": "#/definitions/BackendAddressPool" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerBackendAddressPoolGet": { "$ref": "./examples/LoadBalancerBackendAddressPoolGet.json" }, "LoadBalancer with BackendAddressPool with BackendAddresses": { "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesGet.json" } } }, "put": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerBackendAddressPools_CreateOrUpdate", "description": "Creates or updates a load balancer backend address pool.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "backendAddressPoolName", "in": "path", "required": true, "type": "string", "description": "The name of the backend address pool." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BackendAddressPool" }, "description": "Parameters supplied to the create or update load balancer backend address pool operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting BackendAddressPool resource.", "schema": { "$ref": "#/definitions/BackendAddressPool" } }, "200": { "description": "Update successful. The operation returns the resulting BackendAddressPool resource.", "schema": { "$ref": "#/definitions/BackendAddressPool" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update load balancer backend pool with backend addresses containing virtual network and IP address.": { "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesPut.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "delete": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerBackendAddressPools_Delete", "description": "Deletes the specified load balancer backend address pool.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "backendAddressPoolName", "in": "path", "required": true, "type": "string", "description": "The name of the backend address pool." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "BackendAddressPoolDelete": { "$ref": "./examples/LoadBalancerBackendAddressPoolDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerFrontendIPConfigurations_List", "description": "Gets all the load balancer frontend IP configurations.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer FrontendIPConfiguration resources.", "schema": { "$ref": "#/definitions/LoadBalancerFrontendIPConfigurationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerFrontendIPConfigurationList": { "$ref": "./examples/LoadBalancerFrontendIPConfigurationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations/{frontendIPConfigurationName}": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerFrontendIPConfigurations_Get", "description": "Gets load balancer frontend IP configuration.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "frontendIPConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the frontend IP configuration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns LoadBalancer FrontendIPConfiguration resource.", "schema": { "$ref": "#/definitions/FrontendIPConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerFrontendIPConfigurationGet": { "$ref": "./examples/LoadBalancerFrontendIPConfigurationGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules": { "get": { "tags": [ "LoadBalancers" ], "operationId": "InboundNatRules_List", "description": "Gets all the inbound nat rules in a load balancer.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer InboundNatRule resources.", "schema": { "$ref": "#/definitions/InboundNatRuleListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "InboundNatRuleList": { "$ref": "./examples/InboundNatRuleList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}": { "delete": { "tags": [ "LoadBalancers" ], "operationId": "InboundNatRules_Delete", "description": "Deletes the specified load balancer inbound nat rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "inboundNatRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the inbound nat rule." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "InboundNatRuleDelete": { "$ref": "./examples/InboundNatRuleDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "LoadBalancers" ], "operationId": "InboundNatRules_Get", "description": "Gets the specified load balancer inbound nat rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "inboundNatRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the inbound nat rule." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting InboundNatRule resource.", "schema": { "$ref": "#/definitions/InboundNatRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "InboundNatRuleGet": { "$ref": "./examples/InboundNatRuleGet.json" } } }, "put": { "tags": [ "LoadBalancers" ], "operationId": "InboundNatRules_CreateOrUpdate", "description": "Creates or updates a load balancer inbound nat rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "inboundNatRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the inbound nat rule." }, { "name": "inboundNatRuleParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InboundNatRule" }, "description": "Parameters supplied to the create or update inbound nat rule operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting InboundNatRule resource.", "schema": { "$ref": "#/definitions/InboundNatRule" } }, "200": { "description": "Update successful. The operation returns the resulting InboundNatRule resource.", "schema": { "$ref": "#/definitions/InboundNatRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "InboundNatRuleCreate": { "$ref": "./examples/InboundNatRuleCreate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerLoadBalancingRules_List", "description": "Gets all the load balancing rules in a load balancer.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer LoadBalancingRule resources.", "schema": { "$ref": "#/definitions/LoadBalancerLoadBalancingRuleListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "LoadBalancerLoadBalancingRuleList": { "$ref": "./examples/LoadBalancerLoadBalancingRuleList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules/{loadBalancingRuleName}": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerLoadBalancingRules_Get", "description": "Gets the specified load balancer load balancing rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "loadBalancingRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancing rule." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting LoadBalancingRule resource.", "schema": { "$ref": "#/definitions/LoadBalancingRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerLoadBalancingRuleGet": { "$ref": "./examples/LoadBalancerLoadBalancingRuleGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerOutboundRules_List", "description": "Gets all the outbound rules in a load balancer.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer OutboundRule resources.", "schema": { "$ref": "#/definitions/LoadBalancerOutboundRuleListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "LoadBalancerOutboundRuleList": { "$ref": "./examples/LoadBalancerOutboundRuleList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules/{outboundRuleName}": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerOutboundRules_Get", "description": "Gets the specified load balancer outbound rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "outboundRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the outbound rule." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting OutboundRule resource.", "schema": { "$ref": "#/definitions/OutboundRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerOutboundRuleGet": { "$ref": "./examples/LoadBalancerOutboundRuleGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/networkInterfaces": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerNetworkInterfaces_List", "description": "Gets associated load balancer network interfaces.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkInterface resources.", "schema": { "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerNetworkInterfaceListVmss": { "$ref": "./examples/LoadBalancerNetworkInterfaceListVmss.json" }, "LoadBalancerNetworkInterfaceListSimple": { "$ref": "./examples/LoadBalancerNetworkInterfaceListSimple.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerProbes_List", "description": "Gets all the load balancer probes.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LoadBalancer Probe resources.", "schema": { "$ref": "#/definitions/LoadBalancerProbeListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerProbeList": { "$ref": "./examples/LoadBalancerProbeList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}": { "get": { "tags": [ "LoadBalancers" ], "operationId": "LoadBalancerProbes_Get", "description": "Gets load balancer probe.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "loadBalancerName", "in": "path", "required": true, "type": "string", "description": "The name of the load balancer." }, { "name": "probeName", "in": "path", "required": true, "type": "string", "description": "The name of the probe." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns LoadBalancer Probe resource.", "schema": { "$ref": "#/definitions/Probe" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "LoadBalancerProbeGet": { "$ref": "./examples/LoadBalancerProbeGet.json" } } } } }, "definitions": { "LoadBalancerSku": { "properties": { "name": { "type": "string", "description": "Name of a load balancer SKU.", "enum": [ "Basic", "Standard" ], "x-ms-enum": { "name": "LoadBalancerSkuName", "modelAsString": true } } }, "description": "SKU of a load balancer." }, "FrontendIPConfigurationPropertiesFormat": { "properties": { "inboundNatRules": { "readOnly": true, "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "An array of references to inbound rules that use this frontend IP." }, "inboundNatPools": { "readOnly": true, "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "An array of references to inbound pools that use this frontend IP." }, "outboundRules": { "readOnly": true, "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "An array of references to outbound rules that use this frontend IP." }, "loadBalancingRules": { "readOnly": true, "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "An array of references to load balancing rules that use this frontend IP." }, "privateIPAddress": { "type": "string", "description": "The private IP address of the IP configuration." }, "privateIPAllocationMethod": { "$ref": "./network.json#/definitions/IPAllocationMethod", "description": "The Private IP allocation method." }, "privateIPAddressVersion": { "$ref": "./network.json#/definitions/IPVersion", "description": "Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4." }, "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", "description": "The reference to the subnet resource." }, "publicIPAddress": { "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", "description": "The reference to the Public IP resource." }, "publicIPPrefix": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference to the Public IP Prefix resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the frontend IP configuration resource." } }, "description": "Properties of Frontend IP Configuration of the load balancer." }, "FrontendIPConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat", "description": "Properties of the load balancer probe." }, "name": { "type": "string", "description": "The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." }, "zones": { "type": "array", "items": { "type": "string" }, "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Frontend IP address of the load balancer." }, "LoadBalancerBackendAddressPropertiesFormat": { "properties": { "virtualNetwork": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to an existing virtual network." }, "ipAddress": { "type": "string", "description": "IP Address belonging to the referenced virtual network.", "x-ms-azure-resource": false }, "networkInterfaceIPConfiguration": { "readOnly": true, "$ref": "./network.json#/definitions/SubResource", "description": "Reference to IP address defined in network interfaces." } }, "description": "Properties of the load balancer backend addresses." }, "LoadBalancerBackendAddress": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/LoadBalancerBackendAddressPropertiesFormat", "description": "Properties of load balancer backend address pool." }, "name": { "type": "string", "description": "Name of the backend address." } }, "description": "Load balancer backend addresses." }, "BackendAddressPoolPropertiesFormat": { "properties": { "loadBalancerBackendAddresses": { "type": "array", "items": { "$ref": "#/definitions/LoadBalancerBackendAddress" }, "description": "An array of backend addresses." }, "backendIPConfigurations": { "readOnly": true, "type": "array", "items": { "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" }, "description": "An array of references to IP addresses defined in network interfaces." }, "loadBalancingRules": { "readOnly": true, "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "An array of references to load balancing rules that use this backend address pool." }, "outboundRule": { "readOnly": true, "$ref": "./network.json#/definitions/SubResource", "description": "A reference to an outbound rule that uses this backend address pool." }, "outboundRules": { "readOnly": true, "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "An array of references to outbound rules that use this backend address pool." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the backend address pool resource." } }, "description": "Properties of the backend address pool." }, "BackendAddressPool": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/BackendAddressPoolPropertiesFormat", "description": "Properties of load balancer backend address pool." }, "name": { "type": "string", "description": "The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Pool of backend IP addresses." }, "LoadBalancingRulePropertiesFormat": { "properties": { "frontendIPConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "A reference to frontend IP addresses." }, "backendAddressPool": { "$ref": "./network.json#/definitions/SubResource", "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." }, "probe": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference to the load balancer probe used by the load balancing rule." }, "protocol": { "$ref": "#/definitions/TransportProtocol", "description": "The reference to the transport protocol used by the load balancing rule." }, "loadDistribution": { "type": "string", "description": "The load distribution policy for this rule.", "enum": [ "Default", "SourceIP", "SourceIPProtocol" ], "x-ms-enum": { "name": "LoadDistribution", "modelAsString": true } }, "frontendPort": { "type": "integer", "format": "int32", "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables \"Any Port\"." }, "backendPort": { "type": "integer", "format": "int32", "description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\"." }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." }, "enableFloatingIP": { "type": "boolean", "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." }, "enableTcpReset": { "type": "boolean", "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." }, "disableOutboundSnat": { "type": "boolean", "description": "Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the load balancing rule resource." } }, "required": [ "protocol", "frontendPort" ], "description": "Properties of the load balancer." }, "LoadBalancingRule": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/LoadBalancingRulePropertiesFormat", "description": "Properties of load balancer load balancing rule." }, "name": { "type": "string", "description": "The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "A load balancing rule for a load balancer." }, "ProbePropertiesFormat": { "properties": { "loadBalancingRules": { "readOnly": true, "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "The load balancer rules that use this probe." }, "protocol": { "type": "string", "description": "The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.", "enum": [ "Http", "Tcp", "Https" ], "x-ms-enum": { "name": "ProbeProtocol", "modelAsString": true } }, "port": { "type": "integer", "format": "int32", "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." }, "intervalInSeconds": { "type": "integer", "format": "int32", "description": "The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5." }, "numberOfProbes": { "type": "integer", "format": "int32", "description": "The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure." }, "requestPath": { "type": "string", "description": "The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the probe resource." } }, "required": [ "protocol", "port" ], "description": "Load balancer probe resource." }, "Probe": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ProbePropertiesFormat", "description": "Properties of load balancer probe." }, "name": { "type": "string", "description": "The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "A load balancer probe." }, "InboundNatRulePropertiesFormat": { "properties": { "frontendIPConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "A reference to frontend IP addresses." }, "backendIPConfiguration": { "readOnly": true, "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", "description": "A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP." }, "protocol": { "$ref": "#/definitions/TransportProtocol", "description": "The reference to the transport protocol used by the load balancing rule." }, "frontendPort": { "type": "integer", "format": "int32", "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534." }, "backendPort": { "type": "integer", "format": "int32", "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." }, "enableFloatingIP": { "type": "boolean", "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." }, "enableTcpReset": { "type": "boolean", "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the inbound NAT rule resource." } }, "description": "Properties of the inbound NAT rule." }, "InboundNatRule": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/InboundNatRulePropertiesFormat", "description": "Properties of load balancer inbound nat rule." }, "name": { "type": "string", "description": "The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Inbound NAT rule of the load balancer." }, "InboundNatPoolPropertiesFormat": { "properties": { "frontendIPConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "A reference to frontend IP addresses." }, "protocol": { "$ref": "#/definitions/TransportProtocol", "description": "The reference to the transport protocol used by the inbound NAT pool." }, "frontendPortRangeStart": { "type": "integer", "format": "int32", "description": "The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534." }, "frontendPortRangeEnd": { "type": "integer", "format": "int32", "description": "The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535." }, "backendPort": { "type": "integer", "format": "int32", "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." }, "enableFloatingIP": { "type": "boolean", "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." }, "enableTcpReset": { "type": "boolean", "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the inbound NAT pool resource." } }, "required": [ "protocol", "frontendPortRangeStart", "frontendPortRangeEnd", "backendPort" ], "description": "Properties of Inbound NAT pool." }, "InboundNatPool": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/InboundNatPoolPropertiesFormat", "description": "Properties of load balancer inbound nat pool." }, "name": { "type": "string", "description": "The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Inbound NAT pool of the load balancer." }, "OutboundRulePropertiesFormat": { "properties": { "allocatedOutboundPorts": { "type": "integer", "format": "int32", "description": "The number of outbound ports to be used for NAT." }, "frontendIPConfigurations": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "The Frontend IP addresses of the load balancer." }, "backendAddressPool": { "$ref": "./network.json#/definitions/SubResource", "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the outbound rule resource." }, "protocol": { "type": "string", "description": "The protocol for the outbound rule in load balancer.", "enum": [ "Tcp", "Udp", "All" ], "x-ms-enum": { "name": "LoadBalancerOutboundRuleProtocol", "modelAsString": true } }, "enableTcpReset": { "type": "boolean", "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." }, "idleTimeoutInMinutes": { "type": "integer", "description": "The timeout for the TCP idle connection." } }, "required": [ "backendAddressPool", "frontendIPConfigurations", "protocol" ], "description": "Outbound rule of the load balancer." }, "OutboundRule": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/OutboundRulePropertiesFormat", "description": "Properties of load balancer outbound rule." }, "name": { "type": "string", "description": "The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Type of the resource." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Outbound rule of the load balancer." }, "LoadBalancerPropertiesFormat": { "properties": { "frontendIPConfigurations": { "type": "array", "items": { "$ref": "#/definitions/FrontendIPConfiguration" }, "description": "Object representing the frontend IPs to be used for the load balancer." }, "backendAddressPools": { "type": "array", "items": { "$ref": "#/definitions/BackendAddressPool" }, "description": "Collection of backend address pools used by a load balancer." }, "loadBalancingRules": { "type": "array", "items": { "$ref": "#/definitions/LoadBalancingRule" }, "description": "Object collection representing the load balancing rules Gets the provisioning." }, "probes": { "type": "array", "items": { "$ref": "#/definitions/Probe" }, "description": "Collection of probe objects used in the load balancer." }, "inboundNatRules": { "type": "array", "items": { "$ref": "#/definitions/InboundNatRule" }, "description": "Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules." }, "inboundNatPools": { "type": "array", "items": { "$ref": "#/definitions/InboundNatPool" }, "description": "Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules." }, "outboundRules": { "type": "array", "items": { "$ref": "#/definitions/OutboundRule" }, "description": "The outbound rules." }, "resourceGuid": { "readOnly": true, "type": "string", "description": "The resource GUID property of the load balancer resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the load balancer resource." } }, "description": "Properties of the load balancer." }, "LoadBalancer": { "properties": { "sku": { "$ref": "#/definitions/LoadBalancerSku", "description": "The load balancer SKU." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/LoadBalancerPropertiesFormat", "description": "Properties of load balancer." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "LoadBalancer resource." }, "LoadBalancerListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/LoadBalancer" }, "description": "A list of load balancers in a resource group." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListLoadBalancers API service call." }, "InboundNatRuleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/InboundNatRule" }, "description": "A list of inbound nat rules in a load balancer." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListInboundNatRule API service call." }, "LoadBalancerBackendAddressPoolListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/BackendAddressPool" }, "description": "A list of backend address pools in a load balancer." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListBackendAddressPool API service call." }, "LoadBalancerFrontendIPConfigurationListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/FrontendIPConfiguration" }, "description": "A list of frontend IP configurations in a load balancer." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListFrontendIPConfiguration API service call." }, "LoadBalancerLoadBalancingRuleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/LoadBalancingRule" }, "description": "A list of load balancing rules in a load balancer." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListLoadBalancingRule API service call." }, "LoadBalancerOutboundRuleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/OutboundRule" }, "description": "A list of outbound rules in a load balancer." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListOutboundRule API service call." }, "LoadBalancerProbeListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Probe" }, "description": "A list of probes in a load balancer." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListProbe API service call." }, "TransportProtocol": { "type": "string", "description": "The transport protocol for the endpoint.", "enum": [ "Udp", "Tcp", "All" ], "x-ms-enum": { "name": "TransportProtocol", "modelAsString": true } } } }	76.92 KB	2025-05-25 12:27
📄 network.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": {}, "definitions": { "ErrorDetails": { "properties": { "code": { "type": "string", "description": "Error code." }, "target": { "type": "string", "description": "Error target." }, "message": { "type": "string", "description": "Error message." } }, "description": "Common error details representation." }, "Error": { "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "target": { "type": "string", "description": "Error target." }, "details": { "type": "array", "items": { "$ref": "#/definitions/ErrorDetails" }, "description": "Error details." }, "innerError": { "type": "string", "description": "Inner error message." } }, "description": "Common error representation." }, "CloudError": { "x-ms-external": true, "properties": { "error": { "$ref": "#/definitions/CloudErrorBody", "description": "Cloud error body." } }, "description": "An error response from the service." }, "CloudErrorBody": { "x-ms-external": true, "properties": { "code": { "type": "string", "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "A message describing the error, intended to be suitable for display in a user interface." }, "target": { "type": "string", "description": "The target of the particular error. For example, the name of the property in error." }, "details": { "type": "array", "items": { "$ref": "#/definitions/CloudErrorBody" }, "description": "A list of additional details about the error." } }, "description": "An error response from the service." }, "AzureAsyncOperationResult": { "properties": { "status": { "type": "string", "description": "Status of the Azure async operation.", "enum": [ "InProgress", "Succeeded", "Failed" ], "x-ms-enum": { "name": "NetworkOperationStatus", "modelAsString": true } }, "error": { "$ref": "#/definitions/Error", "description": "Details of the error occurred during specified asynchronous operation." } }, "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." }, "Resource": { "properties": { "id": { "type": "string", "description": "Resource ID." }, "name": { "readOnly": true, "type": "string", "description": "Resource name." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." }, "location": { "type": "string", "description": "Resource location." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags." } }, "description": "Common resource representation.", "x-ms-azure-resource": true }, "SubResource": { "properties": { "id": { "type": "string", "description": "Resource ID." } }, "description": "Reference to another subresource.", "x-ms-azure-resource": true }, "TagsObject": { "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags." } }, "description": "Tags object for patch operations." }, "ManagedServiceIdentity": { "properties": { "principalId": { "readOnly": true, "type": "string", "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity." }, "tenantId": { "readOnly": true, "type": "string", "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", "None" ], "x-ms-enum": { "name": "ResourceIdentityType", "modelAsString": false } }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "properties": { "principalId": { "readOnly": true, "type": "string", "description": "The principal id of user assigned identity." }, "clientId": { "readOnly": true, "type": "string", "description": "The client id of user assigned identity." } } }, "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "description": "Identity for the resource." }, "ProvisioningState": { "type": "string", "readOnly": true, "description": "The current provisioning state.", "enum": [ "Succeeded", "Updating", "Deleting", "Failed" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true } }, "Access": { "type": "string", "description": "Access to be allowed or denied.", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "Access", "modelAsString": true } }, "AuthenticationMethod": { "type": "string", "description": "VPN client authentication method.", "enum": [ "EAPTLS", "EAPMSCHAPv2" ], "x-ms-enum": { "name": "AuthenticationMethod", "modelAsString": true } }, "IPAllocationMethod": { "type": "string", "description": "IP address allocation method.", "enum": [ "Static", "Dynamic" ], "x-ms-enum": { "name": "IPAllocationMethod", "modelAsString": true } }, "IPVersion": { "type": "string", "description": "IP address version.", "enum": [ "IPv4", "IPv6" ], "x-ms-enum": { "name": "IPVersion", "modelAsString": true } } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client API version." }, "ApiVersionVmssParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "enum": [ "2017-03-30" ], "x-ms-enum": { "name": "ApiVersion", "modelAsString": true }, "description": "Client API version." } } }	9.81 KB	2025-05-25 12:27
📄 networkInterface.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}": { "delete": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_Delete", "description": "Deletes the specified network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete network interface": { "$ref": "./examples/NetworkInterfaceDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_Get", "description": "Gets information about the specified network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting NetworkInterface resource.", "schema": { "$ref": "#/definitions/NetworkInterface" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get network interface": { "$ref": "./examples/NetworkInterfaceGet.json" } } }, "put": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_CreateOrUpdate", "description": "Creates or updates a network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkInterface" }, "description": "Parameters supplied to the create or update network interface operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting NetworkInterface resource.", "schema": { "$ref": "#/definitions/NetworkInterface" } }, "200": { "description": "Update successful. The operation returns the resulting NetworkInterface resource.", "schema": { "$ref": "#/definitions/NetworkInterface" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create network interface": { "$ref": "./examples/NetworkInterfaceCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_UpdateTags", "description": "Updates a network interface tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update network interface tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting NetworkInterface resource.", "schema": { "$ref": "#/definitions/NetworkInterface" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update network interface tags": { "$ref": "./examples/NetworkInterfaceUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces": { "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_ListAll", "description": "Gets all network interfaces in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkInterface resources.", "schema": { "$ref": "#/definitions/NetworkInterfaceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all network interfaces": { "$ref": "./examples/NetworkInterfaceListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces": { "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_List", "description": "Gets all network interfaces in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkInterface resources.", "schema": { "$ref": "#/definitions/NetworkInterfaceListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List network interfaces in resource group": { "$ref": "./examples/NetworkInterfaceList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveRouteTable": { "post": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_GetEffectiveRouteTable", "description": "Gets all route tables applied to a network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of EffectRoute resources.", "schema": { "$ref": "#/definitions/EffectiveRouteListResult" } }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Show network interface effective route tables": { "$ref": "./examples/NetworkInterfaceEffectiveRouteTableList.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups": { "post": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_ListEffectiveNetworkSecurityGroups", "description": "Gets all network security groups applied to a network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", "schema": { "$ref": "#/definitions/EffectiveNetworkSecurityGroupListResult" } }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List network interface effective network security groups": { "$ref": "./examples/NetworkInterfaceEffectiveNSGList.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations": { "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaceIPConfigurations_List", "description": "Get all ip configurations in a network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkInterface IPConfiguration resources.", "schema": { "$ref": "#/definitions/NetworkInterfaceIPConfigurationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "NetworkInterfaceIPConfigurationList": { "$ref": "./examples/NetworkInterfaceIPConfigurationList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaceIPConfigurations_Get", "description": "Gets the specified network interface ip configuration.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "name": "ipConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the ip configuration name." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting NetworkInterface IPConfiguration resource.", "schema": { "$ref": "#/definitions/NetworkInterfaceIPConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "NetworkInterfaceIPConfigurationGet": { "$ref": "./examples/NetworkInterfaceIPConfigurationGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/loadBalancers": { "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaceLoadBalancers_List", "description": "List all load balancers in a network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkInterface LoadBalancer resources.", "schema": { "$ref": "#/definitions/NetworkInterfaceLoadBalancerListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "NetworkInterfaceLoadBalancerList": { "$ref": "./examples/NetworkInterfaceLoadBalancerList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}": { "delete": { "tags": [ "Network Interfaces" ], "operationId": "NetworkInterfaceTapConfigurations_Delete", "description": "Deletes the specified tap configuration from the NetworkInterface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "name": "tapConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the tap configuration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Delete successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete tap configuration": { "$ref": "./examples/NetworkInterfaceTapConfigurationDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaceTapConfigurations_Get", "description": "Get the specified tap configuration on a network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "name": "tapConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the tap configuration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a tap configuration.", "schema": { "$ref": "#/definitions/NetworkInterfaceTapConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationGet.json" } } }, "put": { "tags": [ "Network Interfaces" ], "operationId": "NetworkInterfaceTapConfigurations_CreateOrUpdate", "description": "Creates or updates a Tap configuration in the specified NetworkInterface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "name": "tapConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the tap configuration." }, { "name": "tapConfigurationParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkInterfaceTapConfiguration" }, "description": "Parameters supplied to the create or update tap configuration operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting Tap Configuration resource.", "schema": { "$ref": "#/definitions/NetworkInterfaceTapConfiguration" } }, "201": { "description": "Create successful. The operation returns the resulting Tap configuration resource.", "schema": { "$ref": "#/definitions/NetworkInterfaceTapConfiguration" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations": { "get": { "tags": [ "NetworkInterfaces" ], "operationId": "NetworkInterfaceTapConfigurations_List", "description": "Get all Tap configurations in a network interface.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkInterfaceName", "in": "path", "required": true, "type": "string", "description": "The name of the network interface." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkInterface TapConfiguration resources.", "schema": { "$ref": "#/definitions/NetworkInterfaceTapConfigurationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List virtual network tap configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "NetworkInterfaceTapConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NetworkInterfaceTapConfigurationPropertiesFormat", "description": "Properties of the Virtual Network Tap configuration." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Sub Resource type." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Tap configuration in a Network Interface." }, "NetworkInterfaceTapConfigurationPropertiesFormat": { "properties": { "virtualNetworkTap": { "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap", "description": "The reference to the Virtual Network Tap resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the network interface tap configuration resource." } }, "description": "Properties of Virtual Network Tap configuration." }, "NetworkInterfaceIPConfigurationPropertiesFormat": { "properties": { "virtualNetworkTaps": { "type": "array", "items": { "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap" }, "description": "The reference to Virtual Network Taps." }, "applicationGatewayBackendAddressPools": { "type": "array", "items": { "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayBackendAddressPool" }, "description": "The reference to ApplicationGatewayBackendAddressPool resource." }, "loadBalancerBackendAddressPools": { "type": "array", "items": { "$ref": "./loadBalancer.json#/definitions/BackendAddressPool" }, "description": "The reference to LoadBalancerBackendAddressPool resource." }, "loadBalancerInboundNatRules": { "type": "array", "items": { "$ref": "./loadBalancer.json#/definitions/InboundNatRule" }, "description": "A list of references of LoadBalancerInboundNatRules." }, "privateIPAddress": { "type": "string", "description": "Private IP address of the IP configuration." }, "privateIPAllocationMethod": { "$ref": "./network.json#/definitions/IPAllocationMethod", "description": "The private IP address allocation method." }, "privateIPAddressVersion": { "$ref": "./network.json#/definitions/IPVersion", "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." }, "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", "description": "Subnet bound to the IP configuration." }, "primary": { "type": "boolean", "description": "Whether this is a primary customer address on the network interface." }, "publicIPAddress": { "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", "description": "Public IP address bound to the IP configuration." }, "applicationSecurityGroups": { "type": "array", "items": { "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" }, "description": "Application security groups in which the IP configuration is included." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the network interface IP configuration." }, "privateLinkConnectionProperties": { "$ref": "#/definitions/NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties", "description": "PrivateLinkConnection properties for the network interface.", "readOnly": true } }, "description": "Properties of IP configuration." }, "NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties": { "properties": { "groupId": { "type": "string", "readOnly": true, "description": "The group ID for current private link connection." }, "requiredMemberName": { "type": "string", "readOnly": true, "description": "The required member name for current private link connection." }, "fqdns": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "List of FQDNs for current private link connection." } }, "description": "PrivateLinkConnection properties for the network interface." }, "NetworkInterfaceIPConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat", "description": "Network interface IP configuration properties." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "IPConfiguration in a network interface." }, "NetworkInterfaceDnsSettings": { "properties": { "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection." }, "appliedDnsServers": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs." }, "internalDnsNameLabel": { "type": "string", "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." }, "internalFqdn": { "readOnly": true, "type": "string", "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." }, "internalDomainNameSuffix": { "readOnly": true, "type": "string", "description": "Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix." } }, "description": "DNS settings of a network interface." }, "NetworkInterfacePropertiesFormat": { "properties": { "virtualMachine": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference to a virtual machine.", "readOnly": true }, "networkSecurityGroup": { "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", "description": "The reference to the NetworkSecurityGroup resource." }, "privateEndpoint": { "readOnly": true, "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", "description": "A reference to the private endpoint to which the network interface is linked." }, "ipConfigurations": { "type": "array", "items": { "$ref": "#/definitions/NetworkInterfaceIPConfiguration" }, "description": "A list of IPConfigurations of the network interface." }, "tapConfigurations": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/NetworkInterfaceTapConfiguration" }, "description": "A list of TapConfigurations of the network interface." }, "dnsSettings": { "$ref": "#/definitions/NetworkInterfaceDnsSettings", "description": "The DNS settings in network interface." }, "macAddress": { "readOnly": true, "type": "string", "description": "The MAC address of the network interface." }, "primary": { "readOnly": true, "type": "boolean", "description": "Whether this is a primary network interface on a virtual machine." }, "enableAcceleratedNetworking": { "type": "boolean", "description": "If the network interface is accelerated networking enabled." }, "enableIPForwarding": { "type": "boolean", "description": "Indicates whether IP forwarding is enabled on this network interface." }, "hostedWorkloads": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "A list of references to linked BareMetal resources." }, "resourceGuid": { "readOnly": true, "type": "string", "description": "The resource GUID property of the network interface resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the network interface resource." } }, "description": "NetworkInterface properties." }, "NetworkInterface": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NetworkInterfacePropertiesFormat", "description": "Properties of the network interface." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "A network interface in a resource group." }, "NetworkInterfaceListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NetworkInterface" }, "description": "A list of network interfaces in a resource group." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for the ListNetworkInterface API service call." }, "NetworkInterfaceTapConfigurationListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NetworkInterfaceTapConfiguration" }, "description": "A list of tap configurations." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for list tap configurations API service call." }, "NetworkInterfaceIPConfigurationListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NetworkInterfaceIPConfiguration" }, "description": "A list of ip configurations." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for list ip configurations API service call." }, "NetworkInterfaceLoadBalancerListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "./loadBalancer.json#/definitions/LoadBalancer" }, "description": "A list of load balancers." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for list ip configurations API service call." }, "EffectiveNetworkSecurityGroup": { "properties": { "networkSecurityGroup": { "$ref": "./network.json#/definitions/SubResource", "description": "The ID of network security group that is applied." }, "association": { "$ref": "#/definitions/EffectiveNetworkSecurityGroupAssociation", "description": "Associated resources." }, "effectiveSecurityRules": { "type": "array", "items": { "$ref": "#/definitions/EffectiveNetworkSecurityRule" }, "description": "A collection of effective security rules." }, "tagMap": { "type": "string", "additionalProperties": { "type": "array", "items": { "type": "string" }, "description": "List of IP Addresses within the tag (key)." }, "description": "Mapping of tags to list of IP Addresses included within the tag." } }, "description": "Effective network security group." }, "EffectiveNetworkSecurityGroupAssociation": { "properties": { "subnet": { "$ref": "./network.json#/definitions/SubResource", "description": "The ID of the subnet if assigned." }, "networkInterface": { "$ref": "./network.json#/definitions/SubResource", "description": "The ID of the network interface if assigned." } }, "description": "The effective network security group association." }, "EffectiveNetworkSecurityRule": { "properties": { "name": { "type": "string", "description": "The name of the security rule specified by the user (if created by the user)." }, "protocol": { "type": "string", "description": "The network protocol this rule applies to.", "enum": [ "Tcp", "Udp", "All" ], "x-ms-enum": { "name": "EffectiveSecurityRuleProtocol", "modelAsString": true } }, "sourcePortRange": { "type": "string", "description": "The source port or range." }, "destinationPortRange": { "type": "string", "description": "The destination port or range." }, "sourcePortRanges": { "type": "array", "items": { "type": "string" }, "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk ()." }, "destinationPortRanges": { "type": "array", "items": { "type": "string" }, "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk ()." }, "sourceAddressPrefix": { "type": "string", "description": "The source address prefix." }, "destinationAddressPrefix": { "type": "string", "description": "The destination address prefix." }, "sourceAddressPrefixes": { "type": "array", "items": { "type": "string" }, "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk ()." }, "destinationAddressPrefixes": { "type": "array", "items": { "type": "string" }, "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk ()." }, "expandedSourceAddressPrefix": { "type": "array", "items": { "type": "string" }, "description": "The expanded source address prefix." }, "expandedDestinationAddressPrefix": { "type": "array", "items": { "type": "string" }, "description": "Expanded destination address prefix." }, "access": { "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", "description": "Whether network traffic is allowed or denied." }, "priority": { "type": "integer", "format": "int32", "description": "The priority of the rule." }, "direction": { "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleDirection", "description": "The direction of the rule." } }, "description": "Effective network security rules." }, "EffectiveNetworkSecurityGroupListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/EffectiveNetworkSecurityGroup" }, "description": "A list of effective network security groups." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for list effective network security groups API service call." }, "EffectiveRoute": { "properties": { "name": { "type": "string", "description": "The name of the user defined route. This is optional." }, "disableBgpRoutePropagation": { "type": "boolean", "description": "If true, on-premises routes are not propagated to the network interfaces in the subnet." }, "source": { "type": "string", "description": "Who created the route.", "enum": [ "Unknown", "User", "VirtualNetworkGateway", "Default" ], "x-ms-enum": { "name": "EffectiveRouteSource", "modelAsString": true } }, "state": { "type": "string", "description": "The value of effective route.", "enum": [ "Active", "Invalid" ], "x-ms-enum": { "name": "EffectiveRouteState", "modelAsString": true } }, "addressPrefix": { "type": "array", "items": { "type": "string" }, "description": "The address prefixes of the effective routes in CIDR notation." }, "nextHopIpAddress": { "type": "array", "items": { "type": "string" }, "description": "The IP address of the next hop of the effective route." }, "nextHopType": { "$ref": "./routeTable.json#/definitions/RouteNextHopType", "description": "The type of Azure hop the packet should be sent to." } }, "description": "Effective Route." }, "EffectiveRouteListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/EffectiveRoute" }, "description": "A list of effective routes." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for list effective route API service call." }, "IPConfigurationPropertiesFormat": { "properties": { "privateIPAddress": { "type": "string", "description": "The private IP address of the IP configuration." }, "privateIPAllocationMethod": { "$ref": "./network.json#/definitions/IPAllocationMethod", "description": "The private IP address allocation method." }, "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", "description": "The reference to the subnet resource." }, "publicIPAddress": { "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", "description": "The reference to the public IP resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the IP configuration resource." } }, "description": "Properties of IP configuration." }, "IPConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IPConfigurationPropertiesFormat", "description": "Properties of the IP configuration." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "IP configuration." } } }	51.28 KB	2025-05-25 12:27
📄 networkProfile.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}": { "delete": { "tags": [ "NetworkProfiles" ], "operationId": "NetworkProfiles_Delete", "description": "Deletes the specified network profile.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkProfileName", "in": "path", "required": true, "type": "string", "description": "The name of the NetworkProfile." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete network profile": { "$ref": "./examples/NetworkProfileDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "NetworkProfiles" ], "operationId": "NetworkProfiles_Get", "description": "Gets the specified network profile in a specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkProfileName", "in": "path", "required": true, "type": "string", "description": "The name of the public IP prefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting NetworkProfile resource.", "schema": { "$ref": "#/definitions/NetworkProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get network profile": { "$ref": "./examples/NetworkProfileGetConfigOnly.json" }, "Get network profile with container network interfaces": { "$ref": "./examples/NetworkProfileGetWithContainerNic.json" } } }, "put": { "tags": [ "NetworkProfiles" ], "operationId": "NetworkProfiles_CreateOrUpdate", "description": "Creates or updates a network profile.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkProfileName", "in": "path", "required": true, "type": "string", "description": "The name of the network profile." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkProfile" }, "description": "Parameters supplied to the create or update network profile operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting NetworkProfile resource.", "schema": { "$ref": "#/definitions/NetworkProfile" } }, "200": { "description": "Update successful. The operation returns the resulting NetworkProfile resource.", "schema": { "$ref": "#/definitions/NetworkProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create network profile defaults": { "$ref": "./examples/NetworkProfileCreateConfigOnly.json" } }, "x-ms-long-running-operation": false }, "patch": { "tags": [ "NetworkProfiles" ], "operationId": "NetworkProfiles_UpdateTags", "description": "Updates network profile tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkProfileName", "in": "path", "required": true, "type": "string", "description": "The name of the network profile." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update network profile tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting NetworkProfile resource.", "schema": { "$ref": "#/definitions/NetworkProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update network profile tags": { "$ref": "./examples/NetworkProfileUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkProfiles": { "get": { "tags": [ "NetworkProfiles" ], "operationId": "NetworkProfiles_ListAll", "description": "Gets all the network profiles in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkProfile resources.", "schema": { "$ref": "#/definitions/NetworkProfileListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all network profiles": { "$ref": "./examples/NetworkProfileListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles": { "get": { "tags": [ "NetworkProfiles" ], "operationId": "NetworkProfiles_List", "description": "Gets all network profiles in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkProfile resources.", "schema": { "$ref": "#/definitions/NetworkProfileListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List resource group network profiles": { "$ref": "./examples/NetworkProfileList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "NetworkProfilePropertiesFormat": { "properties": { "containerNetworkInterfaces": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/ContainerNetworkInterface" }, "description": "List of child container network interfaces." }, "containerNetworkInterfaceConfigurations": { "type": "array", "items": { "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration" }, "description": "List of chid container network interface configurations." }, "resourceGuid": { "readOnly": true, "type": "string", "description": "The resource GUID property of the network profile resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the network profile resource." } }, "description": "Network profile properties." }, "NetworkProfile": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NetworkProfilePropertiesFormat", "description": "Network profile properties." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Network profile resource." }, "NetworkProfileListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NetworkProfile" }, "description": "A list of network profiles that exist in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListNetworkProfiles API service call." }, "ContainerNetworkInterfacePropertiesFormat": { "properties": { "containerNetworkInterfaceConfiguration": { "readOnly": true, "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration", "description": "Container network interface configuration from which this container network interface is created." }, "container": { "$ref": "#/definitions/Container", "description": "Reference to the container to which this container network interface is attached." }, "ipConfigurations": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/ContainerNetworkInterfaceIpConfiguration" }, "description": "Reference to the ip configuration on this container nic." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the container network interface resource." } }, "description": "Properties of container network interface." }, "ContainerNetworkInterface": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ContainerNetworkInterfacePropertiesFormat", "description": "Container network interface properties." }, "name": { "type": "string", "description": "The name of the resource. This name can be used to access the resource." }, "type": { "readOnly": true, "type": "string", "description": "Sub Resource type." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Container network interface child resource." }, "ContainerNetworkInterfaceConfigurationPropertiesFormat": { "properties": { "ipConfigurations": { "type": "array", "items": { "$ref": "#/definitions/IPConfigurationProfile" }, "description": "A list of ip configurations of the container network interface configuration." }, "containerNetworkInterfaces": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "A list of container network interfaces created from this container network interface configuration." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the container network interface configuration resource." } }, "description": "Container network interface configuration properties." }, "ContainerNetworkInterfaceConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ContainerNetworkInterfaceConfigurationPropertiesFormat", "description": "Container network interface configuration properties." }, "name": { "type": "string", "description": "The name of the resource. This name can be used to access the resource." }, "type": { "readOnly": true, "type": "string", "description": "Sub Resource type." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Container network interface configuration child resource." }, "IPConfigurationProfilePropertiesFormat": { "properties": { "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", "description": "The reference to the subnet resource to create a container network interface ip configuration." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the IP configuration profile resource." } }, "description": "IP configuration profile properties." }, "IPConfigurationProfile": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/IPConfigurationProfilePropertiesFormat", "description": "Properties of the IP configuration profile." }, "name": { "type": "string", "description": "The name of the resource. This name can be used to access the resource." }, "type": { "readOnly": true, "type": "string", "description": "Sub Resource type." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "IP configuration profile child resource." }, "Container": { "properties": {}, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Reference to container resource in remote resource provider." }, "ContainerNetworkInterfaceIpConfigurationPropertiesFormat": { "properties": { "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the container network interface IP configuration resource." } }, "description": "Properties of the container network interface IP configuration." }, "ContainerNetworkInterfaceIpConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", "description": "Properties of the container network interface IP configuration." }, "name": { "type": "string", "description": "The name of the resource. This name can be used to access the resource." }, "type": { "readOnly": true, "type": "string", "description": "Sub Resource type." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "description": "The ip configuration for a container network interface." } } }	20.22 KB	2025-05-25 12:27
📄 networkSecurityGroup.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}": { "delete": { "tags": [ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_Delete", "description": "Deletes the specified network security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "204": { "description": "Request successful. Resource does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete network security group": { "$ref": "./examples/NetworkSecurityGroupDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_Get", "description": "Gets the specified network security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting NetworkSecurityGroup resource.", "schema": { "$ref": "#/definitions/NetworkSecurityGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get network security group": { "$ref": "./examples/NetworkSecurityGroupGet.json" } } }, "put": { "tags": [ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_CreateOrUpdate", "description": "Creates or updates a network security group in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkSecurityGroup" }, "description": "Parameters supplied to the create or update network security group operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting NetworkSecurityGroup resource.", "schema": { "$ref": "#/definitions/NetworkSecurityGroup" } }, "200": { "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", "schema": { "$ref": "#/definitions/NetworkSecurityGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create network security group": { "$ref": "./examples/NetworkSecurityGroupCreate.json" }, "Create network security group with rule": { "$ref": "./examples/NetworkSecurityGroupCreateWithRule.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_UpdateTags", "description": "Updates a network security group tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update network security group tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", "schema": { "$ref": "#/definitions/NetworkSecurityGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update network security group tags": { "$ref": "./examples/NetworkSecurityGroupUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups": { "get": { "tags": [ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_ListAll", "description": "Gets all network security groups in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", "schema": { "$ref": "#/definitions/NetworkSecurityGroupListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all network security groups": { "$ref": "./examples/NetworkSecurityGroupListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups": { "get": { "tags": [ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_List", "description": "Gets all network security groups in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", "schema": { "$ref": "#/definitions/NetworkSecurityGroupListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List network security groups in resource group": { "$ref": "./examples/NetworkSecurityGroupList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { "delete": { "tags": [ "SecurityRules" ], "operationId": "SecurityRules_Delete", "description": "Deletes the specified network security rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "name": "securityRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the security rule." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete network security rule from network security group": { "$ref": "./examples/NetworkSecurityGroupRuleDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "SecurityRules" ], "operationId": "SecurityRules_Get", "description": "Get the specified network security rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "name": "securityRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the security rule." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting SecurityRule resource.", "schema": { "$ref": "#/definitions/SecurityRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get network security rule in network security group": { "$ref": "./examples/NetworkSecurityGroupRuleGet.json" } } }, "put": { "tags": [ "SecurityRules" ], "operationId": "SecurityRules_CreateOrUpdate", "description": "Creates or updates a security rule in the specified network security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "name": "securityRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the security rule." }, { "name": "securityRuleParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SecurityRule" }, "description": "Parameters supplied to the create or update network security rule operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting SecurityRule resource.", "schema": { "$ref": "#/definitions/SecurityRule" } }, "201": { "description": "Create successful. The operation returns the resulting SecurityRule resource.", "schema": { "$ref": "#/definitions/SecurityRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create security rule": { "$ref": "./examples/NetworkSecurityGroupRuleCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { "get": { "tags": [ "SecurityRules" ], "operationId": "SecurityRules_List", "description": "Gets all security rules in a network security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of SecurityRule resources.", "schema": { "$ref": "#/definitions/SecurityRuleListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List network security rules in network security group": { "$ref": "./examples/NetworkSecurityGroupRuleList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules": { "get": { "tags": [ "SecurityRules" ], "operationId": "DefaultSecurityRules_List", "description": "Gets all default security rules in a network security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of SecurityRule resources.", "schema": { "$ref": "#/definitions/SecurityRuleListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "DefaultSecurityRuleList": { "$ref": "./examples/DefaultSecurityRuleList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}": { "get": { "tags": [ "SecurityRules" ], "operationId": "DefaultSecurityRules_Get", "description": "Get the specified default network security rule.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkSecurityGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network security group." }, { "name": "defaultSecurityRuleName", "in": "path", "required": true, "type": "string", "description": "The name of the default security rule." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting SecurityRule resource.", "schema": { "$ref": "#/definitions/SecurityRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "DefaultSecurityRuleGet": { "$ref": "./examples/DefaultSecurityRuleGet.json" } } } } }, "definitions": { "SecurityRulePropertiesFormat": { "properties": { "description": { "type": "string", "description": "A description for this rule. Restricted to 140 chars." }, "protocol": { "type": "string", "description": "Network protocol this rule applies to.", "enum": [ "Tcp", "Udp", "Icmp", "Esp", "", "Ah" ], "x-ms-enum": { "name": "SecurityRuleProtocol", "modelAsString": true } }, "sourcePortRange": { "type": "string", "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '' can also be used to match all ports." }, "destinationPortRange": { "type": "string", "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '' can also be used to match all ports." }, "sourceAddressPrefix": { "type": "string", "description": "The CIDR or source IP range. Asterisk '' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." }, "sourceAddressPrefixes": { "type": "array", "items": { "type": "string" }, "description": "The CIDR or source IP ranges." }, "sourceApplicationSecurityGroups": { "type": "array", "items": { "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" }, "description": "The application security group specified as source." }, "destinationAddressPrefix": { "type": "string", "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", "items": { "type": "string" }, "description": "The destination address prefixes. CIDR or destination IP ranges." }, "destinationApplicationSecurityGroups": { "type": "array", "items": { "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" }, "description": "The application security group specified as destination." }, "sourcePortRanges": { "type": "array", "items": { "type": "string", "description": "The source port." }, "description": "The source port ranges." }, "destinationPortRanges": { "type": "array", "items": { "type": "string", "description": "The destination port." }, "description": "The destination port ranges." }, "access": { "$ref": "#/definitions/SecurityRuleAccess", "description": "The network traffic is allowed or denied." }, "priority": { "type": "integer", "format": "int32", "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." }, "direction": { "$ref": "#/definitions/SecurityRuleDirection", "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the security rule resource." } }, "required": [ "protocol", "access", "direction" ], "description": "Security rule resource." }, "SecurityRule": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SecurityRulePropertiesFormat", "description": "Properties of the security rule." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Network security rule." }, "SecurityRuleListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/SecurityRule" }, "description": "The security rules in a network security group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group." }, "NetworkSecurityGroupPropertiesFormat": { "properties": { "securityRules": { "type": "array", "items": { "$ref": "#/definitions/SecurityRule" }, "description": "A collection of security rules of the network security group." }, "defaultSecurityRules": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/SecurityRule" }, "description": "The default security rules of network security group." }, "networkInterfaces": { "readOnly": true, "type": "array", "items": { "$ref": "./networkInterface.json#/definitions/NetworkInterface" }, "description": "A collection of references to network interfaces." }, "subnets": { "readOnly": true, "type": "array", "items": { "$ref": "./virtualNetwork.json#/definitions/Subnet" }, "description": "A collection of references to subnets." }, "flowLogs": { "readOnly": true, "type": "array", "items": { "$ref": "./networkWatcher.json#/definitions/FlowLog" }, "description": "A collection of references to flow log resources." }, "resourceGuid": { "readOnly": true, "type": "string", "description": "The resource GUID property of the network security group resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the network security group resource." } }, "description": "Network Security Group resource." }, "NetworkSecurityGroup": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat", "description": "Properties of the network security group." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "NetworkSecurityGroup resource." }, "NetworkSecurityGroupListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NetworkSecurityGroup" }, "description": "A list of NetworkSecurityGroup resources." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListNetworkSecurityGroups API service call." }, "SecurityRuleAccess": { "type": "string", "description": "Whether network traffic is allowed or denied.", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "SecurityRuleAccess", "modelAsString": true } }, "SecurityRuleDirection": { "type": "string", "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", "enum": [ "Inbound", "Outbound" ], "x-ms-enum": { "name": "SecurityRuleDirection", "modelAsString": true } } } }	32.08 KB	2025-05-25 12:27
📄 networkWatcher.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}": { "put": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_CreateOrUpdate", "description": "Creates or updates a network watcher in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkWatcher" }, "description": "Parameters that define the network watcher resource." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting network watcher resource.", "schema": { "$ref": "#/definitions/NetworkWatcher" } }, "201": { "description": "Create successful. The operation returns the resulting network watcher resource.", "schema": { "$ref": "#/definitions/NetworkWatcher" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create network watcher": { "$ref": "./examples/NetworkWatcherCreate.json" } } }, "get": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_Get", "description": "Gets the specified network watcher by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a network watcher resource.", "schema": { "$ref": "#/definitions/NetworkWatcher" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get network watcher": { "$ref": "./examples/NetworkWatcherGet.json" } } }, "delete": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_Delete", "description": "Deletes the specified network watcher resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete network watcher": { "$ref": "./examples/NetworkWatcherDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "patch": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_UpdateTags", "description": "Updates a network watcher tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update network watcher tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting network watcher resource.", "schema": { "$ref": "#/definitions/NetworkWatcher" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update network watcher tags": { "$ref": "./examples/NetworkWatcherUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers": { "get": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_List", "description": "Gets all network watchers by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of network watcher resources.", "schema": { "$ref": "#/definitions/NetworkWatcherListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "x-ms-examples": { "List network watchers": { "$ref": "./examples/NetworkWatcherList.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers": { "get": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_ListAll", "description": "Gets all network watchers by subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of network watcher resources.", "schema": { "$ref": "#/definitions/NetworkWatcherListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "x-ms-examples": { "List all network watchers": { "$ref": "./examples/NetworkWatcherListAll.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_GetTopology", "description": "Gets the current network topology by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TopologyParameters" }, "description": "Parameters that define the representation of topology." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the topology of resource group.", "schema": { "$ref": "#/definitions/Topology" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Topology": { "$ref": "./examples/NetworkWatcherTopologyGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_VerifyIPFlow", "description": "Verify IP flow from the specified VM to a location given the currently configured NSG rules.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VerificationIPFlowParameters" }, "description": "Parameters that define the IP flow to be verified." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the result of IP flow verification.", "schema": { "$ref": "#/definitions/VerificationIPFlowResult" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/VerificationIPFlowResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Ip flow verify": { "$ref": "./examples/NetworkWatcherIpFlowVerify.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_GetNextHop", "description": "Gets the next hop from the specified VM.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NextHopParameters" }, "description": "Parameters that define the source and destination endpoint." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the next hop from the VM.", "schema": { "$ref": "#/definitions/NextHopResult" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/NextHopResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get next hop": { "$ref": "./examples/NetworkWatcherNextHopGet.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_GetVMSecurityRules", "description": "Gets the configured and effective security group rules on the specified VM.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SecurityGroupViewParameters" }, "description": "Parameters that define the VM to check security groups for." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns security group rules on the VM.", "schema": { "$ref": "#/definitions/SecurityGroupViewResult" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/SecurityGroupViewResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get security group view": { "$ref": "./examples/NetworkWatcherSecurityGroupViewGet.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}": { "put": { "tags": [ "PacketCaptures" ], "operationId": "PacketCaptures_Create", "description": "Create and start a packet capture on the specified VM.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "packetCaptureName", "in": "path", "required": true, "type": "string", "description": "The name of the packet capture session." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PacketCapture" }, "description": "Parameters that define the create packet capture operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Request successful. The operation returns the resulting packet capture session.", "schema": { "$ref": "#/definitions/PacketCaptureResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "get": { "tags": [ "PacketCaptures" ], "operationId": "PacketCaptures_Get", "description": "Gets a packet capture session by name.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "packetCaptureName", "in": "path", "required": true, "type": "string", "description": "The name of the packet capture session." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a packet capture session.", "schema": { "$ref": "#/definitions/PacketCaptureResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureGet.json" } } }, "delete": { "tags": [ "PacketCaptures" ], "operationId": "PacketCaptures_Delete", "description": "Deletes the specified packet capture session.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "packetCaptureName", "in": "path", "required": true, "type": "string", "description": "The name of the packet capture session." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Delete successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop": { "post": { "tags": [ "PacketCaptures" ], "operationId": "PacketCaptures_Stop", "description": "Stops a specified packet capture session.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "packetCaptureName", "in": "path", "required": true, "type": "string", "description": "The name of the packet capture session." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation stops the packet capture session." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Stop packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureStop.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus": { "post": { "tags": [ "PacketCaptures" ], "operationId": "PacketCaptures_GetStatus", "description": "Query the status of a running packet capture session.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "name": "packetCaptureName", "in": "path", "required": true, "type": "string", "description": "The name given to the packet capture session." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful query of packet capture status.", "schema": { "$ref": "#/definitions/PacketCaptureQueryStatusResult" } }, "202": { "description": "Accepted query status of packet capture.", "schema": { "$ref": "#/definitions/PacketCaptureQueryStatusResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Query packet capture status": { "$ref": "./examples/NetworkWatcherPacketCaptureQueryStatus.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures": { "get": { "tags": [ "PacketCaptures" ], "operationId": "PacketCaptures_List", "description": "Lists all packet capture sessions within the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful packet capture enumeration request.", "schema": { "$ref": "#/definitions/PacketCaptureListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "x-ms-examples": { "List packet captures": { "$ref": "./examples/NetworkWatcherPacketCapturesList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_GetTroubleshooting", "description": "Initiate troubleshooting on a specified resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TroubleshootingParameters" }, "description": "Parameters that define the resource to troubleshoot." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful troubleshooting request.", "schema": { "$ref": "#/definitions/TroubleshootingResult" } }, "202": { "description": "Accepted get troubleshooting request.", "schema": { "$ref": "#/definitions/TroubleshootingResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get troubleshooting": { "$ref": "./examples/NetworkWatcherTroubleshootGet.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_GetTroubleshootingResult", "description": "Get the last completed troubleshooting result on a specified resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/QueryTroubleshootingParameters" }, "description": "Parameters that define the resource to query the troubleshooting result." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful get troubleshooting result request.", "schema": { "$ref": "#/definitions/TroubleshootingResult" } }, "202": { "description": "Accepted get troubleshooting result request.", "schema": { "$ref": "#/definitions/TroubleshootingResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get troubleshoot result": { "$ref": "./examples/NetworkWatcherTroubleshootResultQuery.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog": { "post": { "tags": [ "NetworkWatchers", "TrafficAnalytics" ], "operationId": "NetworkWatchers_SetFlowLogConfiguration", "description": "Configures flow log and traffic analytics (optional) on a specified resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FlowLogInformation" }, "description": "Parameters that define the configuration of flow log." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful request for setting flow log and traffic analytics (optional) configuration.", "schema": { "$ref": "#/definitions/FlowLogInformation" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/FlowLogInformation" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Configure flow log": { "$ref": "./examples/NetworkWatcherFlowLogConfigure.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus": { "post": { "tags": [ "NetworkWatchers", "TrafficAnalytics" ], "operationId": "NetworkWatchers_GetFlowLogStatus", "description": "Queries status of flow log and traffic analytics (optional) on a specified resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FlowLogStatusParameters" }, "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful request for query flow log and traffic analytics (optional) status.", "schema": { "$ref": "#/definitions/FlowLogInformation" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/FlowLogInformation" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get flow log status": { "$ref": "./examples/NetworkWatcherFlowLogStatusQuery.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_CheckConnectivity", "description": "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConnectivityParameters" }, "description": "Parameters that determine how the connectivity check will be performed." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful request for checking connectivity.", "schema": { "$ref": "#/definitions/ConnectivityInformation" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/ConnectivityInformation" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check connectivity": { "$ref": "./examples/NetworkWatcherConnectivityCheck.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_GetAzureReachabilityReport", "description": "NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AzureReachabilityReportParameters" }, "description": "Parameters that determine Azure reachability report configuration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful request for Azure reachability report.", "schema": { "$ref": "#/definitions/AzureReachabilityReport" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/AzureReachabilityReport" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Azure Reachability Report": { "$ref": "./examples/NetworkWatcherAzureReachabilityReportGet.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_ListAvailableProviders", "description": "NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher resource." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AvailableProvidersListParameters" }, "description": "Parameters that scope the list of available providers." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful request for list of available providers.", "schema": { "$ref": "#/definitions/AvailableProvidersList" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/AvailableProvidersList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Available Providers List": { "$ref": "./examples/NetworkWatcherAvailableProvidersListGet.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic": { "post": { "tags": [ "NetworkWatchers" ], "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", "description": "Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticParameters" }, "description": "Parameters to get network configuration diagnostic." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the result of network configuration diagnostic.", "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" } }, "202": { "description": "Accepted and the operation will complete asynchronously.", "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Network configuration diagnostic": { "$ref": "./examples/NetworkWatcherNetworkConfigurationDiagnostic.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}": { "put": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_CreateOrUpdate", "description": "Create or update a connection monitor.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "name": "connectionMonitorName", "in": "path", "required": true, "type": "string", "description": "The name of the connection monitor." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConnectionMonitor" }, "description": "Parameters that define the operation to create a connection monitor." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting network watcher resource.", "schema": { "$ref": "#/definitions/ConnectionMonitorResult" } }, "201": { "description": "Create successful. The operation returns the resulting network watcher resource.", "schema": { "$ref": "#/definitions/ConnectionMonitorResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create connection monitor V1": { "$ref": "./examples/NetworkWatcherConnectionMonitorCreate.json" }, "Create connection monitor V2": { "$ref": "./examples/NetworkWatcherConnectionMonitorV2Create.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "get": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_Get", "description": "Gets a connection monitor by name.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "name": "connectionMonitorName", "in": "path", "required": true, "type": "string", "description": "The name of the connection monitor." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a connection monitor.", "schema": { "$ref": "#/definitions/ConnectionMonitorResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorGet.json" } } }, "delete": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_Delete", "description": "Deletes the specified connection monitor.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "name": "connectionMonitorName", "in": "path", "required": true, "type": "string", "description": "The name of the connection monitor." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Delete successful." }, "202": { "description": "Accepted. The operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "patch": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_UpdateTags", "description": "Update tags of the specified connection monitor.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "connectionMonitorName", "in": "path", "required": true, "type": "string", "description": "The name of the connection monitor." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update connection monitor tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns updated connection monitor.", "schema": { "$ref": "#/definitions/ConnectionMonitorResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update connection monitor tags": { "$ref": "./examples/NetworkWatcherConnectionMonitorUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/stop": { "post": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_Stop", "description": "Stops the specified connection monitor.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "name": "connectionMonitorName", "in": "path", "required": true, "type": "string", "description": "The name of the connection monitor." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation stops the connection monitor." }, "202": { "description": "Accepted. The operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Stop connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorStop.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/start": { "post": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_Start", "description": "Starts the specified connection monitor.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "name": "connectionMonitorName", "in": "path", "required": true, "type": "string", "description": "The name of the connection monitor." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation starts the connection monitor." }, "202": { "description": "Accepted. The operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Start connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorStart.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/query": { "post": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_Query", "description": "Query a snapshot of the most recent connection states.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "name": "connectionMonitorName", "in": "path", "required": true, "type": "string", "description": "The name given to the connection monitor." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful query of connection states.", "schema": { "$ref": "#/definitions/ConnectionMonitorQueryResult" } }, "202": { "description": "Accepted query of connection states.", "schema": { "$ref": "#/definitions/ConnectionMonitorQueryResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Query connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorQuery.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors": { "get": { "tags": [ "ConnectionMonitors" ], "operationId": "ConnectionMonitors_List", "description": "Lists all connection monitors for the specified Network Watcher.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful connection monitor enumeration request.", "schema": { "$ref": "#/definitions/ConnectionMonitorListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "x-ms-examples": { "List connection monitors": { "$ref": "./examples/NetworkWatcherConnectionMonitorList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}": { "put": { "tags": [ "FlowLogs" ], "operationId": "FlowLogs_CreateOrUpdate", "description": "Create or update a flow log for the specified network security group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "flowLogName", "in": "path", "required": true, "type": "string", "description": "The name of the flow log." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FlowLog" }, "description": "Parameters that define the create or update flow log resource." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Request successful. The operation returns the resulting flow log resource.", "schema": { "$ref": "#/definitions/FlowLog" } }, "200": { "description": "Update successful. The operation returns the resulting flow log resource.", "schema": { "$ref": "#/definitions/FlowLog" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update flow log": { "$ref": "./examples/NetworkWatcherFlowLogCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "get": { "tags": [ "FlowLogs" ], "operationId": "FlowLogs_Get", "description": "Gets a flow log resource by name.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "flowLogName", "in": "path", "required": true, "type": "string", "description": "The name of the flow log resource." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a flow log resource.", "schema": { "$ref": "#/definitions/FlowLog" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get flow log": { "$ref": "./examples/NetworkWatcherFlowLogGet.json" } } }, "delete": { "tags": [ "FlowLogs" ], "operationId": "FlowLogs_Delete", "description": "Deletes the specified flow log resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the network watcher." }, { "name": "flowLogName", "in": "path", "required": true, "type": "string", "description": "The name of the flow log resource." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Delete successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete flow log": { "$ref": "./examples/NetworkWatcherFlowLogDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs": { "get": { "tags": [ "FlowLogs" ], "operationId": "FlowLogs_List", "description": "Lists all flow log resources for the specified Network Watcher.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group containing Network Watcher." }, { "name": "networkWatcherName", "in": "path", "required": true, "type": "string", "description": "The name of the Network Watcher resource." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successful flow log enumeration request.", "schema": { "$ref": "#/definitions/FlowLogListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List connection monitors": { "$ref": "./examples/NetworkWatcherFlowLogList.json" } } } } }, "definitions": { "ErrorResponse": { "description": "The error object.", "properties": { "error": { "title": "Error", "$ref": "./network.json#/definitions/ErrorDetails", "description": "The error details object." } } }, "NetworkWatcher": { "properties": { "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/NetworkWatcherPropertiesFormat", "description": "Properties of the network watcher." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Network watcher in a resource group." }, "NetworkWatcherPropertiesFormat": { "properties": { "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the network watcher resource." } }, "description": "The network watcher properties." }, "NetworkWatcherListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/NetworkWatcher" }, "description": "List of network watcher resources." } }, "description": "Response for ListNetworkWatchers API service call." }, "TopologyParameters": { "properties": { "targetResourceGroupName": { "type": "string", "description": "The name of the target resource group to perform topology on." }, "targetVirtualNetwork": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference to the Virtual Network resource." }, "targetSubnet": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference to the Subnet resource." } }, "description": "Parameters that define the representation of topology." }, "Topology": { "properties": { "id": { "readOnly": true, "type": "string", "description": "GUID representing the operation id." }, "createdDateTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "The datetime when the topology was initially created for the resource group." }, "lastModified": { "readOnly": true, "type": "string", "format": "date-time", "description": "The datetime when the topology was last modified." }, "resources": { "type": "array", "items": { "$ref": "#/definitions/TopologyResource" }, "description": "A list of topology resources." } }, "description": "Topology of the specified resource group." }, "TopologyResource": { "properties": { "name": { "type": "string", "description": "Name of the resource." }, "id": { "type": "string", "description": "ID of the resource." }, "location": { "type": "string", "description": "Resource location." }, "associations": { "type": "array", "description": "Holds the associations the resource has with other resources in the resource group.", "items": { "$ref": "#/definitions/TopologyAssociation" } } }, "description": "The network resource topology information for the given resource group." }, "TopologyAssociation": { "properties": { "name": { "type": "string", "description": "The name of the resource that is associated with the parent resource." }, "resourceId": { "type": "string", "description": "The ID of the resource that is associated with the parent resource." }, "associationType": { "type": "string", "enum": [ "Associated", "Contains" ], "x-ms-enum": { "name": "AssociationType", "modelAsString": true }, "description": "The association type of the child resource to the parent resource." } }, "description": "Resources that have an association with the parent resource." }, "VerificationIPFlowParameters": { "description": "Parameters that define the IP flow to be verified.", "required": [ "targetResourceId", "direction", "protocol", "localPort", "remotePort", "localIPAddress", "remoteIPAddress" ], "properties": { "targetResourceId": { "type": "string", "description": "The ID of the target resource to perform next-hop on." }, "direction": { "$ref": "#/definitions/Direction", "description": "The direction of the packet represented as a 5-tuple." }, "protocol": { "type": "string", "enum": [ "TCP", "UDP" ], "x-ms-enum": { "name": "IpFlowProtocol", "modelAsString": true }, "description": "Protocol to be verified on." }, "localPort": { "type": "string", "description": "The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." }, "remotePort": { "type": "string", "description": "The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." }, "localIPAddress": { "type": "string", "description": "The local IP address. Acceptable values are valid IPv4 addresses." }, "remoteIPAddress": { "type": "string", "description": "The remote IP address. Acceptable values are valid IPv4 addresses." }, "targetNicResourceId": { "type": "string", "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional)." } } }, "VerificationIPFlowResult": { "description": "Results of IP flow verification on the target resource.", "properties": { "access": { "$ref": "./network.json#/definitions/Access", "description": "Indicates whether the traffic is allowed or denied." }, "ruleName": { "type": "string", "description": "Name of the rule. If input is not matched against any security rule, it is not displayed." } } }, "NextHopParameters": { "description": "Parameters that define the source and destination endpoint.", "required": [ "targetResourceId", "sourceIPAddress", "destinationIPAddress" ], "properties": { "targetResourceId": { "type": "string", "description": "The resource identifier of the target resource against which the action is to be performed." }, "sourceIPAddress": { "type": "string", "description": "The source IP address." }, "destinationIPAddress": { "type": "string", "description": "The destination IP address." }, "targetNicResourceId": { "type": "string", "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional)." } } }, "NextHopResult": { "description": "The information about next hop from the specified VM.", "properties": { "nextHopType": { "type": "string", "enum": [ "Internet", "VirtualAppliance", "VirtualNetworkGateway", "VnetLocal", "HyperNetGateway", "None" ], "x-ms-enum": { "name": "NextHopType", "modelAsString": true }, "description": "Next hop type." }, "nextHopIpAddress": { "type": "string", "description": "Next hop IP Address." }, "routeTableId": { "type": "string", "description": "The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'." } } }, "SecurityGroupViewParameters": { "description": "Parameters that define the VM to check security groups for.", "required": [ "targetResourceId" ], "properties": { "targetResourceId": { "type": "string", "description": "ID of the target VM." } } }, "SecurityGroupViewResult": { "description": "The information about security rules applied to the specified VM.", "properties": { "networkInterfaces": { "type": "array", "description": "List of network interfaces on the specified VM.", "items": { "$ref": "#/definitions/SecurityGroupNetworkInterface" } } } }, "SecurityGroupNetworkInterface": { "description": "Network interface and all its associated security rules.", "properties": { "id": { "type": "string", "description": "ID of the network interface." }, "securityRuleAssociations": { "$ref": "#/definitions/SecurityRuleAssociations", "description": "All security rules associated with the network interface." } } }, "SecurityRuleAssociations": { "description": "All security rules associated with the network interface.", "properties": { "networkInterfaceAssociation": { "$ref": "#/definitions/NetworkInterfaceAssociation", "description": "Network interface and it's custom security rules." }, "subnetAssociation": { "$ref": "#/definitions/SubnetAssociation", "description": "Subnet and it's custom security rules." }, "defaultSecurityRules": { "type": "array", "items": { "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" }, "description": "Collection of default security rules of the network security group." }, "effectiveSecurityRules": { "type": "array", "items": { "$ref": "./networkInterface.json#/definitions/EffectiveNetworkSecurityRule" }, "description": "Collection of effective security rules." } } }, "NetworkInterfaceAssociation": { "description": "Network interface and its custom security rules.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Network interface ID." }, "securityRules": { "type": "array", "description": "Collection of custom security rules.", "items": { "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" } } } }, "SubnetAssociation": { "description": "Subnet and it's custom security rules.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Subnet ID." }, "securityRules": { "type": "array", "description": "Collection of custom security rules.", "items": { "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" } } } }, "PacketCapture": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PacketCaptureParameters", "description": "Properties of the packet capture." } }, "required": [ "properties" ], "description": "Parameters that define the create packet capture operation." }, "PacketCaptureParameters": { "properties": { "target": { "type": "string", "description": "The ID of the targeted resource, only VM is currently supported." }, "bytesToCapturePerPacket": { "type": "integer", "default": 0, "description": "Number of bytes captured per packet, the remaining bytes are truncated." }, "totalBytesPerSession": { "type": "integer", "default": 1073741824, "description": "Maximum size of the capture output." }, "timeLimitInSeconds": { "type": "integer", "default": 18000, "description": "Maximum duration of the capture session in seconds." }, "storageLocation": { "$ref": "#/definitions/PacketCaptureStorageLocation", "description": "The storage location for a packet capture session." }, "filters": { "type": "array", "items": { "$ref": "#/definitions/PacketCaptureFilter" }, "description": "A list of packet capture filters." } }, "required": [ "target", "storageLocation" ], "description": "Parameters that define the create packet capture operation." }, "PacketCaptureStorageLocation": { "properties": { "storageId": { "type": "string", "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." }, "storagePath": { "type": "string", "description": "The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture." }, "filePath": { "type": "string", "description": "A valid local path on the targeting VM. Must include the name of the capture file (.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." } }, "description": "The storage location for a packet capture session." }, "PacketCaptureFilter": { "properties": { "protocol": { "type": "string", "enum": [ "TCP", "UDP", "Any" ], "x-ms-enum": { "name": "PcProtocol", "modelAsString": true }, "default": "Any", "description": "Protocol to be filtered on." }, "localIPAddress": { "type": "string", "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." }, "remoteIPAddress": { "type": "string", "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." }, "localPort": { "type": "string", "description": "Local port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." }, "remotePort": { "type": "string", "description": "Remote port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." } }, "description": "Filter that is applied to packet capture request. Multiple filters can be applied." }, "PacketCaptureListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PacketCaptureResult" }, "description": "Information about packet capture sessions." } }, "description": "List of packet capture sessions." }, "PacketCaptureResult": { "properties": { "name": { "readOnly": true, "type": "string", "description": "Name of the packet capture session." }, "id": { "readOnly": true, "type": "string", "description": "ID of the packet capture operation." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PacketCaptureResultProperties", "description": "Properties of the packet capture result." } }, "description": "Information about packet capture session." }, "PacketCaptureResultProperties": { "properties": { "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the packet capture session." } }, "allOf": [ { "$ref": "#/definitions/PacketCaptureParameters" } ], "description": "The properties of a packet capture session." }, "PacketCaptureQueryStatusResult": { "properties": { "name": { "type": "string", "description": "The name of the packet capture resource." }, "id": { "type": "string", "description": "The ID of the packet capture resource." }, "captureStartTime": { "type": "string", "format": "date-time", "description": "The start time of the packet capture session." }, "packetCaptureStatus": { "type": "string", "enum": [ "NotStarted", "Running", "Stopped", "Error", "Unknown" ], "x-ms-enum": { "name": "PcStatus", "modelAsString": true }, "description": "The status of the packet capture session." }, "stopReason": { "type": "string", "description": "The reason the current packet capture session was stopped." }, "packetCaptureError": { "type": "array", "description": "List of errors of packet capture session.", "items": { "type": "string", "enum": [ "InternalError", "AgentStopped", "CaptureFailed", "LocalFileFailed", "StorageFailed" ], "x-ms-enum": { "name": "PcError", "modelAsString": true } } } }, "description": "Status of packet capture session." }, "TroubleshootingParameters": { "description": "Parameters that define the resource to troubleshoot.", "required": [ "targetResourceId", "properties" ], "properties": { "targetResourceId": { "description": "The target resource to troubleshoot.", "type": "string" }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/TroubleshootingProperties", "description": "Properties of the troubleshooting resource." } } }, "QueryTroubleshootingParameters": { "description": "Parameters that define the resource to query the troubleshooting result.", "required": [ "targetResourceId" ], "properties": { "targetResourceId": { "description": "The target resource ID to query the troubleshooting result.", "type": "string" } } }, "TroubleshootingProperties": { "description": "Storage location provided for troubleshoot.", "required": [ "storageId", "storagePath" ], "properties": { "storageId": { "description": "The ID for the storage account to save the troubleshoot result.", "type": "string" }, "storagePath": { "description": "The path to the blob to save the troubleshoot result in.", "type": "string" } } }, "TroubleshootingResult": { "description": "Troubleshooting information gained from specified resource.", "properties": { "startTime": { "type": "string", "format": "date-time", "description": "The start time of the troubleshooting." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the troubleshooting." }, "code": { "type": "string", "description": "The result code of the troubleshooting." }, "results": { "type": "array", "description": "Information from troubleshooting.", "items": { "$ref": "#/definitions/TroubleshootingDetails" } } } }, "TroubleshootingDetails": { "description": "Information gained from troubleshooting of specified resource.", "properties": { "id": { "type": "string", "description": "The id of the get troubleshoot operation." }, "reasonType": { "type": "string", "description": "Reason type of failure." }, "summary": { "type": "string", "description": "A summary of troubleshooting." }, "detail": { "type": "string", "description": "Details on troubleshooting results." }, "recommendedActions": { "type": "array", "description": "List of recommended actions.", "items": { "$ref": "#/definitions/TroubleshootingRecommendedActions" } } } }, "TroubleshootingRecommendedActions": { "description": "Recommended actions based on discovered issues.", "properties": { "actionId": { "description": "ID of the recommended action.", "type": "string" }, "actionText": { "description": "Description of recommended actions.", "type": "string" }, "actionUri": { "description": "The uri linking to a documentation for the recommended troubleshooting actions.", "type": "string" }, "actionUriText": { "description": "The information from the URI for the recommended troubleshooting actions.", "type": "string" } } }, "FlowLogListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/FlowLog" }, "description": "Information about flow log resource." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "List of flow logs." }, "FlowLog": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/FlowLogPropertiesFormat", "description": "Properties of the flow log." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "A flow log resource." }, "FlowLogPropertiesFormat": { "description": "Parameters that define the configuration of flow log.", "required": [ "targetResourceId", "storageId" ], "properties": { "targetResourceId": { "description": "ID of network security group to which flow log will be applied.", "type": "string" }, "targetResourceGuid": { "readOnly": true, "description": "Guid of network security group to which flow log will be applied.", "type": "string" }, "storageId": { "description": "ID of the storage account which is used to store the flow log.", "type": "string" }, "enabled": { "description": "Flag to enable/disable flow logging.", "type": "boolean" }, "retentionPolicy": { "$ref": "#/definitions/RetentionPolicyParameters", "description": "Parameters that define the retention policy for flow log." }, "format": { "$ref": "#/definitions/FlowLogFormatParameters", "description": "Parameters that define the flow log format." }, "flowAnalyticsConfiguration": { "$ref": "#/definitions/TrafficAnalyticsProperties", "description": "Parameters that define the configuration of traffic analytics." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the flow log." } } }, "FlowLogProperties": { "description": "Parameters that define the configuration of flow log.", "required": [ "storageId", "enabled" ], "properties": { "storageId": { "description": "ID of the storage account which is used to store the flow log.", "type": "string" }, "enabled": { "description": "Flag to enable/disable flow logging.", "type": "boolean" }, "retentionPolicy": { "$ref": "#/definitions/RetentionPolicyParameters", "description": "Parameters that define the retention policy for flow log." }, "format": { "$ref": "#/definitions/FlowLogFormatParameters", "description": "Parameters that define the flow log format." } } }, "FlowLogStatusParameters": { "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status.", "required": [ "targetResourceId" ], "properties": { "targetResourceId": { "description": "The target resource where getting the flow log and traffic analytics (optional) status.", "type": "string" } } }, "RetentionPolicyParameters": { "description": "Parameters that define the retention policy for flow log.", "properties": { "days": { "description": "Number of days to retain flow log records.", "type": "integer", "default": 0 }, "enabled": { "description": "Flag to enable/disable retention.", "type": "boolean", "default": false } } }, "FlowLogFormatParameters": { "description": "Parameters that define the flow log format.", "properties": { "type": { "type": "string", "description": "The file type of flow log.", "enum": [ "JSON" ], "x-ms-enum": { "name": "FlowLogFormatType", "modelAsString": true } }, "version": { "description": "The version (revision) of the flow log.", "type": "integer", "default": 0 } } }, "FlowLogInformation": { "description": "Information on the configuration of flow log and traffic analytics (optional) .", "required": [ "targetResourceId", "properties" ], "properties": { "targetResourceId": { "description": "The ID of the resource to configure for flow log and traffic analytics (optional) .", "type": "string" }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/FlowLogProperties", "description": "Properties of the flow log." }, "flowAnalyticsConfiguration": { "$ref": "#/definitions/TrafficAnalyticsProperties", "description": "Parameters that define the configuration of traffic analytics." } } }, "TrafficAnalyticsProperties": { "description": "Parameters that define the configuration of traffic analytics.", "properties": { "networkWatcherFlowAnalyticsConfiguration": { "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties", "description": "Parameters that define the configuration of traffic analytics." } } }, "TrafficAnalyticsConfigurationProperties": { "description": "Parameters that define the configuration of traffic analytics.", "properties": { "enabled": { "description": "Flag to enable/disable traffic analytics.", "type": "boolean" }, "workspaceId": { "description": "The resource guid of the attached workspace.", "type": "string" }, "workspaceRegion": { "description": "The location of the attached workspace.", "type": "string" }, "workspaceResourceId": { "description": "Resource Id of the attached workspace.", "type": "string" }, "trafficAnalyticsInterval": { "description": "The interval in minutes which would decide how frequently TA service should do flow analytics.", "type": "integer" } } }, "ConnectivityParameters": { "description": "Parameters that determine how the connectivity check will be performed.", "required": [ "source", "destination" ], "properties": { "source": { "$ref": "#/definitions/ConnectivitySource", "description": "The source of the connection." }, "destination": { "$ref": "#/definitions/ConnectivityDestination", "description": "The destination of connection." }, "protocol": { "type": "string", "description": "Network protocol.", "enum": [ "Tcp", "Http", "Https", "Icmp" ], "x-ms-enum": { "name": "Protocol", "modelAsString": true } }, "protocolConfiguration": { "$ref": "#/definitions/ProtocolConfiguration", "description": "Configuration of the protocol." }, "preferredIPVersion": { "$ref": "./network.json#/definitions/IPVersion", "description": "Preferred IP version of the connection." } } }, "ConnectivitySource": { "description": "Parameters that define the source of the connection.", "required": [ "resourceId" ], "properties": { "resourceId": { "description": "The ID of the resource from which a connectivity check will be initiated.", "type": "string" }, "port": { "description": "The source port from which a connectivity check will be performed.", "type": "integer" } } }, "ConnectivityDestination": { "description": "Parameters that define destination of connection.", "properties": { "resourceId": { "description": "The ID of the resource to which a connection attempt will be made.", "type": "string" }, "address": { "description": "The IP address or URI the resource to which a connection attempt will be made.", "type": "string" }, "port": { "description": "Port on which check connectivity will be performed.", "type": "integer" } } }, "ConnectivityInformation": { "description": "Information on the connectivity status.", "properties": { "hops": { "readOnly": true, "type": "array", "description": "List of hops between the source and the destination.", "items": { "$ref": "#/definitions/ConnectivityHop" } }, "connectionStatus": { "readOnly": true, "type": "string", "enum": [ "Unknown", "Connected", "Disconnected", "Degraded" ], "x-ms-enum": { "name": "ConnectionStatus", "modelAsString": true }, "description": "The connection status." }, "avgLatencyInMs": { "description": "Average latency in milliseconds.", "readOnly": true, "type": "integer" }, "minLatencyInMs": { "description": "Minimum latency in milliseconds.", "readOnly": true, "type": "integer" }, "maxLatencyInMs": { "description": "Maximum latency in milliseconds.", "readOnly": true, "type": "integer" }, "probesSent": { "description": "Total number of probes sent.", "readOnly": true, "type": "integer" }, "probesFailed": { "description": "Number of failed probes.", "readOnly": true, "type": "integer" } } }, "ConnectivityHop": { "description": "Information about a hop between the source and the destination.", "properties": { "type": { "description": "The type of the hop.", "readOnly": true, "type": "string" }, "id": { "description": "The ID of the hop.", "readOnly": true, "type": "string" }, "address": { "description": "The IP address of the hop.", "readOnly": true, "type": "string" }, "resourceId": { "description": "The ID of the resource corresponding to this hop.", "readOnly": true, "type": "string" }, "nextHopIds": { "readOnly": true, "type": "array", "description": "List of next hop identifiers.", "items": { "type": "string" } }, "issues": { "readOnly": true, "type": "array", "description": "List of issues.", "items": { "$ref": "#/definitions/ConnectivityIssue" } } } }, "ConnectivityIssue": { "description": "Information about an issue encountered in the process of checking for connectivity.", "properties": { "origin": { "readOnly": true, "type": "string", "enum": [ "Local", "Inbound", "Outbound" ], "x-ms-enum": { "name": "Origin", "modelAsString": true }, "description": "The origin of the issue." }, "severity": { "readOnly": true, "type": "string", "enum": [ "Error", "Warning" ], "x-ms-enum": { "name": "Severity", "modelAsString": true }, "description": "The severity of the issue." }, "type": { "readOnly": true, "type": "string", "enum": [ "Unknown", "AgentStopped", "GuestFirewall", "DnsResolution", "SocketBind", "NetworkSecurityRule", "UserDefinedRoute", "PortThrottled", "Platform" ], "x-ms-enum": { "name": "IssueType", "modelAsString": true }, "description": "The type of issue." }, "context": { "readOnly": true, "type": "array", "description": "Provides additional context on the issue.", "items": { "$ref": "#/definitions/IssueContext" } } } }, "IssueContext": { "description": "A key-value pair that provides additional context on the issue.", "type": "object", "additionalProperties": { "type": "string" } }, "ProtocolConfiguration": { "description": "Configuration of the protocol.", "properties": { "HTTPConfiguration": { "$ref": "#/definitions/HTTPConfiguration", "description": "HTTP configuration of the connectivity check." } } }, "HTTPConfiguration": { "properties": { "method": { "type": "string", "description": "HTTP method.", "enum": [ "Get" ], "x-ms-enum": { "name": "HTTPMethod", "modelAsString": true } }, "headers": { "type": "array", "description": "List of HTTP headers.", "items": { "$ref": "#/definitions/HTTPHeader" } }, "validStatusCodes": { "type": "array", "items": { "type": "integer" }, "description": "Valid status codes." } }, "description": "HTTP configuration of the connectivity check." }, "HTTPHeader": { "properties": { "name": { "type": "string", "description": "The name in HTTP header." }, "value": { "type": "string", "description": "The value in HTTP header." } }, "description": "The HTTP header." }, "AzureReachabilityReportParameters": { "properties": { "providerLocation": { "$ref": "#/definitions/AzureReachabilityReportLocation", "description": "Parameters that define a geographic location." }, "providers": { "type": "array", "items": { "type": "string" }, "description": "List of Internet service providers." }, "azureLocations": { "type": "array", "items": { "type": "string" }, "description": "Optional Azure regions to scope the query to." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time for the Azure reachability report." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time for the Azure reachability report." } }, "required": [ "providerLocation", "startTime", "endTime" ], "description": "Geographic and time constraints for Azure reachability report." }, "AzureReachabilityReportLocation": { "properties": { "country": { "type": "string", "description": "The name of the country." }, "state": { "type": "string", "description": "The name of the state." }, "city": { "type": "string", "description": "The name of the city or town." } }, "required": [ "country" ], "description": "Parameters that define a geographic location." }, "AzureReachabilityReport": { "properties": { "aggregationLevel": { "type": "string", "description": "The aggregation level of Azure reachability report. Can be Country, State or City." }, "providerLocation": { "$ref": "#/definitions/AzureReachabilityReportLocation", "description": "Parameters that define a geographic location." }, "reachabilityReport": { "type": "array", "description": "List of Azure reachability report items.", "items": { "$ref": "#/definitions/AzureReachabilityReportItem" } } }, "required": [ "aggregationLevel", "providerLocation", "reachabilityReport" ], "description": "Azure reachability report details." }, "AzureReachabilityReportItem": { "properties": { "provider": { "type": "string", "description": "The Internet service provider." }, "azureLocation": { "type": "string", "description": "The Azure region." }, "latencies": { "type": "array", "description": "List of latency details for each of the time series.", "items": { "$ref": "#/definitions/AzureReachabilityReportLatencyInfo" } } }, "description": "Azure reachability report details for a given provider location." }, "AzureReachabilityReportLatencyInfo": { "properties": { "timeStamp": { "type": "string", "format": "date-time", "description": "The time stamp." }, "score": { "type": "integer", "description": "The relative latency score between 1 and 100, higher values indicating a faster connection.", "minimum": 1, "maximum": 100 } }, "description": "Details on latency for a time series." }, "AvailableProvidersListParameters": { "properties": { "azureLocations": { "type": "array", "items": { "type": "string" }, "description": "A list of Azure regions." }, "country": { "type": "string", "description": "The country for available providers list." }, "state": { "type": "string", "description": "The state for available providers list." }, "city": { "type": "string", "description": "The city or town for available providers list." } }, "description": "Constraints that determine the list of available Internet service providers." }, "AvailableProvidersList": { "properties": { "countries": { "type": "array", "description": "List of available countries.", "items": { "$ref": "#/definitions/AvailableProvidersListCountry" } } }, "required": [ "countries" ], "description": "List of available countries with details." }, "AvailableProvidersListCountry": { "properties": { "countryName": { "type": "string", "description": "The country name." }, "providers": { "type": "array", "items": { "type": "string" }, "description": "A list of Internet service providers." }, "states": { "type": "array", "description": "List of available states in the country.", "items": { "$ref": "#/definitions/AvailableProvidersListState" } } }, "description": "Country details." }, "AvailableProvidersListState": { "properties": { "stateName": { "type": "string", "description": "The state name." }, "providers": { "type": "array", "items": { "type": "string" }, "description": "A list of Internet service providers." }, "cities": { "type": "array", "description": "List of available cities or towns in the state.", "items": { "$ref": "#/definitions/AvailableProvidersListCity" } } }, "description": "State details." }, "AvailableProvidersListCity": { "properties": { "cityName": { "type": "string", "description": "The city or town name." }, "providers": { "type": "array", "items": { "type": "string" }, "description": "A list of Internet service providers." } }, "description": "City or town details." }, "NetworkConfigurationDiagnosticParameters": { "description": "Parameters to get network configuration diagnostic.", "required": [ "targetResourceId", "profiles" ], "properties": { "targetResourceId": { "type": "string", "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." }, "verbosityLevel": { "type": "string", "enum": [ "Normal", "Minimum", "Full" ], "x-ms-enum": { "name": "VerbosityLevel", "modelAsString": true }, "description": "Verbosity level." }, "profiles": { "type": "array", "description": "List of network configuration diagnostic profiles.", "items": { "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" } } } }, "NetworkConfigurationDiagnosticProfile": { "description": "Parameters to compare with network configuration.", "required": [ "direction", "protocol", "source", "destination", "destinationPort" ], "properties": { "direction": { "$ref": "#/definitions/Direction", "description": "The direction of the traffic." }, "protocol": { "type": "string", "description": "Protocol to be verified on. Accepted values are '', TCP, UDP." }, "source": { "type": "string", "description": "Traffic source. Accepted values are '', IP Address/CIDR, Service Tag." }, "destination": { "type": "string", "description": "Traffic destination. Accepted values are: '', IP Address/CIDR, Service Tag." }, "destinationPort": { "type": "string", "description": "Traffic destination port. Accepted values are '*' and a single port in the range (0 - 65535)." } } }, "NetworkConfigurationDiagnosticResponse": { "description": "Results of network configuration diagnostic on the target resource.", "properties": { "results": { "readOnly": true, "type": "array", "description": "List of network configuration diagnostic results.", "items": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResult" } } } }, "NetworkConfigurationDiagnosticResult": { "description": "Network configuration diagnostic result corresponded to provided traffic query.", "properties": { "profile": { "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile", "description": "Network configuration diagnostic profile." }, "networkSecurityGroupResult": { "$ref": "#/definitions/NetworkSecurityGroupResult", "description": "Network security group result." } } }, "NetworkSecurityGroupResult": { "description": "Network configuration diagnostic result corresponded provided traffic query.", "properties": { "securityRuleAccessResult": { "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", "description": "The network traffic is allowed or denied." }, "evaluatedNetworkSecurityGroups": { "readOnly": true, "type": "array", "description": "List of results network security groups diagnostic.", "items": { "$ref": "#/definitions/EvaluatedNetworkSecurityGroup" } } } }, "EvaluatedNetworkSecurityGroup": { "description": "Results of network security group evaluation.", "properties": { "networkSecurityGroupId": { "type": "string", "description": "Network security group ID." }, "appliedTo": { "type": "string", "description": "Resource ID of nic or subnet to which network security group is applied." }, "matchedRule": { "$ref": "#/definitions/MatchedRule", "description": "Matched network security rule." }, "rulesEvaluationResult": { "readOnly": true, "type": "array", "description": "List of network security rules evaluation results.", "items": { "$ref": "#/definitions/NetworkSecurityRulesEvaluationResult" } } } }, "MatchedRule": { "description": "Matched rule.", "properties": { "ruleName": { "type": "string", "description": "Name of the matched network security rule." }, "action": { "type": "string", "description": "The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'." } } }, "NetworkSecurityRulesEvaluationResult": { "description": "Network security rules evaluation result.", "properties": { "name": { "type": "string", "description": "Name of the network security rule." }, "protocolMatched": { "type": "boolean", "description": "Value indicating whether protocol is matched." }, "sourceMatched": { "type": "boolean", "description": "Value indicating whether source is matched." }, "sourcePortMatched": { "type": "boolean", "description": "Value indicating whether source port is matched." }, "destinationMatched": { "type": "boolean", "description": "Value indicating whether destination is matched." }, "destinationPortMatched": { "type": "boolean", "description": "Value indicating whether destination port is matched." } } }, "Direction": { "type": "string", "description": "The direction of the traffic.", "enum": [ "Inbound", "Outbound" ], "x-ms-enum": { "name": "Direction", "modelAsString": true } }, "ConnectionMonitor": { "properties": { "location": { "type": "string", "description": "Connection monitor location." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Connection monitor tags." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ConnectionMonitorParameters", "description": "Properties of the connection monitor." } }, "required": [ "properties" ], "description": "Parameters that define the operation to create a connection monitor." }, "ConnectionMonitorParameters": { "properties": { "source": { "$ref": "#/definitions/ConnectionMonitorSource", "description": "Describes the source of connection monitor." }, "destination": { "$ref": "#/definitions/ConnectionMonitorDestination", "description": "Describes the destination of connection monitor." }, "autoStart": { "type": "boolean", "default": true, "description": "Determines if the connection monitor will start automatically once created." }, "monitoringIntervalInSeconds": { "type": "integer", "default": 60, "description": "Monitoring interval in seconds." }, "endpoints": { "type": "array", "description": "List of connection monitor endpoints.", "items": { "$ref": "#/definitions/ConnectionMonitorEndpoint" } }, "testConfigurations": { "type": "array", "description": "List of connection monitor test configurations.", "items": { "$ref": "#/definitions/ConnectionMonitorTestConfiguration" } }, "testGroups": { "type": "array", "description": "List of connection monitor test groups.", "items": { "$ref": "#/definitions/ConnectionMonitorTestGroup" } }, "outputs": { "type": "array", "description": "List of connection monitor outputs.", "items": { "$ref": "#/definitions/ConnectionMonitorOutput" } }, "notes": { "type": "string", "description": "Optional notes to be associated with the connection monitor." } }, "description": "Parameters that define the operation to create a connection monitor." }, "ConnectionMonitorSource": { "properties": { "resourceId": { "type": "string", "description": "The ID of the resource used as the source by connection monitor." }, "port": { "type": "integer", "description": "The source port used by connection monitor." } }, "required": [ "resourceId" ], "description": "Describes the source of connection monitor." }, "ConnectionMonitorDestination": { "properties": { "resourceId": { "type": "string", "description": "The ID of the resource used as the destination by connection monitor." }, "address": { "type": "string", "description": "Address of the connection monitor destination (IP or domain name)." }, "port": { "type": "integer", "description": "The destination port used by connection monitor." } }, "description": "Describes the destination of connection monitor." }, "ConnectionMonitorEndpoint": { "properties": { "name": { "type": "string", "description": "The name of the connection monitor endpoint." }, "resourceId": { "type": "string", "description": "Resource ID of the connection monitor endpoint." }, "address": { "type": "string", "description": "Address of the connection monitor endpoint (IP or domain name)." }, "filter": { "$ref": "#/definitions/ConnectionMonitorEndpointFilter", "description": "Filter for sub-items within the endpoint." } }, "required": [ "name" ], "description": "Describes the connection monitor endpoint." }, "ConnectionMonitorEndpointFilter": { "properties": { "type": { "type": "string", "enum": [ "Include" ], "x-ms-enum": { "name": "ConnectionMonitorEndpointFilterType", "modelAsString": true }, "description": "The behavior of the endpoint filter. Currently only 'Include' is supported." }, "items": { "type": "array", "description": "List of items in the filter.", "items": { "$ref": "#/definitions/ConnectionMonitorEndpointFilterItem" } } }, "description": "Describes the connection monitor endpoint filter." }, "ConnectionMonitorEndpointFilterItem": { "properties": { "type": { "type": "string", "enum": [ "AgentAddress" ], "x-ms-enum": { "name": "ConnectionMonitorEndpointFilterItemType", "modelAsString": true }, "description": "The type of item included in the filter. Currently only 'AgentAddress' is supported." }, "address": { "type": "string", "description": "The address of the filter item." } }, "description": "Describes the connection monitor endpoint filter item." }, "ConnectionMonitorTestGroup": { "properties": { "name": { "type": "string", "description": "The name of the connection monitor test group." }, "disable": { "type": "boolean", "description": "Value indicating whether test group is disabled." }, "testConfigurations": { "type": "array", "items": { "type": "string" }, "description": "List of test configuration names." }, "sources": { "type": "array", "items": { "type": "string" }, "description": "List of source endpoint names." }, "destinations": { "type": "array", "items": { "type": "string" }, "description": "List of destination endpoint names." } }, "required": [ "name", "testConfigurations", "sources", "destinations" ], "description": "Describes the connection monitor test group." }, "ConnectionMonitorTestConfiguration": { "properties": { "name": { "type": "string", "description": "The name of the connection monitor test configuration." }, "testFrequencySec": { "type": "integer", "description": "The frequency of test evaluation, in seconds." }, "protocol": { "type": "string", "enum": [ "Tcp", "Http", "Icmp" ], "x-ms-enum": { "name": "ConnectionMonitorTestConfigurationProtocol", "modelAsString": true }, "description": "The protocol to use in test evaluation." }, "preferredIPVersion": { "type": "string", "enum": [ "IPv4", "IPv6" ], "x-ms-enum": { "name": "PreferredIPVersion", "modelAsString": true }, "description": "The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters." }, "httpConfiguration": { "$ref": "#/definitions/ConnectionMonitorHttpConfiguration", "description": "The parameters used to perform test evaluation over HTTP." }, "tcpConfiguration": { "$ref": "#/definitions/ConnectionMonitorTcpConfiguration", "description": "The parameters used to perform test evaluation over TCP." }, "icmpConfiguration": { "$ref": "#/definitions/ConnectionMonitorIcmpConfiguration", "description": "The parameters used to perform test evaluation over ICMP." }, "successThreshold": { "$ref": "#/definitions/ConnectionMonitorSuccessThreshold", "description": "The threshold for declaring a test successful." } }, "required": [ "name", "protocol" ], "description": "Describes a connection monitor test configuration." }, "ConnectionMonitorHttpConfiguration": { "properties": { "port": { "type": "integer", "description": "The port to connect to." }, "method": { "type": "string", "description": "The HTTP method to use.", "enum": [ "Get", "Post" ], "x-ms-enum": { "name": "HTTPConfigurationMethod", "modelAsString": true } }, "path": { "type": "string", "description": "The path component of the URI. For instance, \"/dir1/dir2\"." }, "requestHeaders": { "type": "array", "description": "The HTTP headers to transmit with the request.", "items": { "$ref": "#/definitions/HTTPHeader" } }, "validStatusCodeRanges": { "type": "array", "items": { "type": "string" }, "description": "HTTP status codes to consider successful. For instance, \"2xx,301-304,418\"." }, "preferHTTPS": { "type": "boolean", "description": "Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit." } }, "description": "Describes the HTTP configuration." }, "ConnectionMonitorTcpConfiguration": { "properties": { "port": { "type": "integer", "description": "The port to connect to." }, "disableTraceRoute": { "type": "boolean", "description": "Value indicating whether path evaluation with trace route should be disabled." } }, "description": "Describes the TCP configuration." }, "ConnectionMonitorIcmpConfiguration": { "properties": { "disableTraceRoute": { "type": "boolean", "description": "Value indicating whether path evaluation with trace route should be disabled." } }, "description": "Describes the ICMP configuration." }, "ConnectionMonitorSuccessThreshold": { "properties": { "checksFailedPercent": { "type": "integer", "description": "The maximum percentage of failed checks permitted for a test to evaluate as successful." }, "roundTripTimeMs": { "type": "number", "description": "The maximum round-trip time in milliseconds permitted for a test to evaluate as successful." } }, "description": "Describes the threshold for declaring a test successful." }, "ConnectionMonitorOutput": { "properties": { "type": { "type": "string", "description": "Connection monitor output destination type. Currently, only \"Workspace\" is supported.", "enum": [ "Workspace" ], "x-ms-enum": { "name": "OutputType", "modelAsString": true } }, "workspaceSettings": { "$ref": "#/definitions/ConnectionMonitorWorkspaceSettings", "description": "Describes the settings for producing output into a log analytics workspace." } }, "description": "Describes a connection monitor output destination." }, "ConnectionMonitorWorkspaceSettings": { "properties": { "workspaceResourceId": { "type": "string", "description": "Log analytics workspace resource ID." } }, "description": "Describes the settings for producing output into a log analytics workspace." }, "ConnectionStateSnapshot": { "properties": { "connectionState": { "type": "string", "enum": [ "Reachable", "Unreachable", "Unknown" ], "x-ms-enum": { "name": "ConnectionState", "modelAsString": true }, "description": "The connection state." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the connection snapshot." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the connection snapshot." }, "evaluationState": { "type": "string", "enum": [ "NotStarted", "InProgress", "Completed" ], "x-ms-enum": { "name": "EvaluationState", "modelAsString": true }, "description": "Connectivity analysis evaluation state." }, "avgLatencyInMs": { "type": "integer", "description": "Average latency in ms." }, "minLatencyInMs": { "type": "integer", "description": "Minimum latency in ms." }, "maxLatencyInMs": { "type": "integer", "description": "Maximum latency in ms." }, "probesSent": { "type": "integer", "description": "The number of sent probes." }, "probesFailed": { "type": "integer", "description": "The number of failed probes." }, "hops": { "readOnly": true, "type": "array", "description": "List of hops between the source and the destination.", "items": { "$ref": "./networkWatcher.json#/definitions/ConnectivityHop" } } }, "description": "Connection state snapshot." }, "ConnectionMonitorListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ConnectionMonitorResult" }, "description": "Information about connection monitors." } }, "description": "List of connection monitors." }, "ConnectionMonitorResult": { "x-ms-azure-resource": true, "properties": { "name": { "readOnly": true, "type": "string", "description": "Name of the connection monitor." }, "id": { "readOnly": true, "type": "string", "description": "ID of the connection monitor." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Connection monitor type." }, "location": { "type": "string", "description": "Connection monitor location." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Connection monitor tags." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ConnectionMonitorResultProperties", "description": "Properties of the connection monitor result." } }, "description": "Information about the connection monitor." }, "ConnectionMonitorResultProperties": { "properties": { "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the connection monitor." }, "startTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "The date and time when the connection monitor was started." }, "monitoringStatus": { "readOnly": true, "type": "string", "description": "The monitoring status of the connection monitor." }, "connectionMonitorType": { "readOnly": true, "type": "string", "enum": [ "MultiEndpoint", "SingleSourceDestination" ], "x-ms-enum": { "name": "ConnectionMonitorType", "modelAsString": true }, "description": "Type of connection monitor." } }, "allOf": [ { "$ref": "#/definitions/ConnectionMonitorParameters" } ], "description": "Describes the properties of a connection monitor." }, "ConnectionMonitorQueryResult": { "properties": { "sourceStatus": { "type": "string", "enum": [ "Unknown", "Active", "Inactive" ], "x-ms-enum": { "name": "ConnectionMonitorSourceStatus", "modelAsString": true }, "description": "Status of connection monitor source." }, "states": { "type": "array", "items": { "$ref": "#/definitions/ConnectionStateSnapshot" }, "description": "Information about connection states." } }, "description": "List of connection states snapshots." } } }	142.6 KB	2025-05-25 12:27
📄 privateEndpoint.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}": { "delete": { "tags": [ "PrivateEndpoints" ], "operationId": "PrivateEndpoints_Delete", "description": "Deletes the specified private endpoint.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "privateEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Delete successful." }, "200": { "description": "Delete successful." }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Delete private endpoint": { "$ref": "./examples/PrivateEndpointDelete.json" } } }, "get": { "tags": [ "PrivateEndpoints" ], "operationId": "PrivateEndpoints_Get", "description": "Gets the specified private endpoint by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "privateEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting private endpoint resource.", "schema": { "$ref": "#/definitions/PrivateEndpoint" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "Get private endpoint": { "$ref": "./examples/PrivateEndpointGet.json" }, "Get private endpoint with manual approval connection": { "$ref": "./examples/PrivateEndpointGetForManualApproval.json" } } }, "put": { "tags": [ "PrivateEndpoints" ], "operationId": "PrivateEndpoints_CreateOrUpdate", "description": "Creates or updates an private endpoint in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "privateEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpoint" }, "description": "Parameters supplied to the create or update private endpoint operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting private endpoint resource.", "schema": { "$ref": "#/definitions/PrivateEndpoint" } }, "201": { "description": "Create successful. The operation returns the resulting private endpoint resource.", "schema": { "$ref": "#/definitions/PrivateEndpoint" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Create private endpoint": { "$ref": "./examples/PrivateEndpointCreate.json" }, "Create private endpoint with manual approval connection": { "$ref": "./examples/PrivateEndpointCreateForManualApproval.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints": { "get": { "tags": [ "PrivateEndpoints" ], "operationId": "PrivateEndpoints_List", "description": "Gets all private endpoints in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of private endpoint resources.", "schema": { "$ref": "#/definitions/PrivateEndpointListResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "List private endpoints in resource group": { "$ref": "./examples/PrivateEndpointList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateEndpoints": { "get": { "tags": [ "PrivateEndpoints" ], "operationId": "PrivateEndpoints_ListBySubscription", "description": "Gets all private endpoints in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of private endpoint resources.", "schema": { "$ref": "#/definitions/PrivateEndpointListResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "List all private endpoints": { "$ref": "./examples/PrivateEndpointListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { "get": { "operationId": "AvailablePrivateEndpointTypes_List", "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location of the domain name." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", "schema": { "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get available PrivateEndpoint types": { "$ref": "./examples/AvailablePrivateEndpointTypesGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { "get": { "operationId": "AvailablePrivateEndpointTypes_ListByResourceGroup", "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location of the domain name." }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", "schema": { "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get available PrivateEndpoint types in the resource group": { "$ref": "./examples/AvailablePrivateEndpointTypesResourceGroupGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}": { "delete": { "tags": [ "PrivateDnsZoneGroups" ], "operationId": "PrivateDnsZoneGroups_Delete", "description": "Deletes the specified private dns zone group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "privateEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint." }, { "name": "privateDnsZoneGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the private dns zone group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Request successful. Resource does not exist." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Delete private dns zone group": { "$ref": "./examples/PrivateEndpointDnsZoneGroupDelete.json" } } }, "get": { "tags": [ "PrivateDnsZoneGroups" ], "operationId": "PrivateDnsZoneGroups_Get", "description": "Gets the private dns zone group resource by specified private dns zone group name.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "privateEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint." }, { "name": "privateDnsZoneGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the private dns zone group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting privateDnsZoneGroup resource.", "schema": { "$ref": "#/definitions/PrivateDnsZoneGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get private dns zone group": { "$ref": "./examples/PrivateEndpointDnsZoneGroupGet.json" } } }, "put": { "tags": [ "PrivateDnsZoneGroups" ], "operationId": "PrivateDnsZoneGroups_CreateOrUpdate", "description": "Creates or updates a private dns zone group in the specified private endpoint.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "privateEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint." }, { "name": "privateDnsZoneGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the private dns zone group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrivateDnsZoneGroup" }, "description": "Parameters supplied to the create or update private dns zone group operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting PrivateDnsZoneGroup resource.", "schema": { "$ref": "#/definitions/PrivateDnsZoneGroup" } }, "201": { "description": "Create successful. The operation returns the resulting PrivateDnsZoneGroup resource.", "schema": { "$ref": "#/definitions/PrivateDnsZoneGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Create private dns zone group": { "$ref": "./examples/PrivateEndpointDnsZoneGroupCreate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups": { "get": { "tags": [ "PrivateDnsZoneGroups" ], "operationId": "PrivateDnsZoneGroups_List", "description": "Gets all private dns zone groups in a private endpoint.", "parameters": [ { "name": "privateEndpointName", "in": "path", "required": true, "type": "string", "description": "The name of the private endpoint." }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of private dns zone group resources.", "schema": { "$ref": "#/definitions/PrivateDnsZoneGroupListResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "List private endpoints in resource group": { "$ref": "./examples/PrivateEndpointDnsZoneGroupList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "PrivateEndpoint": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateEndpointProperties", "description": "Properties of the private endpoint." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Private endpoint resource." }, "PrivateEndpointProperties": { "properties": { "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", "description": "The ID of the subnet from which the private IP will be allocated." }, "networkInterfaces": { "type": "array", "readOnly": true, "items": { "$ref": "./networkInterface.json#/definitions/NetworkInterface" }, "description": "An array of references to the network interfaces created for this private endpoint." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the private endpoint resource." }, "privateLinkServiceConnections": { "type": "array", "items": { "$ref": "#/definitions/PrivateLinkServiceConnection" }, "description": "A grouping of information about the connection to the remote resource." }, "manualPrivateLinkServiceConnections": { "type": "array", "items": { "$ref": "#/definitions/PrivateLinkServiceConnection" }, "description": "A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource." }, "customDnsConfigs": { "type": "array", "items": { "$ref": "#/definitions/CustomDnsConfigPropertiesFormat" }, "description": "An array of custom dns configurations." } }, "description": "Properties of the private endpoint." }, "CustomDnsConfigPropertiesFormat": { "properties": { "fqdn": { "type": "string", "description": "Fqdn that resolves to private endpoint ip address." }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "A list of private ip addresses of the private endpoint." } }, "description": "Contains custom Dns resolution configuration from customer." }, "PrivateLinkServiceConnection": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateLinkServiceConnectionProperties", "description": "Properties of the private link service connection." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "type": { "readOnly": true, "type": "string", "description": "The resource type." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "PrivateLinkServiceConnection resource." }, "PrivateLinkServiceConnectionProperties": { "properties": { "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the private link service connection resource." }, "privateLinkServiceId": { "type": "string", "description": "The resource id of private link service." }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to." }, "requestMessage": { "type": "string", "description": "A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars." }, "privateLinkServiceConnectionState": { "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of read-only information about the state of the connection to the remote resource." } }, "description": "Properties of the PrivateLinkServiceConnection." }, "PrivateEndpointListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PrivateEndpoint" }, "description": "A list of private endpoint resources in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results.", "readOnly": true } }, "description": "Response for the ListPrivateEndpoints API service call." }, "PrivateDnsZoneGroupListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PrivateDnsZoneGroup" }, "description": "A list of private dns zone group resources in a private endpoint." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results.", "readOnly": true } }, "description": "Response for the ListPrivateDnsZoneGroups API service call." }, "AvailablePrivateEndpointTypesResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AvailablePrivateEndpointType" }, "description": "An array of available privateEndpoint type." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "An array of available PrivateEndpoint types." }, "AvailablePrivateEndpointType": { "properties": { "name": { "type": "string", "description": "The name of the service and resource." }, "id": { "type": "string", "description": "A unique identifier of the AvailablePrivateEndpoint Type resource." }, "type": { "type": "string", "description": "Resource type." }, "resourceName": { "type": "string", "description": "The name of the service and resource." } }, "description": "The information of an AvailablePrivateEndpointType." }, "PrivateDnsZoneGroup": { "properties": { "name": { "type": "string", "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateDnsZoneGroupPropertiesFormat", "description": "Properties of the private dns zone group." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Private dns zone group resource." }, "PrivateDnsZoneGroupPropertiesFormat": { "properties": { "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the private dns zone group resource." }, "privateDnsZoneConfigs": { "type": "array", "items": { "$ref": "#/definitions/PrivateDnsZoneConfig" }, "description": "A collection of private dns zone configurations of the private dns zone group." } }, "description": "Properties of the private dns zone group." }, "PrivateDnsZoneConfig": { "properties": { "name": { "type": "string", "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateDnsZonePropertiesFormat", "description": "Properties of the private dns zone configuration." } }, "description": "PrivateDnsZoneConfig resource." }, "PrivateDnsZonePropertiesFormat": { "properties": { "privateDnsZoneId": { "type": "string", "description": "The resource id of the private dns zone." }, "recordSets": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/RecordSet" }, "description": "A collection of information regarding a recordSet, holding information to identify private resources." } }, "description": "Properties of the private dns zone configuration resource." }, "RecordSet": { "properties": { "recordType": { "type": "string", "description": "Resource record type." }, "recordSetName": { "type": "string", "description": "Recordset name." }, "fqdn": { "type": "string", "description": "Fqdn that resolves to private endpoint ip address." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the recordset." }, "ttl": { "type": "integer", "description": "Recordset time to live." }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "The private ip address of the private endpoint." } }, "description": "A collective group of information about the record set information." } } }	31.53 KB	2025-05-25 12:27
📄 privateLinkService.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}": { "delete": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_Delete", "description": "Deletes the specified private link service.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceName", "in": "path", "required": true, "type": "string", "description": "The name of the private link service." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Delete successful." }, "200": { "description": "Delete successful." }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Delete private link service": { "$ref": "./examples/PrivateLinkServiceDelete.json" } } }, "get": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_Get", "description": "Gets the specified private link service by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceName", "in": "path", "required": true, "type": "string", "description": "The name of the private link service." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting PrivateLinkService resource.", "schema": { "$ref": "#/definitions/PrivateLinkService" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "Get private link service": { "$ref": "./examples/PrivateLinkServiceGet.json" } } }, "put": { "tags": [ "PrivateLinkService" ], "operationId": "PrivateLinkServices_CreateOrUpdate", "description": "Creates or updates an private link service in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceName", "in": "path", "required": true, "type": "string", "description": "The name of the private link service." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrivateLinkService" }, "description": "Parameters supplied to the create or update private link service operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting privateLinkService resource.", "schema": { "$ref": "#/definitions/PrivateLinkService" } }, "201": { "description": "Create successful. The operation returns the resulting privateLinkService resource.", "schema": { "$ref": "#/definitions/PrivateLinkService" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Create private link service": { "$ref": "./examples/PrivateLinkServiceCreate.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices": { "get": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_List", "description": "Gets all private link services in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of privateLinkService resources.", "schema": { "$ref": "#/definitions/PrivateLinkServiceListResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "List private link service in resource group": { "$ref": "./examples/PrivateLinkServiceList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices": { "get": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_ListBySubscription", "description": "Gets all private link service in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of PrivateLinkService resources.", "schema": { "$ref": "#/definitions/PrivateLinkServiceListResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "List all private list service": { "$ref": "./examples/PrivateLinkServiceListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}": { "get": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_GetPrivateEndpointConnection", "description": "Get the specific private end point connection by specific private link service in the resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceName", "in": "path", "required": true, "type": "string", "description": "The name of the private link service." }, { "name": "peConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the private end point connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting private end point connection resource.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "Get private end point connection": { "$ref": "./examples/PrivateLinkServiceGetPrivateEndpointConnection.json" } } }, "put": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_UpdatePrivateEndpointConnection", "description": "Approve or reject private end point connection for a private link service in a subscription.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceName", "in": "path", "required": true, "type": "string", "description": "The name of the private link service." }, { "name": "peConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the private end point connection." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" }, "description": "Parameters supplied to approve or reject the private end point connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting PrivateEndpointConnection resource.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "approve or reject private end point connection for a private link service": { "$ref": "./examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json" } } }, "delete": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_DeletePrivateEndpointConnection", "description": "Delete private end point connection for a private link service in a subscription.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceName", "in": "path", "required": true, "type": "string", "description": "The name of the private link service." }, { "name": "peConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the private end point connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Delete successful." }, "200": { "description": "Delete successful." }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "delete private end point connection for a private link service": { "$ref": "./examples/PrivateLinkServiceDeletePrivateEndpointConnection.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections": { "get": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_ListPrivateEndpointConnections", "description": "Gets all private end point connections for a specific private link service.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceName", "in": "path", "required": true, "type": "string", "description": "The name of the private link service." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of private end point connection resources.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-examples": { "List private link service in resource group": { "$ref": "./examples/PrivateLinkServiceListPrivateEndpointConnection.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { "post": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibility", "description": "Checks whether the subscription is visible to private link service.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location of the domain name." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" }, "description": "The request body of CheckPrivateLinkService API call." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. Returns whether the subscription is visible to private link service.", "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { "post": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibilityByResourceGroup", "description": "Checks whether the subscription is visible to private link service in the specified resource group.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location of the domain name." }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" }, "description": "The request body of CheckPrivateLinkService API call." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. Returns whether the subscription is visible to private link service.", "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { "get": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServices", "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location of the domain name." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", "schema": { "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get list of private link service id that can be linked to a private end point with auto approved": { "$ref": "./examples/AutoApprovedPrivateLinkServicesGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { "get": { "tags": [ "PrivateLinkServices" ], "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServicesByResourceGroup", "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location of the domain name." }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", "schema": { "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get list of private link service id that can be linked to a private end point with auto approved": { "$ref": "./examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "PrivateLinkService": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateLinkServiceProperties", "description": "Properties of the private link service." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Private link service resource." }, "PrivateLinkServiceProperties": { "properties": { "loadBalancerFrontendIpConfigurations": { "type": "array", "items": { "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration" }, "description": "An array of references to the load balancer IP configurations." }, "ipConfigurations": { "type": "array", "items": { "$ref": "#/definitions/PrivateLinkServiceIpConfiguration" }, "description": "An array of private link service IP configurations." }, "networkInterfaces": { "type": "array", "readOnly": true, "items": { "$ref": "./networkInterface.json#/definitions/NetworkInterface" }, "description": "An array of references to the network interfaces created for this private link service." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the private link service resource." }, "privateEndpointConnections": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, "description": "An array of list about connections to the private endpoint." }, "visibility": { "allOf": [ { "$ref": "#/definitions/ResourceSet" } ], "description": "The visibility list of the private link service." }, "autoApproval": { "allOf": [ { "$ref": "#/definitions/ResourceSet" } ], "description": "The auto-approval list of the private link service." }, "fqdns": { "type": "array", "items": { "type": "string" }, "description": "The list of Fqdn." }, "alias": { "readOnly": true, "type": "string", "description": "The alias of the private link service." }, "enableProxyProtocol": { "type": "boolean", "description": "Whether the private link service is enabled for proxy protocol or not." } }, "description": "Properties of the private link service." }, "ResourceSet": { "properties": { "subscriptions": { "type": "array", "items": { "type": "string" }, "description": "The list of subscriptions." } }, "description": "The base resource set for visibility and auto-approval." }, "PrivateLinkServiceIpConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateLinkServiceIpConfigurationProperties", "description": "Properties of the private link service ip configuration." }, "name": { "type": "string", "description": "The name of private link service ip configuration." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "The resource type." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "The private link service ip configuration." }, "PrivateLinkServiceIpConfigurationProperties": { "properties": { "privateIPAddress": { "type": "string", "description": "The private IP address of the IP configuration." }, "privateIPAllocationMethod": { "$ref": "./network.json#/definitions/IPAllocationMethod", "description": "The private IP address allocation method." }, "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", "description": "The reference to the subnet resource." }, "primary": { "type": "boolean", "description": "Whether the ip configuration is primary or not." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the private link service IP configuration resource." }, "privateIPAddressVersion": { "$ref": "./network.json#/definitions/IPVersion", "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." } }, "description": "Properties of private link service IP configuration." }, "PrivateEndpointConnection": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Properties of the private end point connection." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "type": { "readOnly": true, "type": "string", "description": "The resource type." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "PrivateEndpointConnection resource." }, "PrivateEndpointConnectionProperties": { "properties": { "privateEndpoint": { "readOnly": true, "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", "description": "The resource of private end point." }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the private endpoint connection resource." }, "linkIdentifier": { "readOnly": true, "type": "string", "description": "The consumer link id." } }, "description": "Properties of the PrivateEndpointConnectProperties." }, "PrivateLinkServiceConnectionState": { "properties": { "status": { "type": "string", "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." } }, "description": "A collection of information about the state of the connection between service consumer and provider." }, "PrivateLinkServiceListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PrivateLinkService" }, "description": "A list of PrivateLinkService resources in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results.", "readOnly": true } }, "description": "Response for the ListPrivateLinkService API service call." }, "PrivateEndpointConnectionListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, "description": "A list of PrivateEndpointConnection resources for a specific private link service." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results.", "readOnly": true } }, "description": "Response for the ListPrivateEndpointConnection API service call." }, "CheckPrivateLinkServiceVisibilityRequest": { "properties": { "privateLinkServiceAlias": { "type": "string", "description": "The alias of the private link service." } }, "description": "Request body of the CheckPrivateLinkServiceVisibility API service call." }, "PrivateLinkServiceVisibility": { "properties": { "visible": { "type": "boolean", "description": "Private Link Service Visibility (True/False)." } }, "description": "Response for the CheckPrivateLinkServiceVisibility API service call." }, "AutoApprovedPrivateLinkServicesResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/AutoApprovedPrivateLinkService" }, "description": "An array of auto approved private link service." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "An array of private link service id that can be linked to a private end point with auto approved." }, "AutoApprovedPrivateLinkService": { "properties": { "privateLinkService": { "type": "string", "description": "The id of the private link service resource." } }, "description": "The information of an AutoApprovedPrivateLinkService." } } }	35.96 KB	2025-05-25 12:27
📄 publicIpAddress.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}": { "delete": { "tags": [ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_Delete", "description": "Deletes the specified public IP address.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "publicIpAddressName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete public IP address": { "$ref": "./examples/PublicIpAddressDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_Get", "description": "Gets the specified public IP address in a specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "publicIpAddressName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", "schema": { "$ref": "#/definitions/PublicIPAddress" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get public IP address": { "$ref": "./examples/PublicIpAddressGet.json" } } }, "put": { "tags": [ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_CreateOrUpdate", "description": "Creates or updates a static or dynamic public IP address.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "publicIpAddressName", "in": "path", "required": true, "type": "string", "description": "The name of the public IP address." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PublicIPAddress" }, "description": "Parameters supplied to the create or update public IP address operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting PublicIPAddress resource.", "schema": { "$ref": "#/definitions/PublicIPAddress" } }, "200": { "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", "schema": { "$ref": "#/definitions/PublicIPAddress" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create public IP address defaults": { "$ref": "./examples/PublicIpAddressCreateDefaults.json" }, "Create public IP address allocation method": { "$ref": "./examples/PublicIpAddressCreateCustomizedValues.json" }, "Create public IP address DNS": { "$ref": "./examples/PublicIpAddressCreateDns.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_UpdateTags", "description": "Updates public IP address tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "publicIpAddressName", "in": "path", "required": true, "type": "string", "description": "The name of the public IP address." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update public IP address tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", "schema": { "$ref": "#/definitions/PublicIPAddress" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update public IP address tags": { "$ref": "./examples/PublicIpAddressUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses": { "get": { "tags": [ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_ListAll", "description": "Gets all the public IP addresses in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of PublicIPAddress resources.", "schema": { "$ref": "#/definitions/PublicIPAddressListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all public IP addresses": { "$ref": "./examples/PublicIpAddressListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses": { "get": { "tags": [ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_List", "description": "Gets all public IP addresses in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of PublicIPAddress resources.", "schema": { "$ref": "#/definitions/PublicIPAddressListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List resource group public IP addresses": { "$ref": "./examples/PublicIpAddressList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "PublicIPAddressSku": { "properties": { "name": { "type": "string", "description": "Name of a public IP address SKU.", "enum": [ "Basic", "Standard" ], "x-ms-enum": { "name": "PublicIPAddressSkuName", "modelAsString": true } } }, "description": "SKU of a public IP address." }, "PublicIPAddressPropertiesFormat": { "properties": { "publicIPAllocationMethod": { "$ref": "./network.json#/definitions/IPAllocationMethod", "description": "The public IP address allocation method." }, "publicIPAddressVersion": { "$ref": "./network.json#/definitions/IPVersion", "description": "The public IP address version." }, "ipConfiguration": { "readOnly": true, "$ref": "./networkInterface.json#/definitions/IPConfiguration", "description": "The IP configuration associated with the public IP address." }, "dnsSettings": { "$ref": "#/definitions/PublicIPAddressDnsSettings", "description": "The FQDN of the DNS record associated with the public IP address." }, "ddosSettings": { "$ref": "#/definitions/DdosSettings", "description": "The DDoS protection custom policy associated with the public IP address." }, "ipTags": { "type": "array", "items": { "$ref": "#/definitions/IpTag" }, "description": "The list of tags associated with the public IP address." }, "ipAddress": { "type": "string", "description": "The IP address associated with the public IP address resource." }, "publicIPPrefix": { "$ref": "./network.json#/definitions/SubResource", "description": "The Public IP Prefix this Public IP Address should be allocated from." }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", "description": "The idle timeout of the public IP address." }, "resourceGuid": { "readOnly": true, "type": "string", "description": "The resource GUID property of the public IP address resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the public IP address resource." } }, "description": "Public IP address properties." }, "PublicIPAddress": { "properties": { "sku": { "$ref": "#/definitions/PublicIPAddressSku", "description": "The public IP address SKU." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/PublicIPAddressPropertiesFormat", "description": "Public IP address properties." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "zones": { "type": "array", "items": { "type": "string" }, "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Public IP address resource." }, "PublicIPAddressListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/PublicIPAddress" }, "description": "A list of public IP addresses that exists in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListPublicIpAddresses API service call." }, "PublicIPAddressDnsSettings": { "properties": { "domainNameLabel": { "type": "string", "description": "The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system." }, "fqdn": { "type": "string", "description": "The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone." }, "reverseFqdn": { "type": "string", "description": "The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN." } }, "description": "Contains FQDN of the DNS record associated with the public IP address." }, "DdosSettings": { "properties": { "ddosCustomPolicy": { "readOnly": false, "$ref": "./network.json#/definitions/SubResource", "description": "The DDoS custom policy associated with the public IP." }, "protectionCoverage": { "readOnly": false, "type": "string", "enum": [ "Basic", "Standard" ], "x-ms-enum": { "name": "DdosSettingsProtectionCoverage", "modelAsString": true }, "description": "The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized." }, "protectedIP": { "readOnly": false, "type": "boolean", "description": "Enables DDoS protection on the public IP." } }, "description": "Contains the DDoS protection settings of the public IP." }, "IpTag": { "properties": { "ipTagType": { "type": "string", "description": "The IP tag type. Example: FirstPartyUsage." }, "tag": { "type": "string", "description": "The value of the IP tag associated with the public IP. Example: SQL." } }, "description": "Contains the IpTag associated with the object." } } }	17.88 KB	2025-05-25 12:27
📄 routeTable.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}": { "delete": { "tags": [ "RouteTables" ], "operationId": "RouteTables_Delete", "description": "Deletes the specified route table.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "200": { "description": "Request successful. Operation to delete was accepted." }, "202": { "description": "Accepted. If route table not found returned synchronously, otherwise if found returned asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Delete route table": { "$ref": "./examples/RouteTableDelete.json" } } }, "get": { "tags": [ "RouteTables" ], "operationId": "RouteTables_Get", "description": "Gets the specified route table.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting RouteTable resource.", "schema": { "$ref": "#/definitions/RouteTable" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get route table": { "$ref": "./examples/RouteTableGet.json" } } }, "put": { "tags": [ "RouteTables" ], "operationId": "RouteTables_CreateOrUpdate", "description": "Create or updates a route table in a specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RouteTable" }, "description": "Parameters supplied to the create or update route table operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting RouteTable resource.", "schema": { "$ref": "#/definitions/RouteTable" } }, "201": { "description": "Create successful. The operation returns the resulting RouteTable resource.", "schema": { "$ref": "#/definitions/RouteTable" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create route table": { "$ref": "./examples/RouteTableCreate.json" }, "Create route table with route": { "$ref": "./examples/RouteTableCreateWithRoute.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "RouteTables" ], "operationId": "RouteTables_UpdateTags", "description": "Updates a route table tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update route table tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting RouteTable resource.", "schema": { "$ref": "#/definitions/RouteTable" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update route table tags": { "$ref": "./examples/RouteTableUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables": { "get": { "tags": [ "RouteTables" ], "operationId": "RouteTables_List", "description": "Gets all route tables in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of RouteTable resources.", "schema": { "$ref": "#/definitions/RouteTableListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List route tables in resource group": { "$ref": "./examples/RouteTableList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables": { "get": { "tags": [ "RouteTables" ], "operationId": "RouteTables_ListAll", "description": "Gets all route tables in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of RouteTable resources.", "schema": { "$ref": "#/definitions/RouteTableListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all route tables": { "$ref": "./examples/RouteTableListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}": { "delete": { "tags": [ "Routes" ], "operationId": "Routes_Delete", "description": "Deletes the specified route from a route table.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "name": "routeName", "in": "path", "required": true, "type": "string", "description": "The name of the route." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Accepted." }, "204": { "description": "Route was deleted or not found." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete route": { "$ref": "./examples/RouteTableRouteDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "Routes" ], "operationId": "Routes_Get", "description": "Gets the specified route from a route table.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "name": "routeName", "in": "path", "required": true, "type": "string", "description": "The name of the route." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting Route resource.", "schema": { "$ref": "#/definitions/Route" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get route": { "$ref": "./examples/RouteTableRouteGet.json" } } }, "put": { "tags": [ "Routes" ], "operationId": "Routes_CreateOrUpdate", "description": "Creates or updates a route in the specified route table.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "name": "routeName", "in": "path", "required": true, "type": "string", "description": "The name of the route." }, { "name": "routeParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Route" }, "description": "Parameters supplied to the create or update route operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting Route resource.", "schema": { "$ref": "#/definitions/Route" } }, "201": { "description": "Create successful. The operation returns the resulting Route resource.", "schema": { "$ref": "#/definitions/Route" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create route": { "$ref": "./examples/RouteTableRouteCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes": { "get": { "tags": [ "Routes" ], "operationId": "Routes_List", "description": "Gets all routes in a route table.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "routeTableName", "in": "path", "required": true, "type": "string", "description": "The name of the route table." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of Route resources.", "schema": { "$ref": "#/definitions/RouteListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List routes": { "$ref": "./examples/RouteTableRouteList.json" } } } } }, "definitions": { "RoutePropertiesFormat": { "properties": { "addressPrefix": { "type": "string", "description": "The destination CIDR to which the route applies." }, "nextHopType": { "$ref": "#/definitions/RouteNextHopType", "description": "The type of Azure hop the packet should be sent to." }, "nextHopIpAddress": { "type": "string", "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the route resource." } }, "required": [ "nextHopType" ], "description": "Route resource." }, "Route": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RoutePropertiesFormat", "description": "Properties of the route." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Route resource." }, "RouteTablePropertiesFormat": { "properties": { "routes": { "type": "array", "items": { "$ref": "#/definitions/Route" }, "description": "Collection of routes contained within a route table." }, "subnets": { "readOnly": true, "type": "array", "items": { "$ref": "./virtualNetwork.json#/definitions/Subnet" }, "description": "A collection of references to subnets." }, "disableBgpRoutePropagation": { "type": "boolean", "description": "Whether to disable the routes learned by BGP on that route table. True means disable." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the route table resource." } }, "description": "Route Table resource." }, "RouteTable": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RouteTablePropertiesFormat", "description": "Properties of the route table." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Route table resource." }, "RouteTableListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RouteTable" }, "description": "A list of route tables in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for the ListRouteTable API service call." }, "RouteListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Route" }, "description": "A list of routes in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for the ListRoute API service call." }, "RouteNextHopType": { "type": "string", "description": "The type of Azure hop the packet should be sent to.", "enum": [ "VirtualNetworkGateway", "VnetLocal", "Internet", "VirtualAppliance", "None" ], "x-ms-enum": { "name": "RouteNextHopType", "modelAsString": true } } } }	22.85 KB	2025-05-25 12:27
📄 serviceEndpointPolicy.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}": { "delete": { "tags": [ "ServiceEndpointPolicies" ], "operationId": "ServiceEndpointPolicies_Delete", "description": "Deletes the specified service endpoint policy.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "204": { "description": "Request successful. Resource does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "ServiceEndpointPolicies" ], "operationId": "ServiceEndpointPolicies_Get", "description": "Gets the specified service Endpoint Policies in a specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting ServiceEndpointPolicy resource.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get service endPoint Policy": { "$ref": "./examples/ServiceEndpointPolicyGet.json" } } }, "put": { "tags": [ "ServiceEndpointPolicies" ], "operationId": "ServiceEndpointPolicies_CreateOrUpdate", "description": "Creates or updates a service Endpoint Policies.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" }, "description": "Parameters supplied to the create or update service endpoint policy operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting ServiceEndpointPolicy resource.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "200": { "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyCreate.json" }, "Create service endpoint policy with definition": { "$ref": "./examples/ServiceEndpointPolicyCreateWithDefinition.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "ServiceEndpointPolicies" ], "operationId": "ServiceEndpointPolicies_UpdateTags", "description": "Updates tags of a service endpoint policy.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update service endpoint policy tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicy" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update service endpoint policy tags": { "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies": { "get": { "tags": [ "ServiceEndpointPolicies" ], "operationId": "ServiceEndpointPolicies_List", "description": "Gets all the service endpoint policies in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies": { "get": { "tags": [ "ServiceEndpointPolicies" ], "operationId": "ServiceEndpointPolicies_ListByResourceGroup", "description": "Gets all service endpoint Policies in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List resource group service endpoint policies": { "$ref": "./examples/ServiceEndpointPolicyList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}": { "delete": { "tags": [ "ServiceEndpointPolicyDefinitions" ], "operationId": "ServiceEndpointPolicyDefinitions_Delete", "description": "Deletes the specified ServiceEndpoint policy definitions.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the Service Endpoint Policy." }, { "name": "serviceEndpointPolicyDefinitionName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy definition." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete service endpoint policy definitions from service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "serviceEndpointPolicyDefinitions" ], "operationId": "ServiceEndpointPolicyDefinitions_Get", "description": "Get the specified service endpoint policy definitions from service endpoint policy.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy name." }, { "name": "serviceEndpointPolicyDefinitionName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy definition name." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get service endpoint definition in service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionGet.json" } } }, "put": { "tags": [ "serviceEndpointPolicyDefinitions" ], "operationId": "ServiceEndpointPolicyDefinitions_CreateOrUpdate", "description": "Creates or updates a service endpoint policy definition in the specified service endpoint policy.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy." }, { "name": "serviceEndpointPolicyDefinitionName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy definition name." }, { "name": "ServiceEndpointPolicyDefinitions", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" }, "description": "Parameters supplied to the create or update service endpoint policy operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" } }, "201": { "description": "Create successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create service endpoint policy definition": { "$ref": "./examples/ServiceEndpointPolicyDefinitionCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions": { "get": { "tags": [ "ServiceEndpointPolicyDefinitions" ], "operationId": "ServiceEndpointPolicyDefinitions_ListByResourceGroup", "description": "Gets all service endpoint policy definitions in a service end point policy.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "serviceEndpointPolicyName", "in": "path", "required": true, "type": "string", "description": "The name of the service endpoint policy name." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of ServiceEndpointPolicyDefinition resources.", "schema": { "$ref": "#/definitions/ServiceEndpointPolicyDefinitionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List service endpoint definitions in service end point policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "ServiceEndpointPolicyDefinitionPropertiesFormat": { "properties": { "description": { "type": "string", "description": "A description for this rule. Restricted to 140 chars." }, "service": { "type": "string", "description": "Service endpoint name." }, "serviceResources": { "type": "array", "items": { "type": "string" }, "description": "A list of service resources." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the service endpoint policy definition resource." } }, "description": "Service Endpoint policy definition resource." }, "ServiceEndpointPolicyDefinition": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ServiceEndpointPolicyDefinitionPropertiesFormat", "description": "Properties of the service endpoint policy definition." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Service Endpoint policy definitions." }, "ServiceEndpointPolicyDefinitionListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" }, "description": "The service endpoint policy definition in a service endpoint policy." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy." }, "ServiceEndpointPolicyPropertiesFormat": { "properties": { "serviceEndpointPolicyDefinitions": { "type": "array", "items": { "$ref": "#/definitions/ServiceEndpointPolicyDefinition" }, "description": "A collection of service endpoint policy definitions of the service endpoint policy." }, "subnets": { "readOnly": true, "type": "array", "items": { "$ref": "./virtualNetwork.json#/definitions/Subnet" }, "description": "A collection of references to subnets." }, "resourceGuid": { "type": "string", "readOnly": true, "description": "The resource GUID property of the service endpoint policy resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the service endpoint policy resource." } }, "description": "Service Endpoint Policy resource." }, "ServiceEndpointPolicy": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ServiceEndpointPolicyPropertiesFormat", "description": "Properties of the service end point policy." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Service End point policy resource." }, "ServiceEndpointPolicyListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ServiceEndpointPolicy" }, "description": "A list of ServiceEndpointPolicy resources." }, "nextLink": { "readOnly": true, "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListServiceEndpointPolicies API service call." } } }	24.82 KB	2025-05-25 12:27
📄 virtualNetwork.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}": { "delete": { "tags": [ "VirtualNetworks" ], "operationId": "VirtualNetworks_Delete", "description": "Deletes the specified virtual network.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Delete successful." }, "200": { "description": "Delete successful." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Delete virtual network": { "$ref": "./examples/VirtualNetworkDelete.json" } } }, "get": { "tags": [ "VirtualNetworks" ], "operationId": "VirtualNetworks_Get", "description": "Gets the specified virtual network by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting VirtualNetwork resource.", "schema": { "$ref": "#/definitions/VirtualNetwork" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get virtual network": { "$ref": "./examples/VirtualNetworkGet.json" }, "Get virtual network with a delegated subnet": { "$ref": "./examples/VirtualNetworkGetWithSubnetDelegation.json" }, "Get virtual network with service association links": { "$ref": "./examples/VirtualNetworkGetWithServiceAssociationLink.json" } } }, "put": { "tags": [ "VirtualNetworks" ], "operationId": "VirtualNetworks_CreateOrUpdate", "description": "Creates or updates a virtual network in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetwork" }, "description": "Parameters supplied to the create or update virtual network operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", "schema": { "$ref": "#/definitions/VirtualNetwork" } }, "201": { "description": "Create successful. The operation returns the resulting VirtualNetwork resource.", "schema": { "$ref": "#/definitions/VirtualNetwork" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Create virtual network": { "$ref": "./examples/VirtualNetworkCreate.json" }, "Create virtual network with subnet": { "$ref": "./examples/VirtualNetworkCreateSubnet.json" }, "Create virtual network with subnet containing address prefixes": { "$ref": "./examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json" }, "Create virtual network with Bgp Communities": { "$ref": "./examples/VirtualNetworkCreateWithBgpCommunities.json" }, "Create virtual network with service endpoints": { "$ref": "./examples/VirtualNetworkCreateServiceEndpoints.json" }, "Create virtual network with service endpoints and service endpoint policy": { "$ref": "./examples/VirtualNetworkCreateServiceEndpointPolicy.json" }, "Create virtual network with delegated subnets": { "$ref": "./examples/VirtualNetworkCreateSubnetWithDelegation.json" } } }, "patch": { "tags": [ "VirtualNetworks" ], "operationId": "VirtualNetworks_UpdateTags", "description": "Updates a virtual network tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update virtual network tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", "schema": { "$ref": "#/definitions/VirtualNetwork" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update virtual network tags": { "$ref": "./examples/VirtualNetworkUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks": { "get": { "tags": [ "VirtualNetworks" ], "operationId": "VirtualNetworks_ListAll", "description": "Gets all virtual networks in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of VirtualNetwork resources.", "schema": { "$ref": "#/definitions/VirtualNetworkListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all virtual networks": { "$ref": "./examples/VirtualNetworkListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks": { "get": { "tags": [ "VirtualNetworks" ], "operationId": "VirtualNetworks_List", "description": "Gets all virtual networks in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of VirtualNetwork resources.", "schema": { "$ref": "#/definitions/VirtualNetworkListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List virtual networks in resource group": { "$ref": "./examples/VirtualNetworkList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}": { "delete": { "tags": [ "Subnets" ], "operationId": "Subnets_Delete", "description": "Deletes the specified subnet.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "subnetName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Delete successful." }, "204": { "description": "Request successful. Resource does not exist." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete subnet": { "$ref": "./examples/SubnetDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "Subnets" ], "operationId": "Subnets_Get", "description": "Gets the specified subnet by virtual network and resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "subnetName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "Expands referenced resources." } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting Subnet resource.", "schema": { "$ref": "#/definitions/Subnet" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get subnet": { "$ref": "./examples/SubnetGet.json" }, "Get subnet with a delegation": { "$ref": "./examples/SubnetGetWithDelegation.json" } } }, "put": { "tags": [ "Subnets" ], "operationId": "Subnets_CreateOrUpdate", "description": "Creates or updates a subnet in the specified virtual network.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "subnetName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "name": "subnetParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Subnet" }, "description": "Parameters supplied to the create or update subnet operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting Subnet resource.", "schema": { "$ref": "#/definitions/Subnet" } }, "201": { "description": "Create successful. The operation returns the resulting Subnet resource.", "schema": { "$ref": "#/definitions/Subnet" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Create subnet": { "$ref": "./examples/SubnetCreate.json" }, "Create subnet with service endpoints": { "$ref": "./examples/SubnetCreateServiceEndpoint.json" }, "Create subnet with a delegation": { "$ref": "./examples/SubnetCreateWithDelegation.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/PrepareNetworkPolicies": { "post": { "operationId": "Subnets_PrepareNetworkPolicies", "description": "Prepares a subnet by applying network intent policies.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "subnetName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "name": "prepareNetworkPoliciesRequestParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrepareNetworkPoliciesRequest" }, "description": "Parameters supplied to prepare subnet by applying network intent policies." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Preparing subnet by applying network intent policies is successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Prepare Network Policies": { "$ref": "./examples/SubnetPrepareNetworkPolicies.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/UnprepareNetworkPolicies": { "post": { "operationId": "Subnets_UnprepareNetworkPolicies", "description": "Unprepares a subnet by removing network intent policies.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "subnetName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "name": "unprepareNetworkPoliciesRequestParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UnprepareNetworkPoliciesRequest" }, "description": "Parameters supplied to unprepare subnet to remove network intent policies." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Unpreparing subnet by removing network intent policies is successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "Unprepare Network Policies": { "$ref": "./examples/SubnetUnprepareNetworkPolicies.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ResourceNavigationLinks": { "get": { "operationId": "ResourceNavigationLinks_List", "description": "Gets a list of resource navigation links for a subnet.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "subnetName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of resource navigation links for the subnet.", "schema": { "$ref": "#/definitions/ResourceNavigationLinksListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Resource Navigation Links": { "$ref": "./examples/VirtualNetworkGetResourceNavigationLinks.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ServiceAssociationLinks": { "get": { "operationId": "ServiceAssociationLinks_List", "description": "Gets a list of service association links for a subnet.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "subnetName", "in": "path", "required": true, "type": "string", "description": "The name of the subnet." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of service association links for the subnet.", "schema": { "$ref": "#/definitions/ServiceAssociationLinksListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Service Association Links": { "$ref": "./examples/VirtualNetworkGetServiceAssociationLinks.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets": { "get": { "tags": [ "Subnets" ], "operationId": "Subnets_List", "description": "Gets all subnets in a virtual network.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of Subnet resources.", "schema": { "$ref": "#/definitions/SubnetListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List subnets": { "$ref": "./examples/SubnetList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}": { "delete": { "tags": [ "VirtualNetworkPeerings" ], "operationId": "VirtualNetworkPeerings_Delete", "description": "Deletes the specified virtual network peering.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "virtualNetworkPeeringName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network peering." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Delete successful." }, "204": { "description": "Delete successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete peering": { "$ref": "./examples/VirtualNetworkPeeringDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "VirtualNetworkPeerings" ], "operationId": "VirtualNetworkPeerings_Get", "description": "Gets the specified virtual network peering.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "virtualNetworkPeeringName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network peering." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting VirtualNetworkPeering resource.", "schema": { "$ref": "#/definitions/VirtualNetworkPeering" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get peering": { "$ref": "./examples/VirtualNetworkPeeringGet.json" } } }, "put": { "tags": [ "VirtualNetworkPeerings" ], "operationId": "VirtualNetworkPeerings_CreateOrUpdate", "description": "Creates or updates a peering in the specified virtual network.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "virtualNetworkPeeringName", "in": "path", "required": true, "type": "string", "description": "The name of the peering." }, { "name": "VirtualNetworkPeeringParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkPeering" }, "description": "Parameters supplied to the create or update virtual network peering operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting VirtualNetworkPeering resource.", "schema": { "$ref": "#/definitions/VirtualNetworkPeering" } }, "201": { "description": "Create successful. The operation returns the resulting VirtualNetworkPeering resource.", "schema": { "$ref": "#/definitions/VirtualNetworkPeering" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create peering": { "$ref": "./examples/VirtualNetworkPeeringCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings": { "get": { "tags": [ "VirtualNetworkPeerings" ], "operationId": "VirtualNetworkPeerings_List", "description": "Gets all virtual network peerings in a virtual network.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of VirtualNetworkPeering resources.", "schema": { "$ref": "#/definitions/VirtualNetworkPeeringListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List peerings": { "$ref": "./examples/VirtualNetworkPeeringList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability": { "get": { "operationId": "VirtualNetworks_CheckIPAddressAvailability", "description": "Checks whether a private IP address is available for use.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "name": "ipAddress", "in": "query", "required": true, "type": "string", "description": "The private IP address to be verified." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Private IP address availability and list of other free addresses if the requested one is not available.", "schema": { "$ref": "#/definitions/IPAddressAvailabilityResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Check IP address availability": { "$ref": "./examples/VirtualNetworkCheckIPAddressAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages": { "get": { "operationId": "VirtualNetworks_ListUsage", "description": "Lists usage stats.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Usage stats for vnet.", "schema": { "$ref": "#/definitions/VirtualNetworkListUsageResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "VnetGetUsage": { "$ref": "./examples/VirtualNetworkListUsage.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "ServiceAssociationLinkPropertiesFormat": { "properties": { "linkedResourceType": { "type": "string", "description": "Resource type of the linked resource." }, "link": { "type": "string", "description": "Link to the external resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the service association link resource." }, "allowDelete": { "type": "boolean", "description": "If true, the resource can be deleted." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "A list of locations." } }, "description": "Properties of ServiceAssociationLink." }, "ServiceAssociationLink": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ServiceAssociationLinkPropertiesFormat", "description": "Resource navigation link properties format." }, "name": { "type": "string", "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "ServiceAssociationLink resource." }, "ResourceNavigationLinkFormat": { "properties": { "linkedResourceType": { "type": "string", "description": "Resource type of the linked resource." }, "link": { "type": "string", "description": "Link to the external resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the resource navigation link resource." } }, "description": "Properties of ResourceNavigationLink." }, "ResourceNavigationLink": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ResourceNavigationLinkFormat", "description": "Resource navigation link properties format." }, "name": { "type": "string", "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." }, "id": { "type": "string", "readOnly": true, "description": "Resource navigation link identifier." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "ResourceNavigationLink resource." }, "ServiceDelegationPropertiesFormat": { "properties": { "serviceName": { "type": "string", "description": "The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)." }, "actions": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "The actions permitted to the service upon delegation." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the service delegation resource." } }, "description": "Properties of a service delegation." }, "Delegation": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ServiceDelegationPropertiesFormat", "description": "Properties of the subnet." }, "name": { "type": "string", "description": "The name of the resource that is unique within a subnet. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Details the service to which the subnet is delegated." }, "SubnetPropertiesFormat": { "properties": { "addressPrefix": { "type": "string", "description": "The address prefix for the subnet." }, "addressPrefixes": { "type": "array", "items": { "type": "string" }, "description": "List of address prefixes for the subnet." }, "networkSecurityGroup": { "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", "description": "The reference to the NetworkSecurityGroup resource." }, "routeTable": { "$ref": "./routeTable.json#/definitions/RouteTable", "description": "The reference to the RouteTable resource." }, "natGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "Nat gateway associated with this subnet." }, "serviceEndpoints": { "type": "array", "items": { "$ref": "#/definitions/ServiceEndpointPropertiesFormat" }, "description": "An array of service endpoints." }, "serviceEndpointPolicies": { "type": "array", "items": { "$ref": "./serviceEndpointPolicy.json#/definitions/ServiceEndpointPolicy" }, "description": "An array of service endpoint policies." }, "privateEndpoints": { "readOnly": true, "type": "array", "items": { "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint" }, "description": "An array of references to private endpoints." }, "ipConfigurations": { "readOnly": true, "type": "array", "items": { "$ref": "./networkInterface.json#/definitions/IPConfiguration" }, "description": "An array of references to the network interface IP configurations using subnet." }, "ipConfigurationProfiles": { "readOnly": true, "type": "array", "items": { "$ref": "./networkProfile.json#/definitions/IPConfigurationProfile" }, "description": "Array of IP configuration profiles which reference this subnet." }, "ipAllocations": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "Array of IpAllocation which reference this subnet." }, "resourceNavigationLinks": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/ResourceNavigationLink" }, "description": "An array of references to the external resources using subnet." }, "serviceAssociationLinks": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/ServiceAssociationLink" }, "description": "An array of references to services injecting into this subnet." }, "delegations": { "type": "array", "items": { "$ref": "#/definitions/Delegation" }, "description": "An array of references to the delegations on the subnet." }, "purpose": { "type": "string", "readOnly": true, "description": "A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the subnet resource." }, "privateEndpointNetworkPolicies": { "type": "string", "description": "Enable or Disable apply network policies on private end point in the subnet." }, "privateLinkServiceNetworkPolicies": { "type": "string", "description": "Enable or Disable apply network policies on private link service in the subnet." } }, "description": "Properties of the subnet." }, "ServiceEndpointPropertiesFormat": { "properties": { "service": { "type": "string", "description": "The type of the endpoint service." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "A list of locations." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the service endpoint resource." } }, "description": "The service endpoint properties." }, "VirtualNetworkPeeringPropertiesFormat": { "properties": { "allowVirtualNetworkAccess": { "type": "boolean", "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." }, "allowForwardedTraffic": { "type": "boolean", "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." }, "allowGatewayTransit": { "type": "boolean", "description": "If gateway links can be used in remote virtual networking to link to this virtual network." }, "useRemoteGateways": { "type": "boolean", "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." }, "remoteVirtualNetwork": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." }, "remoteAddressSpace": { "$ref": "#/definitions/AddressSpace", "description": "The reference to the remote virtual network address space." }, "peeringState": { "type": "string", "description": "The status of the virtual network peering.", "enum": [ "Initiated", "Connected", "Disconnected" ], "x-ms-enum": { "name": "VirtualNetworkPeeringState", "modelAsString": true } }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual network peering resource." } }, "description": "Properties of the virtual network peering." }, "Subnet": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SubnetPropertiesFormat", "description": "Properties of the subnet." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Subnet in a virtual network resource." }, "VirtualNetworkPeering": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", "description": "Properties of the virtual network peering." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Peerings in a virtual network resource." }, "SubnetListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Subnet" }, "description": "The subnets in a virtual network." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network." }, "ResourceNavigationLinksListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ResourceNavigationLink" }, "description": "The resource navigation links in a subnet." }, "nextLink": { "type": "string", "readOnly": true, "description": "The URL to get the next set of results." } }, "description": "Response for ResourceNavigationLinks_List operation." }, "ServiceAssociationLinksListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ServiceAssociationLink" }, "description": "The service association links in a subnet." }, "nextLink": { "type": "string", "readOnly": true, "description": "The URL to get the next set of results." } }, "description": "Response for ServiceAssociationLinks_List operation." }, "VirtualNetworkPeeringListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkPeering" }, "description": "The peerings in a virtual network." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network." }, "VirtualNetworkPropertiesFormat": { "properties": { "addressSpace": { "$ref": "#/definitions/AddressSpace", "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." }, "dhcpOptions": { "$ref": "#/definitions/DhcpOptions", "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." }, "subnets": { "type": "array", "items": { "$ref": "#/definitions/Subnet" }, "description": "A list of subnets in a Virtual Network." }, "virtualNetworkPeerings": { "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkPeering" }, "description": "A list of peerings in a Virtual Network." }, "resourceGuid": { "readOnly": true, "type": "string", "description": "The resourceGuid property of the Virtual Network resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual network resource." }, "enableDdosProtection": { "type": "boolean", "default": false, "description": "Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource." }, "enableVmProtection": { "type": "boolean", "default": false, "description": "Indicates if VM protection is enabled for all the subnets in the virtual network." }, "ddosProtectionPlan": { "$ref": "./network.json#/definitions/SubResource", "default": null, "description": "The DDoS protection plan associated with the virtual network." }, "bgpCommunities": { "$ref": "#/definitions/VirtualNetworkBgpCommunities", "default": null, "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." }, "ipAllocations": { "type": "array", "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "Array of IpAllocation which reference this VNET." } }, "description": "Properties of the virtual network." }, "VirtualNetwork": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualNetworkPropertiesFormat", "description": "Properties of the virtual network." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Virtual Network resource." }, "VirtualNetworkListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualNetwork" }, "description": "A list of VirtualNetwork resources in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for the ListVirtualNetworks API service call." }, "AddressSpace": { "properties": { "addressPrefixes": { "type": "array", "items": { "type": "string" }, "description": "A list of address blocks reserved for this virtual network in CIDR notation." } }, "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." }, "DhcpOptions": { "properties": { "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "The list of DNS servers IP addresses." } }, "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options." }, "VirtualNetworkBgpCommunities": { "properties": { "virtualNetworkCommunity": { "type": "string", "description": "The BGP community associated with the virtual network." }, "regionalCommunity": { "type": "string", "readOnly": true, "description": "The BGP community associated with the region of the virtual network." } }, "required": [ "virtualNetworkCommunity" ], "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." }, "IPAddressAvailabilityResult": { "properties": { "available": { "type": "boolean", "description": "Private IP address availability." }, "availableIPAddresses": { "type": "array", "items": { "type": "string" }, "description": "Contains other available private IP addresses if the asked for address is taken." } }, "description": "Response for CheckIPAddressAvailability API service call." }, "VirtualNetworkListUsageResult": { "properties": { "value": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/VirtualNetworkUsage" }, "description": "VirtualNetwork usage stats." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for the virtual networks GetUsage API service call." }, "VirtualNetworkUsage": { "properties": { "currentValue": { "type": "number", "format": "double", "readOnly": true, "description": "Indicates number of IPs used from the Subnet." }, "id": { "type": "string", "readOnly": true, "description": "Subnet identifier." }, "limit": { "type": "number", "format": "double", "readOnly": true, "description": "Indicates the size of the subnet." }, "name": { "$ref": "#/definitions/VirtualNetworkUsageName", "readOnly": true, "description": "The name containing common and localized value for usage." }, "unit": { "type": "string", "readOnly": true, "description": "Usage units. Returns 'Count'." } }, "description": "Usage details for subnet." }, "VirtualNetworkUsageName": { "properties": { "localizedValue": { "type": "string", "readOnly": true, "description": "Localized subnet size and usage string." }, "value": { "type": "string", "readOnly": true, "description": "Subnet size and usage string." } }, "description": "Usage strings container." }, "PrepareNetworkPoliciesRequest": { "properties": { "serviceName": { "type": "string", "description": "The name of the service for which subnet is being prepared for." }, "networkIntentPolicyConfigurations": { "type": "array", "items": { "$ref": "#/definitions/NetworkIntentPolicyConfiguration" }, "description": "A list of NetworkIntentPolicyConfiguration." } }, "description": "Details of PrepareNetworkPolicies for Subnet." }, "UnprepareNetworkPoliciesRequest": { "properties": { "serviceName": { "type": "string", "description": "The name of the service for which subnet is being unprepared for." } }, "description": "Details of UnprepareNetworkPolicies for Subnet." }, "NetworkIntentPolicyConfiguration": { "properties": { "networkIntentPolicyName": { "type": "string", "description": "The name of the Network Intent Policy for storing in target subscription." }, "sourceNetworkIntentPolicy": { "$ref": "#/definitions/NetworkIntentPolicy", "description": "Source network intent policy." } }, "description": "Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest." }, "NetworkIntentPolicy": { "properties": { "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Network Intent Policy resource." } } }	64.91 KB	2025-05-25 12:27
📄 virtualNetworkTap.json { "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2020-04-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}": { "delete": { "tags": [ "VirtualNetworkTap" ], "operationId": "VirtualNetworkTaps_Delete", "description": "Deletes the specified virtual network tap.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "tapName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network tap." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Delete successful." }, "202": { "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." }, "204": { "description": "Request successful. Resource does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete Virtual Network Tap resource": { "$ref": "./examples/VirtualNetworkTapDelete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } }, "get": { "tags": [ "VirtualNetworkTap" ], "operationId": "VirtualNetworkTaps_Get", "description": "Gets information about the specified virtual network tap.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "tapName", "in": "path", "required": true, "type": "string", "description": "The name of virtual network tap." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting VirtualNetworkTap resource.", "schema": { "$ref": "#/definitions/VirtualNetworkTap" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Virtual Network Tap": { "$ref": "./examples/VirtualNetworkTapGet.json" } } }, "put": { "tags": [ "VirtualNetworkTap" ], "operationId": "VirtualNetworkTaps_CreateOrUpdate", "description": "Creates or updates a Virtual Network Tap.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "tapName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network tap." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkTap" }, "description": "Parameters supplied to the create or update virtual network tap operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", "schema": { "$ref": "#/definitions/VirtualNetworkTap" } }, "201": { "description": "Create successful. The operation returns the resulting VirtualNetworkTap resource.", "schema": { "$ref": "#/definitions/VirtualNetworkTap" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create Virtual Network Tap": { "$ref": "./examples/VirtualNetworkTapCreate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "VirtualNetworkTap" ], "operationId": "VirtualNetworkTaps_UpdateTags", "description": "Updates an VirtualNetworkTap tags.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "tapName", "in": "path", "required": true, "type": "string", "description": "The name of the tap." }, { "name": "tapParameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update VirtualNetworkTap tags." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", "schema": { "$ref": "#/definitions/VirtualNetworkTap" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update virtual network tap tags": { "$ref": "./examples/VirtualNetworkTapUpdateTags.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworkTaps": { "get": { "tags": [ "VirtualNetworkTaps" ], "operationId": "VirtualNetworkTaps_ListAll", "description": "Gets all the VirtualNetworkTaps in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", "schema": { "$ref": "#/definitions/VirtualNetworkTapListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List all virtual network taps": { "$ref": "./examples/VirtualNetworkTapListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps": { "get": { "tags": [ "VirtualNetworkTaps" ], "operationId": "VirtualNetworkTaps_ListByResourceGroup", "description": "Gets all the VirtualNetworkTaps in a subscription.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", "schema": { "$ref": "#/definitions/VirtualNetworkTapListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./network.json#/definitions/CloudError" } } }, "x-ms-examples": { "List virtual network taps in resource group": { "$ref": "./examples/VirtualNetworkTapList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "VirtualNetworkTap": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualNetworkTapPropertiesFormat", "description": "Virtual Network Tap Properties." }, "etag": { "readOnly": true, "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "Virtual Network Tap resource." }, "VirtualNetworkTapPropertiesFormat": { "description": "Virtual Network Tap properties.", "properties": { "networkInterfaceTapConfigurations": { "readOnly": true, "type": "array", "items": { "$ref": "./networkInterface.json#/definitions/NetworkInterfaceTapConfiguration", "description": "The reference to the Network Interface." }, "description": "Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped." }, "resourceGuid": { "type": "string", "readOnly": true, "description": "The resource GUID property of the virtual network tap resource." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual network tap resource." }, "destinationNetworkInterfaceIPConfiguration": { "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", "description": "The reference to the private IP Address of the collector nic that will receive the tap." }, "destinationLoadBalancerFrontEndIPConfiguration": { "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration", "description": "The reference to the private IP address on the internal Load Balancer that will receive the tap." }, "destinationPort": { "type": "integer", "description": "The VXLAN destination port that will receive the tapped traffic." } } }, "VirtualNetworkTapListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkTap" }, "description": "A list of VirtualNetworkTaps in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListVirtualNetworkTap API service call." } } }	13.77 KB	2025-05-25 12:27

Terminal