{ "swagger": "2.0", "info": { "title": "WebApplicationFirewallManagement", "version": "2026-03-01", "description": "APIs to manage Microsoft Azure network resources.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "VirtualWANs" }, { "name": "VpnSites" }, { "name": "VpnServerConfigurations" }, { "name": "VpnGateways" }, { "name": "vpnLinkConnections" }, { "name": "P2SVpnGateways" }, { "name": "ExpressRouteGateways" }, { "name": "ExpressRouteConnections" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways": { "get": { "operationId": "ExpressRouteGateways_ListBySubscription", "tags": [ "ExpressRouteGateways" ], "description": "Lists ExpressRoute gateways under a given subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteGatewayList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayListBySubscription": { "$ref": "./examples/ExpressRouteGatewayListBySubscription.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways": { "get": { "operationId": "P2sVpnGateways_List", "description": "Lists all the P2SVpnGateways in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListP2SVpnGatewaysResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayListBySubscription": { "$ref": "./examples/P2SVpnGatewayList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": { "get": { "operationId": "VirtualHubs_List", "description": "Lists all the VirtualHubs in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVirtualHubsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubList": { "$ref": "./examples/VirtualHubList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": { "get": { "operationId": "VirtualWans_List", "description": "Lists all the VirtualWANs in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVirtualWANsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualWANList": { "$ref": "./examples/VirtualWANList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": { "get": { "operationId": "VpnGateways_List", "description": "Lists all the VpnGateways in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnGatewaysResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnGatewayListBySubscription": { "$ref": "./examples/VpnGatewayList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations": { "get": { "operationId": "VpnServerConfigurations_List", "description": "Lists all the VpnServerConfigurations in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnServerConfigurationsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnServerConfigurationList": { "$ref": "./examples/VpnServerConfigurationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": { "get": { "operationId": "VpnSites_List", "description": "Lists all the VpnSites in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnSitesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteList": { "$ref": "./examples/VpnSiteList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways": { "get": { "operationId": "ExpressRouteGateways_ListByResourceGroup", "tags": [ "ExpressRouteGateways" ], "description": "Lists ExpressRoute gateways in a given resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteGatewayList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayListByResourceGroup": { "$ref": "./examples/ExpressRouteGatewayListByResourceGroup.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}": { "get": { "operationId": "ExpressRouteGateways_Get", "tags": [ "ExpressRouteGateways" ], "description": "Fetches the details of a ExpressRoute gateway in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteGateway" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayGet": { "$ref": "./examples/ExpressRouteGatewayGet.json" } } }, "put": { "operationId": "ExpressRouteGateways_CreateOrUpdate", "tags": [ "ExpressRouteGateways" ], "description": "Creates or updates a ExpressRoute gateway in a specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "putExpressRouteGatewayParameters", "in": "body", "description": "Parameters required in an ExpressRoute gateway PUT operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteGateway" } } ], "responses": { "200": { "description": "Resource 'ExpressRouteGateway' update operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteGateway" } }, "201": { "description": "Resource 'ExpressRouteGateway' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteGateway" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayCreate": { "$ref": "./examples/ExpressRouteGatewayCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteGateway" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ExpressRouteGateways_UpdateTags", "tags": [ "ExpressRouteGateways" ], "description": "Updates express route gateway tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "expressRouteGatewayParameters", "in": "body", "description": "Parameters supplied to update a virtual wan express route gateway tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteGateway" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayUpdate": { "$ref": "./examples/ExpressRouteGatewayUpdateTags.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteGateway" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ExpressRouteGateways_Delete", "tags": [ "ExpressRouteGateways" ], "description": "Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayDelete": { "$ref": "./examples/ExpressRouteGatewayDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections": { "get": { "operationId": "ExpressRouteConnections_List", "tags": [ "ExpressRouteConnections" ], "description": "Lists ExpressRouteConnections.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteConnectionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteConnectionList": { "$ref": "./examples/ExpressRouteConnectionList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}": { "get": { "operationId": "ExpressRouteConnections_Get", "tags": [ "ExpressRouteConnections" ], "description": "Gets the specified ExpressRouteConnection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the express route gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the express route connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteConnectionGet": { "$ref": "./examples/ExpressRouteConnectionGet.json" } } }, "put": { "operationId": "ExpressRouteConnections_CreateOrUpdate", "tags": [ "ExpressRouteConnections" ], "description": "Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the express route gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the express route connection.", "required": true, "type": "string" }, { "name": "putExpressRouteConnectionParameters", "in": "body", "description": "Parameters required in an ExpressRouteConnection PUT operation.", "required": true, "schema": { "$ref": "#/definitions/ExpressRouteConnection" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExpressRouteConnection" } }, "201": { "description": "Resource 'ExpressRouteConnection' create operation succeeded", "schema": { "$ref": "#/definitions/ExpressRouteConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteConnectionCreate": { "$ref": "./examples/ExpressRouteConnectionCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ExpressRouteConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ExpressRouteConnections_Delete", "tags": [ "ExpressRouteConnections" ], "description": "Deletes a connection to a ExpressRoute circuit.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the express route gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the express route connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteConnectionDelete": { "$ref": "./examples/ExpressRouteConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverAllTestsDetails": { "post": { "operationId": "ExpressRouteGateways_GetFailoverAllTestsDetails", "tags": [ "ExpressRouteGateways" ], "description": "Retrieves the details of all the failover tests performed on the ExpressRoute gateway for different peering locations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "The type of failover test.", "required": false, "type": "string" }, { "name": "fetchLatest", "in": "query", "description": "Fetch only the latest tests for each peering location.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "./networkGateway.json#/definitions/ExpressRouteFailoverTestDetails" } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayGetFailoverAllTestsDetails": { "$ref": "./examples/ExpressRouteGatewayGetFailoverAllTestsDetails.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./networkGateway.json#/definitions/ExpressRouteFailoverTestDetailsArray" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getFailoverSingleTestDetails": { "post": { "operationId": "ExpressRouteGateways_GetFailoverSingleTestDetails", "tags": [ "ExpressRouteGateways" ], "description": "Retrieves the details of a particular failover test performed on the ExpressRoute gateway based on the test Guid.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "peeringLocation", "in": "query", "description": "Peering location of the test.", "required": true, "type": "string" }, { "name": "failoverTestId", "in": "query", "description": "The unique Guid value which identifies the test.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "$ref": "./networkGateway.json#/definitions/ExpressRouteFailoverSingleTestDetails" } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayGetFailoverSingleTestDetails": { "$ref": "./examples/ExpressRouteGatewayGetFailoverSingleTestDetails.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./networkGateway.json#/definitions/ExpressRouteFailoverSingleTestDetailsArray" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getResiliencyInformation": { "post": { "operationId": "ExpressRouteGateways_GetResiliencyInformation", "tags": [ "ExpressRouteGateways" ], "description": "Retrieves the resiliency information for the ExpressRoute gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "attemptRefresh", "in": "query", "description": "Whether to attempt a refresh of the resiliency information.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./networkGateway.json#/definitions/GatewayResiliencyInformation" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayGetResiliencyInformation": { "$ref": "./examples/ExpressRouteGatewayGetResiliencyInformation.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./networkGateway.json#/definitions/GatewayResiliencyInformation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/getRoutesInformation": { "post": { "operationId": "ExpressRouteGateways_GetRoutesInformation", "tags": [ "ExpressRouteGateways" ], "description": "Retrieves the route sets information for the ExpressRoute gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "attemptRefresh", "in": "query", "description": "Whether to attempt a refresh of the route sets.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./networkGateway.json#/definitions/GatewayRouteSetsInformation" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayGetRoutesInformation": { "$ref": "./examples/ExpressRouteGatewayGetRoutesInformation.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./networkGateway.json#/definitions/GatewayRouteSetsInformation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/startSiteFailoverTest": { "post": { "operationId": "ExpressRouteGateways_StartSiteFailoverTest", "tags": [ "ExpressRouteGateways" ], "description": "Starts failover simulation on the ExpressRoute gateway for the specified peering location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "peeringLocation", "in": "query", "description": "Peering location of the test.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayStartSiteFailoverTest": { "$ref": "./examples/ExpressRouteGatewayStartSiteFailoverTest.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/stopSiteFailoverTest": { "post": { "operationId": "ExpressRouteGateways_StopSiteFailoverTest", "tags": [ "ExpressRouteGateways" ], "description": "Stops failover simulation on the ExpressRoute gateway for the specified peering location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "expressRouteGatewayName", "in": "path", "description": "The name of the ExpressRoute gateway.", "required": true, "type": "string" }, { "name": "stopParameters", "in": "body", "description": "Parameters supplied to stop the failover simulation on the express route gateway.", "required": true, "schema": { "$ref": "./networkGateway.json#/definitions/ExpressRouteFailoverStopApiParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ExpressRouteGatewayStopSiteFailoverTest": { "$ref": "./examples/ExpressRouteGatewayStopSiteFailoverTest.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections": { "get": { "operationId": "NetworkVirtualApplianceConnections_List", "description": "Lists NetworkVirtualApplianceConnections under the NVA.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "networkVirtualApplianceName", "in": "path", "description": "The name of Network Virtual Appliance.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkVirtualApplianceConnectionList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NetworkVirtualApplianceConnectionList": { "$ref": "./examples/NetworkVirtualApplianceConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}": { "get": { "operationId": "NetworkVirtualApplianceConnections_Get", "description": "Retrieves the details of specified NVA connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "networkVirtualApplianceName", "in": "path", "description": "The name of the Network Virtual Appliance.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkVirtualApplianceConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NetworkVirtualApplianceConnectionGet": { "$ref": "./examples/NetworkVirtualApplianceConnectionGet.json" } } }, "put": { "operationId": "NetworkVirtualApplianceConnections_CreateOrUpdate", "description": "Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "networkVirtualApplianceName", "in": "path", "description": "The name of the Network Virtual Appliance.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "required": true, "type": "string" }, { "name": "NetworkVirtualApplianceConnectionParameters", "in": "body", "description": "Parameters supplied in an NetworkVirtualApplianceConnection PUT operation.", "required": true, "schema": { "$ref": "#/definitions/NetworkVirtualApplianceConnection" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkVirtualApplianceConnection" } }, "201": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkVirtualApplianceConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NetworkVirtualApplianceConnectionPut": { "$ref": "./examples/NetworkVirtualApplianceConnectionPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/NetworkVirtualApplianceConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "NetworkVirtualApplianceConnections_Delete", "description": "Deletes a NVA connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "networkVirtualApplianceName", "in": "path", "description": "The name of the Network Virtual Appliance.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NetworkVirtualApplianceConnectionDelete": { "$ref": "./examples/NetworkVirtualApplianceConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways": { "get": { "operationId": "P2sVpnGateways_ListByResourceGroup", "description": "Lists all the P2SVpnGateways in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListP2SVpnGatewaysResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayListByResourceGroup": { "$ref": "./examples/P2SVpnGatewayListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}": { "get": { "operationId": "P2sVpnGateways_Get", "description": "Retrieves the details of a virtual wan p2s vpn gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/P2SVpnGateway" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayGet": { "$ref": "./examples/P2SVpnGatewayGet.json" } } }, "put": { "operationId": "P2sVpnGateways_CreateOrUpdate", "description": "Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "p2SVpnGatewayParameters", "in": "body", "description": "Parameters supplied to create or Update a virtual wan p2s vpn gateway.", "required": true, "schema": { "$ref": "#/definitions/P2SVpnGateway" } } ], "responses": { "200": { "description": "Resource 'P2SVpnGateway' update operation succeeded", "schema": { "$ref": "#/definitions/P2SVpnGateway" } }, "201": { "description": "Resource 'P2SVpnGateway' create operation succeeded", "schema": { "$ref": "#/definitions/P2SVpnGateway" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayPut": { "$ref": "./examples/P2SVpnGatewayPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/P2SVpnGateway" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "P2sVpnGateways_UpdateTags", "tags": [ "P2SVpnGateways" ], "description": "Updates virtual wan p2s vpn gateway tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "p2SVpnGatewayParameters", "in": "body", "description": "Parameters supplied to update a virtual wan p2s vpn gateway tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/P2SVpnGateway" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayUpdate": { "$ref": "./examples/P2SVpnGatewayUpdateTags.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/P2SVpnGateway" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "P2sVpnGateways_Delete", "description": "Deletes a virtual wan p2s vpn gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayDelete": { "$ref": "./examples/P2SVpnGatewayDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{p2sVpnGatewayName}/disconnectP2sVpnConnections": { "post": { "operationId": "P2sVpnGateways_DisconnectP2sVpnConnections", "tags": [ "P2SVpnGateways" ], "description": "Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "p2sVpnGatewayName", "in": "path", "description": "The name of the P2S Vpn Gateway.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "The parameters are supplied to disconnect p2s vpn connections.", "required": true, "schema": { "$ref": "#/definitions/P2SVpnConnectionRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Disconnect VpnConnections from P2sVpn Gateway": { "$ref": "./examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile": { "post": { "operationId": "P2sVpnGateways_GenerateVpnProfile", "tags": [ "P2SVpnGateways" ], "description": "Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the generate P2SVpnGateway VPN client package operation.", "required": true, "schema": { "$ref": "#/definitions/P2SVpnProfileParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnProfileResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GenerateP2SVpnGatewayVPNProfile": { "$ref": "./examples/P2SVpnGatewayGenerateVpnProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VpnProfileResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth": { "post": { "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealth", "tags": [ "P2SVpnGateways" ], "description": "Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/P2SVpnGateway" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayGetConnectionHealth": { "$ref": "./examples/P2SVpnGatewayGetConnectionHealth.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/P2SVpnGateway" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealthDetailed": { "post": { "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealthDetailed", "tags": [ "P2SVpnGateways" ], "description": "Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Request parameters supplied to get p2s vpn connections detailed health.", "required": true, "schema": { "$ref": "#/definitions/P2SVpnConnectionHealthRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/P2SVpnConnectionHealth" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "P2SVpnGatewayGetConnectionHealthDetailed": { "$ref": "./examples/P2SVpnGatewayGetConnectionHealthDetailed.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/P2SVpnConnectionHealth" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/reset": { "post": { "operationId": "P2SVpnGateways_Reset", "tags": [ "P2SVpnGateways" ], "description": "Resets the primary of the p2s vpn gateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/P2SVpnGateway" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ResetP2SVpnGateway": { "$ref": "./examples/P2SVpnGatewayReset.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/P2SVpnGateway" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs": { "get": { "operationId": "VirtualHubs_ListByResourceGroup", "description": "Lists all the VirtualHubs in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVirtualHubsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubListByResourceGroup": { "$ref": "./examples/VirtualHubListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": { "get": { "operationId": "VirtualHubs_Get", "description": "Retrieves the details of a VirtualHub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualHub" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubGet": { "$ref": "./examples/VirtualHubGet.json" } } }, "put": { "operationId": "VirtualHubs_CreateOrUpdate", "description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "virtualHubParameters", "in": "body", "description": "Parameters supplied to create or update VirtualHub.", "required": true, "schema": { "$ref": "#/definitions/VirtualHub" } } ], "responses": { "200": { "description": "Resource 'VirtualHub' update operation succeeded", "schema": { "$ref": "#/definitions/VirtualHub" } }, "201": { "description": "Resource 'VirtualHub' create operation succeeded", "schema": { "$ref": "#/definitions/VirtualHub" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubPut": { "$ref": "./examples/VirtualHubPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VirtualHub" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "VirtualHubs_UpdateTags", "tags": [ "VirtualWANs" ], "description": "Updates VirtualHub tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "virtualHubParameters", "in": "body", "description": "Parameters supplied to update VirtualHub tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualHub" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubUpdate": { "$ref": "./examples/VirtualHubUpdateTags.json" } } }, "delete": { "operationId": "VirtualHubs_Delete", "description": "Deletes a VirtualHub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubDelete": { "$ref": "./examples/VirtualHubDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections": { "get": { "operationId": "VirtualHubBgpConnections_List", "description": "Retrieves the details of all VirtualHubBgpConnections.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVirtualHubBgpConnectionResults" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubRouteTableV2List": { "$ref": "./examples/VirtualHubBgpConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}": { "get": { "operationId": "VirtualHubBgpConnection_Get", "description": "Retrieves the details of a Virtual Hub Bgp Connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BgpConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubVirtualHubRouteTableV2Get": { "$ref": "./examples/VirtualHubBgpConnectionGet.json" } } }, "put": { "operationId": "VirtualHubBgpConnection_CreateOrUpdate", "description": "Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the connection.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters of Bgp connection.", "required": true, "schema": { "$ref": "#/definitions/BgpConnection" } } ], "responses": { "200": { "description": "Resource 'BgpConnection' update operation succeeded", "schema": { "$ref": "#/definitions/BgpConnection" } }, "201": { "description": "Resource 'BgpConnection' create operation succeeded", "schema": { "$ref": "#/definitions/BgpConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubRouteTableV2Put": { "$ref": "./examples/VirtualHubBgpConnectionPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/BgpConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VirtualHubBgpConnection_Delete", "description": "Deletes a VirtualHubBgpConnection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubRouteTableV2Delete": { "$ref": "./examples/VirtualHubBgpConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/advertisedRoutes": { "post": { "operationId": "VirtualHubBgpConnections_ListAdvertisedRoutes", "description": "Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "hubName", "in": "path", "description": "The name of the virtual hub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the bgp connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "object", "additionalProperties": { "items": { "$ref": "#/definitions/PeerRoute" }, "type": "array" } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualRouterPeerListAdvertisedRoutes": { "$ref": "./examples/VirtualRouterPeerListAdvertisedRoute.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Record%3CPeerRoute%5B%5D%3E" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/learnedRoutes": { "post": { "operationId": "VirtualHubBgpConnections_ListLearnedRoutes", "description": "Retrieves a list of routes the virtual hub bgp connection has learned.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "hubName", "in": "path", "description": "The name of the virtual hub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the bgp connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "object", "additionalProperties": { "items": { "$ref": "#/definitions/PeerRoute" }, "type": "array" } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualRouterPeerListLearnedRoutes": { "$ref": "./examples/VirtualRouterPeerListLearnedRoute.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Record%3CPeerRoute%5B%5D%3E" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/connectionPolicies": { "get": { "operationId": "ConnectionPolicies_List", "description": "Retrieves the details of all ConnectionPolicies.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListConnectionPoliciesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConnectionPolicyList": { "$ref": "./examples/ConnectionPolicyList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/connectionPolicies/{connectionPolicyName}": { "get": { "operationId": "ConnectionPolicies_Get", "description": "Retrieves the details of a ConnectionPolicy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "connectionPolicyName", "in": "path", "description": "The name of the ConnectionPolicy that is unique within a VirtualHub. This name can be used to access the resource.", "required": true, "type": "string", "pattern": "^(?![.-])[a-zA-Z0-9_.-]{1,128}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectionPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConnectionPolicyGet": { "$ref": "./examples/ConnectionPolicyGet.json" } } }, "put": { "operationId": "ConnectionPolicies_CreateOrUpdate", "description": "Creates a ConnectionPolicy if it doesn't exist else updates the existing one.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "connectionPolicyName", "in": "path", "description": "The name of the ConnectionPolicy that is unique within a VirtualHub. This name can be used to access the resource.", "required": true, "type": "string", "pattern": "^(?![.-])[a-zA-Z0-9_.-]{1,128}$" }, { "name": "resource", "in": "body", "description": "Parameters supplied to create or update a ConnectionPolicy.", "required": true, "schema": { "$ref": "#/definitions/ConnectionPolicy" } } ], "responses": { "200": { "description": "Resource 'ConnectionPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/ConnectionPolicy" } }, "201": { "description": "Resource 'ConnectionPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/ConnectionPolicy" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConnectionPolicyPut": { "$ref": "./examples/ConnectionPolicyPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ConnectionPolicy" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ConnectionPolicies_Delete", "description": "Deletes a ConnectionPolicy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "connectionPolicyName", "in": "path", "description": "The name of the ConnectionPolicy that is unique within a VirtualHub. This name can be used to access the resource.", "required": true, "type": "string", "pattern": "^(?![.-])[a-zA-Z0-9_.-]{1,128}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConnectionPolicyDelete": { "$ref": "./examples/ConnectionPolicyDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/effectiveRoutes": { "post": { "operationId": "VirtualHubs_GetEffectiveVirtualHubRoutes", "description": "Gets the effective routes configured for the Virtual Hub resource or the specified resource .", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "effectiveRoutesParameters", "in": "body", "description": "Parameters supplied to get the effective routes for a specific resource.", "required": false, "schema": { "$ref": "#/definitions/EffectiveRoutesParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualHubEffectiveRouteList" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Effective Routes for a Connection resource": { "$ref": "./examples/EffectiveRoutesListForConnection.json" }, "Effective Routes for a Route Table resource": { "$ref": "./examples/EffectiveRoutesListForRouteTable.json" }, "Effective Routes for the Virtual Hub": { "$ref": "./examples/EffectiveRoutesListForVirtualHub.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VirtualHubEffectiveRouteList" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables": { "get": { "operationId": "HubRouteTables_List", "description": "Retrieves the details of all RouteTables.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListHubRouteTablesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteTableList": { "$ref": "./examples/HubRouteTableList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}": { "get": { "operationId": "HubRouteTables_Get", "description": "Retrieves the details of a RouteTable.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routeTableName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HubRouteTable" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteTableGet": { "$ref": "./examples/HubRouteTableGet.json" } } }, "put": { "operationId": "HubRouteTables_CreateOrUpdate", "description": "Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routeTableName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "routeTableParameters", "in": "body", "description": "Parameters supplied to create or update RouteTable.", "required": true, "schema": { "$ref": "#/definitions/HubRouteTable" } } ], "responses": { "200": { "description": "Resource 'HubRouteTable' update operation succeeded", "schema": { "$ref": "#/definitions/HubRouteTable" } }, "201": { "description": "Resource 'HubRouteTable' create operation succeeded", "schema": { "$ref": "#/definitions/HubRouteTable" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteTablePut": { "$ref": "./examples/HubRouteTablePut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/HubRouteTable" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "HubRouteTables_Delete", "description": "Deletes a RouteTable.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routeTableName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteTableDelete": { "$ref": "./examples/HubRouteTableDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": { "get": { "operationId": "HubVirtualNetworkConnections_List", "description": "Retrieves the details of all HubVirtualNetworkConnections.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "HubVirtualNetworkConnectionList": { "$ref": "./examples/HubVirtualNetworkConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": { "get": { "operationId": "HubVirtualNetworkConnections_Get", "description": "Retrieves the details of a HubVirtualNetworkConnection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the Virtual Hub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HubVirtualNetworkConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "HubVirtualNetworkConnectionGet": { "$ref": "./examples/HubVirtualNetworkConnectionGet.json" } } }, "put": { "operationId": "HubVirtualNetworkConnections_CreateOrUpdate", "description": "Creates a hub virtual network connection if it doesn't exist else updates the existing one.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the Virtual Hub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "required": true, "type": "string" }, { "name": "hubVirtualNetworkConnectionParameters", "in": "body", "description": "Parameters supplied to create or update a hub virtual network connection.", "required": true, "schema": { "$ref": "#/definitions/HubVirtualNetworkConnection" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HubVirtualNetworkConnection" } }, "201": { "description": "Resource 'HubVirtualNetworkConnection' create operation succeeded", "schema": { "$ref": "#/definitions/HubVirtualNetworkConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "HubVirtualNetworkConnectionPut": { "$ref": "./examples/HubVirtualNetworkConnectionPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/HubVirtualNetworkConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "HubVirtualNetworkConnections_Delete", "description": "Deletes a HubVirtualNetworkConnection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the Virtual Hub.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "HubVirtualNetworkConnectionDelete": { "$ref": "./examples/HubVirtualNetworkConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/inboundRoutes": { "post": { "operationId": "VirtualHubs_GetInboundRoutes", "description": "Gets the inbound routes configured for the Virtual Hub on a particular connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "getInboundRoutesParameters", "in": "body", "description": "Parameters supplied to get the inbound routes for a connection resource.", "required": true, "schema": { "$ref": "#/definitions/GetInboundRoutesParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EffectiveRouteMapRouteList" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Inbound Routes for the Virtual Hub on a Particular Connection": { "$ref": "./examples/GetInboundRoutes.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/EffectiveRouteMapRouteList" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations": { "get": { "operationId": "VirtualHubIpConfiguration_List", "description": "Retrieves the details of all VirtualHubIpConfigurations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVirtualHubIpConfigurationResults" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubRouteTableV2List": { "$ref": "./examples/VirtualHubIpConfigurationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}": { "get": { "operationId": "VirtualHubIpConfiguration_Get", "description": "Retrieves the details of a Virtual Hub Ip configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "ipConfigName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HubIpConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubVirtualHubRouteTableV2Get": { "$ref": "./examples/VirtualHubIpConfigurationGet.json" } } }, "put": { "operationId": "VirtualHubIpConfiguration_CreateOrUpdate", "description": "Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "ipConfigName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Hub Ip Configuration parameters.", "required": true, "schema": { "$ref": "#/definitions/HubIpConfiguration" } } ], "responses": { "200": { "description": "Resource 'HubIpConfiguration' update operation succeeded", "schema": { "$ref": "#/definitions/HubIpConfiguration" } }, "201": { "description": "Resource 'HubIpConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/HubIpConfiguration" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubIpConfigurationPut": { "$ref": "./examples/VirtualHubIpConfigurationPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/HubIpConfiguration" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VirtualHubIpConfiguration_Delete", "description": "Deletes a VirtualHubIpConfiguration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "ipConfigName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubIpConfigurationDelete": { "$ref": "./examples/VirtualHubIpConfigurationDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes": { "post": { "operationId": "VirtualHubs_GetOutboundRoutes", "description": "Gets the outbound routes configured for the Virtual Hub on a particular connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "getOutboundRoutesParameters", "in": "body", "description": "Parameters supplied to get the outbound routes for a connection resource.", "required": true, "schema": { "$ref": "#/definitions/GetOutboundRoutesParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EffectiveRouteMapRouteList" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Outbound Routes for the Virtual Hub on a Particular Connection": { "$ref": "./examples/GetOutboundRoutes.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/EffectiveRouteMapRouteList" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps": { "get": { "operationId": "RouteMaps_List", "description": "Retrieves the details of all RouteMaps.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListRouteMapsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteMapList": { "$ref": "./examples/RouteMapList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}": { "get": { "operationId": "RouteMaps_Get", "description": "Retrieves the details of a RouteMap.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routeMapName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RouteMap" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteMapGet": { "$ref": "./examples/RouteMapGet.json" } } }, "put": { "operationId": "RouteMaps_CreateOrUpdate", "description": "Creates a RouteMap if it doesn't exist else updates the existing one.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routeMapName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "routeMapParameters", "in": "body", "description": "Parameters supplied to create or update a RouteMap.", "required": true, "schema": { "$ref": "#/definitions/RouteMap" } } ], "responses": { "200": { "description": "Resource 'RouteMap' update operation succeeded", "schema": { "$ref": "#/definitions/RouteMap" } }, "201": { "description": "Resource 'RouteMap' create operation succeeded", "schema": { "$ref": "#/definitions/RouteMap" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteMapPut": { "$ref": "./examples/RouteMapPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/RouteMap" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "RouteMaps_Delete", "description": "Deletes a RouteMap.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routeMapName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteMapDelete": { "$ref": "./examples/RouteMapDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables": { "get": { "operationId": "VirtualHubRouteTableV2s_List", "description": "Retrieves the details of all VirtualHubRouteTableV2s.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVirtualHubRouteTableV2sResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualHubRouteTableV2List": { "$ref": "./examples/VirtualHubRouteTableV2List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}": { "get": { "operationId": "VirtualHubRouteTableV2s_Get", "description": "Retrieves the details of a VirtualHubRouteTableV2.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the Virtual Hub.", "required": true, "type": "string" }, { "name": "routeTableName", "in": "path", "description": "The name of the VirtualHubRouteTableV2.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualHubRouteTableV2" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/Error" } } }, "x-ms-examples": { "VirtualHubVirtualHubRouteTableV2Get": { "$ref": "./examples/VirtualHubRouteTableV2Get.json" } } }, "put": { "operationId": "VirtualHubRouteTableV2s_CreateOrUpdate", "description": "Creates a VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the Virtual Hub.", "required": true, "type": "string" }, { "name": "routeTableName", "in": "path", "description": "The name of the VirtualHubRouteTableV2.", "required": true, "type": "string" }, { "name": "virtualHubRouteTableV2Parameters", "in": "body", "description": "Parameters supplied to create or update VirtualHubRouteTableV2.", "required": true, "schema": { "$ref": "#/definitions/VirtualHubRouteTableV2" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualHubRouteTableV2" } }, "201": { "description": "Resource 'VirtualHubRouteTableV2' create operation succeeded", "schema": { "$ref": "#/definitions/VirtualHubRouteTableV2" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/Error" } } }, "x-ms-examples": { "VirtualHubRouteTableV2Put": { "$ref": "./examples/VirtualHubRouteTableV2Put.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VirtualHubRouteTableV2" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VirtualHubRouteTableV2s_Delete", "description": "Deletes a VirtualHubRouteTableV2.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the Virtual Hub.", "required": true, "type": "string" }, { "name": "routeTableName", "in": "path", "description": "The name of the VirtualHubRouteTableV2.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/Error" } } }, "x-ms-examples": { "VirtualHubRouteTableV2Delete": { "$ref": "./examples/VirtualHubRouteTableV2Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent": { "get": { "operationId": "RoutingIntent_List", "description": "Retrieves the details of all RoutingIntent child resources of the VirtualHub.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListRoutingIntentResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RoutingIntentList": { "$ref": "./examples/RoutingIntentList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}": { "get": { "operationId": "RoutingIntent_Get", "description": "Retrieves the details of a RoutingIntent.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routingIntentName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RoutingIntent" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteTableGet": { "$ref": "./examples/RoutingIntentGet.json" } } }, "put": { "operationId": "RoutingIntent_CreateOrUpdate", "description": "Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routingIntentName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "routingIntentParameters", "in": "body", "description": "Parameters supplied to create or update RoutingIntent.", "required": true, "schema": { "$ref": "#/definitions/RoutingIntent" } } ], "responses": { "200": { "description": "Resource 'RoutingIntent' update operation succeeded", "schema": { "$ref": "#/definitions/RoutingIntent" } }, "201": { "description": "Resource 'RoutingIntent' create operation succeeded", "schema": { "$ref": "#/definitions/RoutingIntent" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteTablePut": { "$ref": "./examples/RoutingIntentPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/RoutingIntent" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "RoutingIntent_Delete", "description": "Deletes a RoutingIntent.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualHubName", "in": "path", "description": "The name of the VirtualHub.", "required": true, "type": "string" }, { "name": "routingIntentName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "RouteTableDelete": { "$ref": "./examples/RoutingIntentDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": { "get": { "operationId": "VirtualWans_ListByResourceGroup", "description": "Lists all the VirtualWANs in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVirtualWANsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualWANListByResourceGroup": { "$ref": "./examples/VirtualWANListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}": { "get": { "operationId": "VirtualWans_Get", "description": "Retrieves the details of a VirtualWAN.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "VirtualWANName", "in": "path", "description": "The name of the VirtualWAN being retrieved.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualWAN" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualWANGet": { "$ref": "./examples/VirtualWANGet.json" } } }, "put": { "operationId": "VirtualWans_CreateOrUpdate", "description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "VirtualWANName", "in": "path", "description": "The name of the VirtualWAN being retrieved.", "required": true, "type": "string" }, { "name": "WANParameters", "in": "body", "description": "Parameters supplied to create or update VirtualWAN.", "required": true, "schema": { "$ref": "#/definitions/VirtualWAN" } } ], "responses": { "200": { "description": "Resource 'VirtualWAN' update operation succeeded", "schema": { "$ref": "#/definitions/VirtualWAN" } }, "201": { "description": "Resource 'VirtualWAN' create operation succeeded", "schema": { "$ref": "#/definitions/VirtualWAN" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualWANCreate": { "$ref": "./examples/VirtualWANPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VirtualWAN" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "VirtualWans_UpdateTags", "tags": [ "VirtualWANs" ], "description": "Updates a VirtualWAN tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "VirtualWANName", "in": "path", "description": "The name of the VirtualWAN being retrieved.", "required": true, "type": "string" }, { "name": "WANParameters", "in": "body", "description": "Parameters supplied to Update VirtualWAN tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualWAN" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualWANUpdate": { "$ref": "./examples/VirtualWANUpdateTags.json" } } }, "delete": { "operationId": "VirtualWans_Delete", "description": "Deletes a VirtualWAN.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "VirtualWANName", "in": "path", "description": "The name of the VirtualWAN being retrieved.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualWANDelete": { "$ref": "./examples/VirtualWANDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/generateVpnProfile": { "post": { "operationId": "generatevirtualwanvpnserverconfigurationvpnprofile", "description": "Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualWANName", "in": "path", "description": "The name of the VirtualWAN.", "required": true, "type": "string" }, { "name": "vpnClientParams", "in": "body", "description": "Parameters supplied to the generate VirtualWan VPN profile generation operation.", "required": true, "schema": { "$ref": "#/definitions/VirtualWanVpnProfileParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnProfileResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GenerateVirtualWanVpnServerConfigurationVpnProfile": { "$ref": "./examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VpnProfileResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders": { "get": { "operationId": "SupportedSecurityProviders", "description": "Gives the supported security providers for the virtual wan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualWANName", "in": "path", "description": "The name of the VirtualWAN.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VirtualWanSecurityProviders" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "supportedSecurityProviders": { "$ref": "./examples/VirtualWanSupportedSecurityProviders.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": { "post": { "operationId": "VpnSitesConfiguration_Download", "description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualWANName", "in": "path", "description": "The name of the VirtualWAN.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "Parameters supplied to download vpn-sites configuration.", "required": true, "schema": { "$ref": "#/definitions/GetVpnSitesConfigurationRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSitesConfigurationDownload": { "$ref": "./examples/VpnSitesConfigurationDownload.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations": { "post": { "operationId": "VpnServerConfigurationsAssociatedWithVirtualWan_List", "description": "Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "virtualWANName", "in": "path", "description": "The name of the VirtualWAN.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnServerConfigurationsResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "GetVirtualWanVpnServerConfigurations": { "$ref": "./examples/GetVirtualWanVpnServerConfigurations.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VpnServerConfigurationsResponse" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": { "get": { "operationId": "VpnGateways_ListByResourceGroup", "description": "Lists all the VpnGateways in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnGatewaysResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnGatewayListByResourceGroup": { "$ref": "./examples/VpnGatewayListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": { "get": { "operationId": "VpnGateways_Get", "description": "Retrieves the details of a virtual wan vpn gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnGateway" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnGatewayGet": { "$ref": "./examples/VpnGatewayGet.json" } } }, "put": { "operationId": "VpnGateways_CreateOrUpdate", "description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "vpnGatewayParameters", "in": "body", "description": "Parameters supplied to create or Update a virtual wan vpn gateway.", "required": true, "schema": { "$ref": "#/definitions/VpnGateway" } } ], "responses": { "200": { "description": "Resource 'VpnGateway' update operation succeeded", "schema": { "$ref": "#/definitions/VpnGateway" } }, "201": { "description": "Resource 'VpnGateway' create operation succeeded", "schema": { "$ref": "#/definitions/VpnGateway" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnGatewayPut": { "$ref": "./examples/VpnGatewayPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VpnGateway" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "VpnGateways_UpdateTags", "tags": [ "VpnGateways" ], "description": "Updates virtual wan vpn gateway tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "vpnGatewayParameters", "in": "body", "description": "Parameters supplied to update a virtual wan vpn gateway tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnGateway" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnGatewayUpdate": { "$ref": "./examples/VpnGatewayUpdateTags.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VpnGateway" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VpnGateways_Delete", "description": "Deletes a virtual wan vpn gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnGatewayDelete": { "$ref": "./examples/VpnGatewayDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules": { "get": { "operationId": "NatRules_ListByVpnGateway", "description": "Retrieves all nat rules for a particular virtual wan vpn gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnGatewayNatRulesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NatRuleList": { "$ref": "./examples/NatRuleList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}": { "get": { "operationId": "NatRules_Get", "description": "Retrieves the details of a nat ruleGet.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "natRuleName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnGatewayNatRule" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NatRuleGet": { "$ref": "./examples/NatRuleGet.json" } } }, "put": { "operationId": "NatRules_CreateOrUpdate", "description": "Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "natRuleName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "NatRuleParameters", "in": "body", "description": "Parameters supplied to create or Update a Nat Rule.", "required": true, "schema": { "$ref": "#/definitions/VpnGatewayNatRule" } } ], "responses": { "200": { "description": "Resource 'VpnGatewayNatRule' update operation succeeded", "schema": { "$ref": "#/definitions/VpnGatewayNatRule" } }, "201": { "description": "Resource 'VpnGatewayNatRule' create operation succeeded", "schema": { "$ref": "#/definitions/VpnGatewayNatRule" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NatRulePut": { "$ref": "./examples/NatRulePut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VpnGatewayNatRule" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "NatRules_Delete", "description": "Deletes a nat rule.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "natRuleName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "NatRuleDelete": { "$ref": "./examples/NatRuleDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset": { "post": { "operationId": "VpnGateways_Reset", "tags": [ "VpnGateways" ], "description": "Resets the primary of the vpn gateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "ipConfigurationId", "in": "query", "description": "VpnGateway ipConfigurationId to specify the gateway instance.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnGateway" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ResetVpnGateway": { "$ref": "./examples/VpnGatewayReset.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VpnGateway" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/startpacketcapture": { "post": { "operationId": "VpnGateways_StartPacketCapture", "tags": [ "VpnGateways" ], "description": "Starts packet capture on vpn gateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway.", "required": false, "schema": { "$ref": "#/definitions/VpnGatewayPacketCaptureStartParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Start packet capture on vpn gateway with filter": { "$ref": "./examples/VpnGatewayStartPacketCaptureFilterData.json" }, "Start packet capture on vpn gateway without filter": { "$ref": "./examples/VpnGatewayStartPacketCapture.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/stoppacketcapture": { "post": { "operationId": "VpnGateways_StopPacketCapture", "tags": [ "VpnGateways" ], "description": "Stops packet capture on vpn gateway in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway.", "required": false, "schema": { "$ref": "#/definitions/VpnGatewayPacketCaptureStopParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Stop packet capture on vpn gateway": { "$ref": "./examples/VpnGatewayStopPacketCapture.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": { "get": { "operationId": "VpnConnections_ListByVpnGateway", "description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnConnectionsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnConnectionList": { "$ref": "./examples/VpnConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": { "get": { "operationId": "VpnConnections_Get", "description": "Retrieves the details of a vpn connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnConnectionGet": { "$ref": "./examples/VpnConnectionGet.json" } } }, "put": { "operationId": "VpnConnections_CreateOrUpdate", "description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "VpnConnectionParameters", "in": "body", "description": "Parameters supplied to create or Update a VPN Connection.", "required": true, "schema": { "$ref": "#/definitions/VpnConnection" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnConnection" } }, "201": { "description": "Resource 'VpnConnection' create operation succeeded", "schema": { "$ref": "#/definitions/VpnConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnConnectionPut": { "$ref": "./examples/VpnConnectionPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VpnConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VpnConnections_Delete", "description": "Deletes a vpn connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnConnectionDelete": { "$ref": "./examples/VpnConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/startpacketcapture": { "post": { "operationId": "VpnConnections_StartPacketCapture", "description": "Starts packet capture on Vpn connection in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "vpnConnectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.", "required": false, "schema": { "$ref": "#/definitions/VpnConnectionPacketCaptureStartParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Start packet capture on vpn connection with filter": { "$ref": "./examples/VpnConnectionStartPacketCaptureFilterData.json" }, "Start packet capture on vpn connection without filter": { "$ref": "./examples/VpnConnectionStartPacketCapture.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/stoppacketcapture": { "post": { "operationId": "VpnConnections_StopPacketCapture", "description": "Stops packet capture on Vpn connection in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "vpnConnectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection.", "required": false, "schema": { "$ref": "#/definitions/VpnConnectionPacketCaptureStopParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Start packet capture on vpn connection without filter": { "$ref": "./examples/VpnConnectionStopPacketCapture.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections": { "get": { "operationId": "VpnLinkConnections_ListByVpnConnection", "description": "Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnSiteLinkConnectionsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteLinkConnectionList": { "$ref": "./examples/VpnSiteLinkConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}": { "get": { "operationId": "VpnSiteLinkConnections_Get", "description": "Retrieves the details of a vpn site link connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "linkConnectionName", "in": "path", "description": "The name of the vpn link connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnSiteLinkConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteLinkConnectionGet": { "$ref": "./examples/VpnSiteLinkConnectionGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/getikesas": { "post": { "operationId": "VpnLinkConnections_GetIkeSas", "description": "Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "linkConnectionName", "in": "path", "description": "The name of the vpn link connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./common.json#/definitions/stringApplicationJson" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GetVpnLinkConnectionIkeSa": { "$ref": "./examples/VpnSiteLinkConnectionGetIkeSas.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "./common.json#/definitions/stringApplicationJson" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/resetconnection": { "post": { "operationId": "VpnLinkConnections_ResetConnection", "tags": [ "vpnLinkConnections" ], "description": "Resets the VpnLink connection specified.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "linkConnectionName", "in": "path", "description": "The name of the vpn link connection.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./networkWatcher.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ResetVpnLinkConnection": { "$ref": "./examples/VpnSiteLinkConnectionReset.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys": { "get": { "operationId": "VpnLinkConnections_GetAllSharedKeys", "description": "Lists all shared keys of VpnLink connection specified.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "linkConnectionName", "in": "path", "description": "The name of the vpn link connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectionSharedKeyResultList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteLinkConnectionSharedKeysGet": { "$ref": "./examples/VpnSiteLinkConnectionSharedKeysGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys/default": { "get": { "operationId": "VpnLinkConnections_GetDefaultSharedKey", "description": "Gets the shared key of VpnLink connection specified.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "linkConnectionName", "in": "path", "description": "The name of the vpn link connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectionSharedKeyResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteLinkConnectionDefaultSharedKeyGet": { "$ref": "./examples/VpnSiteLinkConnectionDefaultSharedKeyGet.json" } } }, "put": { "operationId": "VpnLinkConnections_SetOrInitDefaultSharedKey", "description": "Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "linkConnectionName", "in": "path", "description": "The name of the vpn link connection.", "required": true, "type": "string" }, { "name": "ConnectionSharedKeyParameters", "in": "body", "description": "Parameters supplied to set or auto generate the shared key for the vpn link connection.", "required": true, "schema": { "$ref": "#/definitions/ConnectionSharedKeyResult" } } ], "responses": { "200": { "description": "Resource 'ConnectionSharedKeyResult' update operation succeeded", "schema": { "$ref": "#/definitions/ConnectionSharedKeyResult" } }, "201": { "description": "Resource 'ConnectionSharedKeyResult' create operation succeeded", "schema": { "$ref": "#/definitions/ConnectionSharedKeyResult" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteLinkConnectionDefaultSharedKeyPut": { "$ref": "./examples/VpnSiteLinkConnectionDefaultSharedKeyPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ConnectionSharedKeyResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys/default/listSharedKey": { "post": { "operationId": "VpnLinkConnections_ListDefaultSharedKey", "description": "Gets the value of the shared key of VpnLink connection specified.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the vpn gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "The name of the vpn connection.", "required": true, "type": "string" }, { "name": "linkConnectionName", "in": "path", "description": "The name of the vpn link connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ConnectionSharedKeyResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteLinkConnectionDefaultSharedKeyList": { "$ref": "./examples/VpnSiteLinkConnectionDefaultSharedKeyList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations": { "get": { "operationId": "VpnServerConfigurations_ListByResourceGroup", "description": "Lists all the vpnServerConfigurations in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnServerConfigurationsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnServerConfigurationListByResourceGroup": { "$ref": "./examples/VpnServerConfigurationListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}": { "get": { "operationId": "VpnServerConfigurations_Get", "description": "Retrieves the details of a VpnServerConfiguration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnServerConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnServerConfigurationGet": { "$ref": "./examples/VpnServerConfigurationGet.json" } } }, "put": { "operationId": "VpnServerConfigurations_CreateOrUpdate", "description": "Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "VpnServerConfigurationParameters", "in": "body", "description": "Parameters supplied to create or update VpnServerConfiguration.", "required": true, "schema": { "$ref": "#/definitions/VpnServerConfiguration" } } ], "responses": { "200": { "description": "Resource 'VpnServerConfiguration' update operation succeeded", "schema": { "$ref": "#/definitions/VpnServerConfiguration" } }, "201": { "description": "Resource 'VpnServerConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/VpnServerConfiguration" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnServerConfigurationCreate": { "$ref": "./examples/VpnServerConfigurationPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VpnServerConfiguration" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "VpnServerConfigurations_UpdateTags", "tags": [ "VpnServerConfigurations" ], "description": "Updates VpnServerConfiguration tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "VpnServerConfigurationParameters", "in": "body", "description": "Parameters supplied to update VpnServerConfiguration tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnServerConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnServerConfigurationUpdate": { "$ref": "./examples/VpnServerConfigurationUpdateTags.json" } } }, "delete": { "operationId": "VpnServerConfigurations_Delete", "description": "Deletes a VpnServerConfiguration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnServerConfigurationDelete": { "$ref": "./examples/VpnServerConfigurationDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups": { "get": { "operationId": "ConfigurationPolicyGroups_ListByVpnServerConfiguration", "description": "Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnServerConfigurationPolicyGroupsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConfigurationPolicyGroupListByVpnServerConfiguration": { "$ref": "./examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}": { "get": { "operationId": "ConfigurationPolicyGroups_Get", "description": "Retrieves the details of a ConfigurationPolicyGroup.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "configurationPolicyGroupName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConfigurationPolicyGroupGet": { "$ref": "./examples/ConfigurationPolicyGroupGet.json" } } }, "put": { "operationId": "ConfigurationPolicyGroups_CreateOrUpdate", "description": "Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "configurationPolicyGroupName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "VpnServerConfigurationPolicyGroupParameters", "in": "body", "description": "Parameters supplied to create or update a VpnServerConfiguration PolicyGroup.", "required": true, "schema": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" } } ], "responses": { "200": { "description": "Resource 'VpnServerConfigurationPolicyGroup' update operation succeeded", "schema": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" } }, "201": { "description": "Resource 'VpnServerConfigurationPolicyGroup' create operation succeeded", "schema": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConfigurationPolicyGroupPut": { "$ref": "./examples/ConfigurationPolicyGroupPut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VpnServerConfigurationPolicyGroup" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ConfigurationPolicyGroups_Delete", "description": "Deletes a ConfigurationPolicyGroup.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" }, { "name": "configurationPolicyGroupName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ConfigurationPolicyGroupDelete": { "$ref": "./examples/ConfigurationPolicyGroupDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/listRadiusSecrets": { "post": { "operationId": "VpnServerConfigurations_ListRadiusSecrets", "tags": [ "VpnServerConfigurations" ], "description": "List all Radius servers with respective radius secrets from VpnServerConfiguration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnServerConfigurationName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "./networkGateway.json#/definitions/RadiusAuthServerListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "ListAllVpnServerConfigurationRadiusServerSecrets": { "$ref": "./examples/AllVpnServerConfigurationRadiusServerSecretsList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": { "get": { "operationId": "VpnSites_ListByResourceGroup", "description": "Lists all the vpnSites in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnSitesResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteListByResourceGroup": { "$ref": "./examples/VpnSiteListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": { "get": { "operationId": "VpnSites_Get", "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnSiteName", "in": "path", "description": "The name of the VpnSite being retrieved.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnSite" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteGet": { "$ref": "./examples/VpnSiteGet.json" } } }, "put": { "operationId": "VpnSites_CreateOrUpdate", "description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnSiteName", "in": "path", "description": "The name of the VpnSite being retrieved.", "required": true, "type": "string" }, { "name": "VpnSiteParameters", "in": "body", "description": "Parameters supplied to create or update VpnSite.", "required": true, "schema": { "$ref": "#/definitions/VpnSite" } } ], "responses": { "200": { "description": "Resource 'VpnSite' update operation succeeded", "schema": { "$ref": "#/definitions/VpnSite" } }, "201": { "description": "Resource 'VpnSite' create operation succeeded", "schema": { "$ref": "#/definitions/VpnSite" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteCreate": { "$ref": "./examples/VpnSitePut.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VpnSite" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "VpnSites_UpdateTags", "tags": [ "VpnSites" ], "description": "Updates VpnSite tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnSiteName", "in": "path", "description": "The name of the VpnSite being retrieved.", "required": true, "type": "string" }, { "name": "VpnSiteParameters", "in": "body", "description": "Parameters supplied to update VpnSite tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnSite" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteUpdate": { "$ref": "./examples/VpnSiteUpdateTags.json" } } }, "delete": { "operationId": "VpnSites_Delete", "description": "Deletes a VpnSite.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnSiteName", "in": "path", "description": "The name of the VpnSite being retrieved.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteDelete": { "$ref": "./examples/VpnSiteDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks": { "get": { "operationId": "VpnSiteLinks_ListByVpnSite", "description": "Lists all the vpnSiteLinks in a resource group for a vpn site.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnSiteName", "in": "path", "description": "The name of the VpnSite being retrieved.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListVpnSiteLinksResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteLinkListByVpnSite": { "$ref": "./examples/VpnSiteLinkListByVpnSite.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}": { "get": { "operationId": "VpnSiteLinks_Get", "description": "Retrieves the details of a VPN site link.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "vpnSiteName", "in": "path", "description": "The name of the VpnSite being retrieved.", "required": true, "type": "string" }, { "name": "vpnSiteLinkName", "in": "path", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VpnSiteLink" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VpnSiteGet": { "$ref": "./examples/VpnSiteLinkGet.json" } } } } }, "definitions": { "AadAuthenticationParameters": { "type": "object", "description": "AAD Vpn authentication type related parameters.", "properties": { "aadTenant": { "type": "string", "description": "AAD Vpn authentication parameter AAD tenant." }, "aadAudience": { "type": "string", "description": "AAD Vpn authentication parameter AAD audience." }, "aadIssuer": { "type": "string", "description": "AAD Vpn authentication parameter AAD issuer." } } }, "Action": { "type": "object", "description": "Action to be taken on a route matching a RouteMap criterion.", "properties": { "type": { "$ref": "./common.json#/definitions/RouteMapActionType", "description": "Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'" }, "parameters": { "type": "array", "description": "List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added", "items": { "$ref": "#/definitions/Parameter" }, "x-ms-identifiers": [] } } }, "BgpConnection": { "type": "object", "description": "Virtual Appliance Site resource.", "properties": { "properties": { "$ref": "#/definitions/BgpConnectionProperties", "description": "The properties of the Bgp connections.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "BgpConnectionProperties": { "type": "object", "description": "Properties of the bgp connection.", "properties": { "peerAsn": { "type": "integer", "format": "int64", "description": "Peer ASN.", "minimum": 0, "maximum": 4294967295 }, "peerIp": { "type": "string", "description": "Peer IP." }, "hubVirtualNetworkConnection": { "$ref": "./common.json#/definitions/SubResource", "description": "The reference to the HubVirtualNetworkConnection resource." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the resource.", "readOnly": true }, "connectionState": { "$ref": "./common.json#/definitions/HubBgpConnectionStatus", "description": "The current state of the VirtualHub to Peer.", "readOnly": true }, "routingConfiguration": { "$ref": "#/definitions/RoutingConfiguration", "description": "The routing configuration indicating the associated and propagated route tables for this connection." } } }, "ConnectionPolicy": { "type": "object", "description": "ConnectionPolicy resource defined for VirtualHub.", "properties": { "properties": { "$ref": "#/definitions/ConnectionPolicyProperties", "description": "Properties of the ConnectionPolicy resource." } }, "allOf": [ { "$ref": "./common.json#/definitions/ProxyResource" } ] }, "ConnectionPolicyProperties": { "type": "object", "description": "Properties of the ConnectionPolicy resource.", "properties": { "enableInternetSecurity": { "type": "boolean", "description": "Enable internet security." }, "routingConfiguration": { "$ref": "#/definitions/RoutingConfiguration", "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the ConnectionPolicy resource.", "readOnly": true }, "associatedConnections": { "type": "array", "description": "List of connection names (e.g. VpnConnection, HubVirtualNetworkConnection) associated with this ConnectionPolicy. These are resource names, not Azure resource IDs, consistent with the established VirtualWAN pattern used by HubRouteTable.associatedConnections.", "items": { "type": "string" }, "readOnly": true } } }, "ConnectionSharedKeyResult": { "type": "object", "description": "SharedKey Resource .", "properties": { "properties": { "$ref": "#/definitions/SharedKeyProperties", "description": "Properties of the shared key." } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "ConnectionSharedKeyResultList": { "type": "object", "description": "The list of shared keys for the vpn link connection. It should only contain one shared key for each vpn link connection.", "properties": { "value": { "type": "array", "description": "The ConnectionSharedKeyResult items on this page", "items": { "$ref": "#/definitions/ConnectionSharedKeyResult" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "Criterion": { "type": "object", "description": "A matching criteria which matches routes based on route prefix, community, and AS path.", "properties": { "routePrefix": { "type": "array", "description": "List of route prefixes which this criteria matches.", "items": { "type": "string" } }, "community": { "type": "array", "description": "List of BGP communities which this criteria matches.", "items": { "type": "string" } }, "asPath": { "type": "array", "description": "List of AS paths which this criteria matches.", "items": { "type": "string" } }, "matchCondition": { "$ref": "./common.json#/definitions/RouteMapMatchCondition", "description": "Match condition to apply RouteMap rules." } } }, "DeviceProperties": { "type": "object", "description": "List of properties of the device.", "properties": { "deviceVendor": { "type": "string", "description": "Name of the device Vendor." }, "deviceModel": { "type": "string", "description": "Model of the device." }, "linkSpeedInMbps": { "type": "integer", "format": "int32", "description": "Link speed." } } }, "EffectiveRouteMapRoute": { "type": "object", "description": "The effective RouteMap route configured on the connection resource.", "properties": { "prefix": { "type": "string", "description": "The address prefix of the route." }, "bgpCommunities": { "type": "string", "description": "BGP communities of the route." }, "asPath": { "type": "string", "description": "The ASPath of this route." } } }, "EffectiveRouteMapRouteList": { "type": "object", "description": "EffectiveRouteMapRoute List.", "properties": { "value": { "type": "array", "description": "The list of Effective RouteMap Routes configured on the connection resource.", "items": { "$ref": "#/definitions/EffectiveRouteMapRoute" }, "x-ms-identifiers": [] } } }, "EffectiveRoutesParameters": { "type": "object", "description": "The parameters specifying the resource whose effective routes are being requested.", "properties": { "resourceId": { "type": "string", "description": "The resource whose effective routes are being requested." }, "virtualWanResourceType": { "type": "string", "description": "The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." } } }, "ExpressRouteCircuitPeeringId": { "type": "object", "description": "ExpressRoute circuit peering identifier.", "properties": { "id": { "type": "string", "description": "The ID of the ExpressRoute circuit peering." } } }, "ExpressRouteConnection": { "type": "object", "description": "ExpressRouteConnection resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteConnectionProperties", "description": "Properties of the express route connection.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "The name of the resource." } }, "required": [ "name" ], "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ExpressRouteConnectionId": { "type": "object", "description": "The ID of the ExpressRouteConnection.", "properties": { "id": { "type": "string", "description": "The ID of the ExpressRouteConnection.", "readOnly": true } } }, "ExpressRouteConnectionList": { "type": "object", "description": "ExpressRouteConnection list.", "properties": { "value": { "type": "array", "description": "The list of ExpressRoute connections.", "items": { "$ref": "#/definitions/ExpressRouteConnection" } } } }, "ExpressRouteConnectionProperties": { "type": "object", "description": "Properties of the ExpressRouteConnection subresource.", "properties": { "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route connection resource.", "readOnly": true }, "expressRouteCircuitPeering": { "$ref": "#/definitions/ExpressRouteCircuitPeeringId", "description": "The ExpressRoute circuit peering." }, "authorizationKey": { "type": "string", "description": "Authorization key to establish the connection." }, "routingWeight": { "type": "integer", "format": "int32", "description": "The routing weight associated to the connection." }, "enableInternetSecurity": { "type": "boolean", "description": "Enable internet security." }, "expressRouteGatewayBypass": { "type": "boolean", "description": "Enable FastPath to vWan Firewall hub." }, "enablePrivateLinkFastPath": { "type": "boolean", "description": "Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled." }, "routingConfiguration": { "$ref": "#/definitions/RoutingConfiguration", "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." } }, "required": [ "expressRouteCircuitPeering" ] }, "ExpressRouteGateway": { "type": "object", "description": "ExpressRoute gateway resource.", "properties": { "properties": { "$ref": "#/definitions/ExpressRouteGatewayProperties", "description": "Properties of the express route gateway.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ExpressRouteGatewayList": { "type": "object", "description": "List of ExpressRoute gateways.", "properties": { "value": { "type": "array", "description": "List of ExpressRoute gateways.", "items": { "$ref": "#/definitions/ExpressRouteGateway" } } } }, "ExpressRouteGatewayProperties": { "type": "object", "description": "ExpressRoute gateway resource properties.", "properties": { "autoScaleConfiguration": { "$ref": "#/definitions/ExpressRouteGatewayPropertiesAutoScaleConfiguration", "description": "Configuration for auto scaling." }, "expressRouteConnections": { "type": "array", "description": "List of ExpressRoute connections to the ExpressRoute gateway.", "items": { "$ref": "#/definitions/ExpressRouteConnection" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the express route gateway resource.", "readOnly": true }, "virtualHub": { "$ref": "#/definitions/VirtualHubId", "description": "The Virtual Hub where the ExpressRoute gateway is or will be deployed." }, "allowNonVirtualWanTraffic": { "type": "boolean", "description": "Configures this gateway to accept traffic from non Virtual WAN networks." } }, "required": [ "virtualHub" ] }, "ExpressRouteGatewayPropertiesAutoScaleConfiguration": { "type": "object", "description": "Configuration for auto scaling.", "properties": { "bounds": { "$ref": "#/definitions/ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds", "description": "Minimum and maximum number of scale units to deploy." } } }, "ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds": { "type": "object", "description": "Minimum and maximum number of scale units to deploy.", "properties": { "min": { "type": "integer", "format": "int32", "description": "Minimum number of scale units deployed for ExpressRoute gateway." }, "max": { "type": "integer", "format": "int32", "description": "Maximum number of scale units deployed for ExpressRoute gateway." } } }, "GetInboundRoutesParameters": { "type": "object", "description": "The parameters specifying the connection resource whose inbound routes are being requested.", "properties": { "resourceUri": { "type": "string", "description": "The connection resource whose inbound routes are being requested." }, "connectionType": { "type": "string", "description": "The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." } } }, "GetOutboundRoutesParameters": { "type": "object", "description": "The parameters specifying the connection resource whose outbound routes are being requested.", "properties": { "resourceUri": { "type": "string", "description": "The connection resource whose outbound routes are being requested." }, "connectionType": { "type": "string", "description": "The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." } } }, "GetVpnSitesConfigurationRequest": { "type": "object", "description": "List of Vpn-Sites.", "properties": { "vpnSites": { "type": "array", "description": "List of resource-ids of the vpn-sites for which config is to be downloaded.", "items": { "type": "string" } }, "outputBlobSasUrl": { "type": "string", "description": "The sas-url to download the configurations for vpn-sites." } }, "required": [ "outputBlobSasUrl" ] }, "HubIPConfigurationPropertiesFormat": { "type": "object", "description": "Properties of IP configuration.", "properties": { "privateIPAddress": { "type": "string", "description": "The private IP address of the IP configuration." }, "privateIPAllocationMethod": { "$ref": "./common.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": "./virtualNetwork.json#/definitions/PublicIPAddress", "description": "The reference to the public IP resource." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the IP configuration resource.", "readOnly": true } } }, "HubIpConfiguration": { "type": "object", "description": "IpConfigurations.", "properties": { "properties": { "$ref": "#/definitions/HubIPConfigurationPropertiesFormat", "description": "The properties of the Virtual Hub IPConfigurations.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "HubRoute": { "type": "object", "description": "RouteTable route.", "properties": { "name": { "type": "string", "description": "The name of the Route that is unique within a RouteTable. This name can be used to access this route." }, "destinationType": { "type": "string", "description": "The type of destinations (eg: CIDR, ResourceId, Service)." }, "destinations": { "type": "array", "description": "List of all destinations.", "items": { "type": "string" } }, "nextHopType": { "type": "string", "description": "The type of next hop (eg: ResourceId)." }, "nextHop": { "type": "string", "description": "NextHop resource ID." } }, "required": [ "name", "destinationType", "destinations", "nextHopType", "nextHop" ] }, "HubRouteTable": { "type": "object", "description": "RouteTable resource in a virtual hub.", "properties": { "properties": { "$ref": "#/definitions/HubRouteTableProperties", "description": "Properties of the RouteTable resource.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "HubRouteTableProperties": { "type": "object", "description": "Parameters for RouteTable.", "properties": { "routes": { "type": "array", "description": "List of all routes.", "items": { "$ref": "#/definitions/HubRoute" } }, "labels": { "type": "array", "description": "List of labels associated with this route table.", "items": { "type": "string" } }, "associatedConnections": { "type": "array", "description": "List of all connections associated with this route table.", "items": { "type": "string" }, "readOnly": true }, "propagatingConnections": { "type": "array", "description": "List of all connections that advertise to this route table.", "items": { "type": "string" }, "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the RouteTable resource.", "readOnly": true } } }, "HubVirtualNetworkConnection": { "type": "object", "description": "HubVirtualNetworkConnection Resource.", "properties": { "properties": { "$ref": "#/definitions/HubVirtualNetworkConnectionProperties", "description": "Properties of the hub virtual network connection.", "x-ms-client-flatten": true }, "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": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "HubVirtualNetworkConnectionProperties": { "type": "object", "description": "Parameters for HubVirtualNetworkConnection.", "properties": { "remoteVirtualNetwork": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the remote virtual network." }, "allowHubToRemoteVnetTransit": { "type": "boolean", "description": "Deprecated: VirtualHub to RemoteVnet transit to enabled or not." }, "allowRemoteVnetToUseHubVnetGateways": { "type": "boolean", "description": "Deprecated: Allow RemoteVnet to use Virtual Hub's gateways." }, "connectionPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "The resource id of the ConnectionPolicy associated with this HubVirtualNetworkConnection." }, "enableInternetSecurity": { "type": "boolean", "description": "Enable internet security." }, "routingConfiguration": { "$ref": "#/definitions/RoutingConfiguration", "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." }, "enableOnlyIPv6Peering": { "type": "boolean", "description": "Enable Only IPv6 Peering for this connection.", "x-ms-mutability": [ "read", "create" ] }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the hub virtual network connection resource.", "readOnly": true } } }, "ListConnectionPoliciesResult": { "type": "object", "description": "List of ConnectionPolicies and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The ConnectionPolicy items on this page", "items": { "$ref": "#/definitions/ConnectionPolicy" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListHubRouteTablesResult": { "type": "object", "description": "List of RouteTables and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The HubRouteTable items on this page", "items": { "$ref": "#/definitions/HubRouteTable" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListHubVirtualNetworkConnectionsResult": { "type": "object", "description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The HubVirtualNetworkConnection items on this page", "items": { "$ref": "#/definitions/HubVirtualNetworkConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListP2SVpnGatewaysResult": { "type": "object", "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The P2SVpnGateway items on this page", "items": { "$ref": "#/definitions/P2SVpnGateway" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListRouteMapsResult": { "type": "object", "description": "List of RouteMaps and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The RouteMap items on this page", "items": { "$ref": "#/definitions/RouteMap" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListRoutingIntentResult": { "type": "object", "description": "List of the routing intent result and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The RoutingIntent items on this page", "items": { "$ref": "#/definitions/RoutingIntent" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVirtualHubBgpConnectionResults": { "type": "object", "description": "VirtualHubBgpConnections list.", "properties": { "value": { "type": "array", "description": "The BgpConnection items on this page", "items": { "$ref": "#/definitions/BgpConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVirtualHubIpConfigurationResults": { "type": "object", "description": "VirtualHubIpConfigurations list.", "properties": { "value": { "type": "array", "description": "The HubIpConfiguration items on this page", "items": { "$ref": "#/definitions/HubIpConfiguration" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVirtualHubRouteTableV2sResult": { "type": "object", "description": "List of VirtualHubRouteTableV2s and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VirtualHubRouteTableV2 items on this page", "items": { "$ref": "#/definitions/VirtualHubRouteTableV2" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVirtualHubsResult": { "type": "object", "description": "Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VirtualHub items on this page", "items": { "$ref": "#/definitions/VirtualHub" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVirtualWANsResult": { "type": "object", "description": "Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VirtualWAN items on this page", "items": { "$ref": "#/definitions/VirtualWAN" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnConnectionsResult": { "type": "object", "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnConnection items on this page", "items": { "$ref": "#/definitions/VpnConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnGatewayNatRulesResult": { "type": "object", "description": "Result of the request to list all nat rules to a virtual wan vpn gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnGatewayNatRule items on this page", "items": { "$ref": "#/definitions/VpnGatewayNatRule" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnGatewaysResult": { "type": "object", "description": "Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnGateway items on this page", "items": { "$ref": "#/definitions/VpnGateway" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnServerConfigurationPolicyGroupsResult": { "type": "object", "description": "Result of the request to list VpnServerConfigurationPolicyGroups. It contains a list of VpnServerConfigurationPolicyGroups and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnServerConfigurationPolicyGroup items on this page", "items": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnServerConfigurationsResult": { "type": "object", "description": "Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnServerConfiguration items on this page", "items": { "$ref": "#/definitions/VpnServerConfiguration" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnSiteLinkConnectionsResult": { "type": "object", "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnSiteLinkConnection items on this page", "items": { "$ref": "#/definitions/VpnSiteLinkConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnSiteLinksResult": { "type": "object", "description": "Result of the request to list VpnSiteLinks. It contains a list of VpnSiteLinks and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnSiteLink items on this page", "items": { "$ref": "#/definitions/VpnSiteLink" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListVpnSitesResult": { "type": "object", "description": "Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "description": "The VpnSite items on this page", "items": { "$ref": "#/definitions/VpnSite" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "NetworkVirtualApplianceConnection": { "type": "object", "description": "NetworkVirtualApplianceConnection resource.", "properties": { "properties": { "$ref": "#/definitions/NetworkVirtualApplianceConnectionProperties", "description": "Properties of the express route connection.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "The name of the resource." } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "NetworkVirtualApplianceConnectionList": { "type": "object", "description": "NetworkVirtualApplianceConnection list.", "properties": { "value": { "type": "array", "description": "The NetworkVirtualApplianceConnection items on this page", "items": { "$ref": "#/definitions/NetworkVirtualApplianceConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "NetworkVirtualApplianceConnectionProperties": { "type": "object", "description": "Properties of the NetworkVirtualApplianceConnection subresource.", "properties": { "name": { "type": "string", "description": "The name of the resource." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the NetworkVirtualApplianceConnection resource.", "readOnly": true }, "asn": { "type": "integer", "format": "int64", "description": "Network Virtual Appliance ASN.", "minimum": 0, "maximum": 4294967295 }, "tunnelIdentifier": { "type": "integer", "format": "int64", "description": "Unique identifier for the connection.", "minimum": 0, "maximum": 4294967295 }, "bgpPeerAddress": { "type": "array", "description": "List of bgpPeerAddresses for the NVA instances", "items": { "type": "string" } }, "enableInternetSecurity": { "type": "boolean", "description": "Enable internet security." }, "routingConfiguration": { "$ref": "#/definitions/RoutingConfiguration", "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." } } }, "O365BreakOutCategoryPolicies": { "type": "object", "description": "Office365 breakout categories.", "properties": { "allow": { "type": "boolean", "description": "Flag to control allow category." }, "optimize": { "type": "boolean", "description": "Flag to control optimize category." }, "default": { "type": "boolean", "description": "Flag to control default category." } } }, "O365PolicyProperties": { "type": "object", "description": "The Office365 breakout policy.", "properties": { "breakOutCategories": { "$ref": "#/definitions/O365BreakOutCategoryPolicies", "description": "Office365 breakout categories." } } }, "P2SConnectionConfiguration": { "type": "object", "description": "P2SConnectionConfiguration Resource.", "properties": { "properties": { "$ref": "#/definitions/P2SConnectionConfigurationProperties", "description": "Properties of the P2S connection configuration.", "x-ms-client-flatten": true }, "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": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "P2SConnectionConfigurationProperties": { "type": "object", "description": "Parameters for P2SConnectionConfiguration.", "properties": { "vpnClientAddressPool": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "The reference to the address space resource which represents Address space for P2S VpnClient." }, "routingConfiguration": { "$ref": "#/definitions/RoutingConfiguration", "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." }, "enableInternetSecurity": { "type": "boolean", "description": "Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not." }, "configurationPolicyGroupAssociations": { "type": "array", "description": "List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "previousConfigurationPolicyGroupAssociations": { "type": "array", "description": "List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.", "items": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" }, "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the P2SConnectionConfiguration resource.", "readOnly": true } } }, "P2SVpnConnectionHealth": { "type": "object", "description": "P2S Vpn connection detailed health written to sas url.", "properties": { "sasUrl": { "type": "string", "description": "Returned sas url of the blob to which the p2s vpn connection detailed health will be written." } } }, "P2SVpnConnectionHealthRequest": { "type": "object", "description": "List of P2S Vpn connection health request.", "properties": { "vpnUserNamesFilter": { "type": "array", "description": "The list of p2s vpn user names whose p2s vpn connection detailed health to retrieve for.", "items": { "type": "string" } }, "outputBlobSasUrl": { "type": "string", "description": "The sas-url to download the P2S Vpn connection health detail." } } }, "P2SVpnConnectionRequest": { "type": "object", "description": "List of p2s vpn connections to be disconnected.", "properties": { "vpnConnectionIds": { "type": "array", "description": "List of p2s vpn connection Ids.", "items": { "type": "string" } } } }, "P2SVpnGateway": { "type": "object", "description": "P2SVpnGateway Resource.", "properties": { "properties": { "$ref": "#/definitions/P2SVpnGatewayProperties", "description": "Properties of the P2SVpnGateway.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/TrackedResourceWithSettableIdOptionalLocation" } ] }, "P2SVpnGatewayProperties": { "type": "object", "description": "Parameters for P2SVpnGateway.", "properties": { "virtualHub": { "$ref": "./common.json#/definitions/SubResource", "description": "The VirtualHub to which the gateway belongs." }, "p2SConnectionConfigurations": { "type": "array", "description": "List of all p2s connection configurations of the gateway.", "items": { "$ref": "#/definitions/P2SConnectionConfiguration" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the P2S VPN gateway resource.", "readOnly": true }, "vpnGatewayScaleUnit": { "type": "integer", "format": "int32", "description": "The scale unit for this p2s vpn gateway." }, "vpnServerConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "The VpnServerConfiguration to which the p2sVpnGateway is attached to." }, "vpnClientConnectionHealth": { "$ref": "#/definitions/VpnClientConnectionHealth", "description": "All P2S VPN clients' connection health status.", "readOnly": true }, "customDnsServers": { "type": "array", "description": "List of all customer specified DNS servers IP addresses.", "items": { "type": "string" } }, "isRoutingPreferenceInternet": { "type": "boolean", "description": "Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway." } } }, "P2SVpnProfileParameters": { "type": "object", "description": "Vpn Client Parameters for package generation.", "properties": { "authenticationMethod": { "$ref": "./common.json#/definitions/AuthenticationMethod", "description": "VPN client authentication method." } } }, "Parameter": { "type": "object", "description": "Parameters for an Action.", "properties": { "routePrefix": { "type": "array", "description": "List of route prefixes.", "items": { "type": "string" } }, "community": { "type": "array", "description": "List of BGP communities.", "items": { "type": "string" } }, "asPath": { "type": "array", "description": "List of AS paths.", "items": { "type": "string" } } } }, "PeerRoute": { "type": "object", "description": "Peer routing details.", "properties": { "localAddress": { "type": "string", "description": "The peer's local address.", "readOnly": true }, "network": { "type": "string", "description": "The route's network prefix.", "readOnly": true }, "nextHop": { "type": "string", "description": "The route's next hop.", "readOnly": true }, "sourcePeer": { "type": "string", "description": "The peer this route was learned from.", "readOnly": true }, "origin": { "type": "string", "description": "The source this route was learned from.", "readOnly": true }, "asPath": { "type": "string", "description": "The route's AS path sequence.", "readOnly": true }, "weight": { "type": "integer", "format": "int32", "description": "The route's weight.", "readOnly": true } } }, "PropagatedRouteTable": { "type": "object", "description": "The list of RouteTables to advertise the routes to.", "properties": { "labels": { "type": "array", "description": "The list of labels.", "items": { "type": "string" } }, "ids": { "type": "array", "description": "The list of resource ids of all the RouteTables.", "items": { "$ref": "./common.json#/definitions/SubResource" } } } }, "Record": { "type": "object", "additionalProperties": { "items": { "$ref": "#/definitions/PeerRoute" }, "type": "array" } }, "RouteMap": { "type": "object", "description": "The RouteMap child resource of a Virtual hub.", "properties": { "properties": { "$ref": "#/definitions/RouteMapProperties", "description": "Properties of the RouteMap resource.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/ReadOnlySubResourceModel" } ] }, "RouteMapProperties": { "type": "object", "description": "Properties of RouteMap resource", "properties": { "associatedInboundConnections": { "type": "array", "description": "List of connections which have this RoutMap associated for inbound traffic.", "items": { "type": "string" } }, "associatedOutboundConnections": { "type": "array", "description": "List of connections which have this RoutMap associated for outbound traffic.", "items": { "type": "string" } }, "rules": { "type": "array", "description": "List of RouteMap rules to be applied.", "items": { "$ref": "#/definitions/RouteMapRule" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the RouteMap resource.", "readOnly": true } } }, "RouteMapRule": { "type": "object", "description": "A RouteMap Rule.", "properties": { "name": { "type": "string", "description": "The unique name for the rule." }, "matchCriteria": { "type": "array", "description": "List of matching criterion which will be applied to traffic.", "items": { "$ref": "#/definitions/Criterion" }, "x-ms-identifiers": [] }, "actions": { "type": "array", "description": "List of actions which will be applied on a match.", "items": { "$ref": "#/definitions/Action" }, "x-ms-identifiers": [] }, "nextStepIfMatched": { "$ref": "./common.json#/definitions/NextStep", "description": "Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'." } } }, "RoutingConfiguration": { "type": "object", "description": "Routing Configuration indicating the associated and propagated route tables for this connection.", "properties": { "associatedRouteTable": { "$ref": "./common.json#/definitions/SubResource", "description": "The resource id RouteTable associated with this RoutingConfiguration." }, "propagatedRouteTables": { "$ref": "#/definitions/PropagatedRouteTable", "description": "The list of RouteTables to advertise the routes to." }, "vnetRoutes": { "$ref": "#/definitions/VnetRoute", "description": "List of routes that control routing from VirtualHub into a virtual network connection." }, "inboundRouteMap": { "$ref": "./common.json#/definitions/SubResource", "description": "The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes." }, "outboundRouteMap": { "$ref": "./common.json#/definitions/SubResource", "description": "The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes." } } }, "RoutingIntent": { "type": "object", "description": "The routing intent child resource of a Virtual hub.", "properties": { "properties": { "$ref": "#/definitions/RoutingIntentProperties", "description": "Properties of the RoutingIntent resource.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "RoutingIntentProperties": { "type": "object", "description": "The properties of a RoutingIntent resource.", "properties": { "routingPolicies": { "type": "array", "description": "List of routing policies.", "items": { "$ref": "#/definitions/RoutingPolicy" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the RoutingIntent resource.", "readOnly": true } } }, "RoutingPolicy": { "type": "object", "description": "The routing policy object used in a RoutingIntent resource.", "properties": { "name": { "type": "string", "description": "The unique name for the routing policy." }, "destinations": { "type": "array", "description": "List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic).", "items": { "type": "string" } }, "nextHop": { "type": "string", "description": "The next hop resource id on which this routing policy is applicable to." } }, "required": [ "name", "destinations", "nextHop" ] }, "SharedKeyProperties": { "type": "object", "description": "Parameters for SharedKey.", "properties": { "sharedKey": { "type": "string", "format": "password", "description": "The value of the shared key for the vpn link connection.", "x-ms-secret": true }, "sharedKeyLength": { "type": "integer", "format": "int32", "description": "The length of the shared key for the vpn link connection.", "minimum": 1, "maximum": 128 }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the SharedKey resource.", "readOnly": true } } }, "StaticRoute": { "type": "object", "description": "List of all Static Routes.", "properties": { "name": { "type": "string", "description": "The name of the StaticRoute that is unique within a VnetRoute." }, "addressPrefixes": { "type": "array", "description": "List of all address prefixes.", "items": { "type": "string" } }, "nextHopIpAddress": { "type": "string", "description": "The ip address of the next hop." } } }, "StaticRoutesConfig": { "type": "object", "description": "Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.", "properties": { "propagateStaticRoutes": { "type": "boolean", "description": "Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to." }, "vnetLocalRouteOverrideCriteria": { "$ref": "./common.json#/definitions/VnetLocalRouteOverrideCriteria", "description": "Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke." } } }, "VirtualHub": { "type": "object", "description": "VirtualHub Resource.", "properties": { "properties": { "$ref": "#/definitions/VirtualHubProperties", "description": "Properties of the virtual hub.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "kind": { "type": "string", "description": "Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/TrackedResourceWithSettableIdOptionalLocation" } ] }, "VirtualHubEffectiveRoute": { "type": "object", "description": "The effective route configured on the virtual hub or specified resource.", "properties": { "addressPrefixes": { "type": "array", "description": "The list of address prefixes.", "items": { "type": "string" } }, "nextHops": { "type": "array", "description": "The list of next hops.", "items": { "type": "string" } }, "nextHopType": { "type": "string", "description": "The type of the next hop." }, "asPath": { "type": "string", "description": "The ASPath of this route." }, "routeOrigin": { "type": "string", "description": "The origin of this route." } } }, "VirtualHubEffectiveRouteList": { "type": "object", "description": "EffectiveRoutes List.", "properties": { "value": { "type": "array", "description": "The list of effective routes configured on the virtual hub or the specified resource.", "items": { "$ref": "#/definitions/VirtualHubEffectiveRoute" } } } }, "VirtualHubId": { "type": "object", "description": "Virtual Hub identifier.", "properties": { "id": { "type": "string", "description": "The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription." } } }, "VirtualHubProperties": { "type": "object", "description": "Parameters for VirtualHub.", "properties": { "virtualWan": { "$ref": "./common.json#/definitions/SubResource", "description": "The VirtualWAN to which the VirtualHub belongs." }, "vpnGateway": { "$ref": "./common.json#/definitions/SubResource", "description": "The VpnGateway associated with this VirtualHub." }, "p2SVpnGateway": { "$ref": "./common.json#/definitions/SubResource", "description": "The P2SVpnGateway associated with this VirtualHub." }, "expressRouteGateway": { "$ref": "./common.json#/definitions/SubResource", "description": "The expressRouteGateway associated with this VirtualHub." }, "azureFirewall": { "$ref": "./common.json#/definitions/SubResource", "description": "The azureFirewall associated with this VirtualHub." }, "securityPartnerProvider": { "$ref": "./common.json#/definitions/SubResource", "description": "The securityPartnerProvider associated with this VirtualHub." }, "addressPrefix": { "type": "string", "description": "Address-prefix for this VirtualHub." }, "routeTable": { "$ref": "#/definitions/VirtualHubRouteTable", "description": "The routeTable associated with this virtual hub." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual hub resource.", "readOnly": true }, "securityProviderName": { "type": "string", "description": "The Security Provider name." }, "virtualHubRouteTableV2s": { "type": "array", "description": "List of all virtual hub route table v2s associated with this VirtualHub.", "items": { "$ref": "#/definitions/VirtualHubRouteTableV2" } }, "sku": { "type": "string", "description": "The sku of this VirtualHub." }, "routingState": { "$ref": "./common.json#/definitions/RoutingState", "description": "The routing state.", "readOnly": true }, "bgpConnections": { "type": "array", "description": "List of references to Bgp Connections.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "ipConfigurations": { "type": "array", "description": "List of references to IpConfigurations.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "routeMaps": { "type": "array", "description": "List of references to RouteMaps.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "virtualRouterAsn": { "type": "integer", "format": "int64", "description": "VirtualRouter ASN.", "minimum": 0, "maximum": 4294967295 }, "virtualRouterIps": { "type": "array", "description": "VirtualRouter IPs.", "items": { "type": "string" } }, "addressPrefixV6": { "type": "string", "description": "IPv6 Address-prefix for this VirtualHub." }, "virtualRouterIpsV6": { "type": "array", "description": "VirtualRouter IPv6 IPs.", "items": { "type": "string" } }, "allowBranchToBranchTraffic": { "type": "boolean", "description": "Flag to control transit for VirtualRouter hub." }, "preferredRoutingGateway": { "$ref": "./common.json#/definitions/PreferredRoutingGateway", "description": "The preferred gateway to route on-prem traffic" }, "hubRoutingPreference": { "$ref": "./common.json#/definitions/HubRoutingPreference", "description": "The hubRoutingPreference of this VirtualHub." }, "virtualRouterAutoScaleConfiguration": { "$ref": "#/definitions/VirtualRouterAutoScaleConfiguration", "description": "The VirtualHub Router autoscale configuration." } } }, "VirtualHubRoute": { "type": "object", "description": "VirtualHub route.", "properties": { "addressPrefixes": { "type": "array", "description": "List of all addressPrefixes.", "items": { "type": "string" } }, "nextHopIpAddress": { "type": "string", "description": "NextHop ip address." } } }, "VirtualHubRouteTable": { "type": "object", "description": "VirtualHub route table.", "properties": { "routes": { "type": "array", "description": "List of all routes.", "items": { "$ref": "#/definitions/VirtualHubRoute" } } } }, "VirtualHubRouteTableV2": { "type": "object", "description": "VirtualHubRouteTableV2 Resource.", "properties": { "properties": { "$ref": "#/definitions/VirtualHubRouteTableV2Properties", "description": "Properties of the virtual hub route table v2.", "x-ms-client-flatten": true }, "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": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "VirtualHubRouteTableV2Properties": { "type": "object", "description": "Parameters for VirtualHubRouteTableV2.", "properties": { "routes": { "type": "array", "description": "List of all routes.", "items": { "$ref": "#/definitions/VirtualHubRouteV2" } }, "attachedConnections": { "type": "array", "description": "List of all connections attached to this route table v2.", "items": { "type": "string" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual hub route table v2 resource.", "readOnly": true } } }, "VirtualHubRouteV2": { "type": "object", "description": "VirtualHubRouteTableV2 route.", "properties": { "destinationType": { "type": "string", "description": "The type of destinations." }, "destinations": { "type": "array", "description": "List of all destinations.", "items": { "type": "string" } }, "nextHopType": { "type": "string", "description": "The type of next hops." }, "nextHops": { "type": "array", "description": "NextHops ip address.", "items": { "type": "string" } } } }, "VirtualRouterAutoScaleConfiguration": { "type": "object", "description": "The VirtualHub Router autoscale configuration.", "properties": { "minCapacity": { "type": "integer", "format": "int32", "description": "The minimum number of scale units for VirtualHub Router.", "minimum": 0 } } }, "VirtualWAN": { "type": "object", "description": "VirtualWAN Resource.", "properties": { "properties": { "$ref": "#/definitions/VirtualWanProperties", "description": "Properties of the virtual WAN.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/TrackedResourceWithSettableIdOptionalLocation" } ] }, "VirtualWanProperties": { "type": "object", "description": "Parameters for VirtualWAN.", "properties": { "disableVpnEncryption": { "type": "boolean", "description": "Vpn encryption to be disabled or not." }, "virtualHubs": { "type": "array", "description": "List of VirtualHubs in the VirtualWAN.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "vpnSites": { "type": "array", "description": "List of VpnSites in the VirtualWAN.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "allowBranchToBranchTraffic": { "type": "boolean", "description": "True if branch to branch traffic is allowed." }, "allowVnetToVnetTraffic": { "type": "boolean", "description": "True if Vnet to Vnet traffic is allowed." }, "office365LocalBreakoutCategory": { "$ref": "./common.json#/definitions/OfficeTrafficCategory", "description": "The office local breakout category.", "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual WAN resource.", "readOnly": true }, "type": { "type": "string", "description": "The type of the VirtualWAN." } } }, "VirtualWanSecurityProvider": { "type": "object", "description": "Collection of SecurityProviders.", "properties": { "name": { "type": "string", "description": "Name of the security provider." }, "url": { "type": "string", "description": "Url of the security provider." }, "type": { "$ref": "./common.json#/definitions/VirtualWanSecurityProviderType", "description": "Name of the security provider.", "readOnly": true } } }, "VirtualWanSecurityProviders": { "type": "object", "description": "Collection of SecurityProviders.", "properties": { "supportedProviders": { "type": "array", "description": "List of VirtualWAN security providers.", "items": { "$ref": "#/definitions/VirtualWanSecurityProvider" } } } }, "VirtualWanVpnProfileParameters": { "type": "object", "description": "Virtual Wan Vpn profile parameters Vpn profile generation.", "properties": { "vpnServerConfigurationResourceId": { "type": "string", "description": "VpnServerConfiguration partial resource uri with which VirtualWan is associated to." }, "authenticationMethod": { "$ref": "./common.json#/definitions/AuthenticationMethod", "description": "VPN client authentication method." } } }, "VnetRoute": { "type": "object", "description": "List of routes that control routing from VirtualHub into a virtual network connection.", "properties": { "staticRoutesConfig": { "$ref": "#/definitions/StaticRoutesConfig", "description": "Configuration for static routes on this HubVnetConnection." }, "staticRoutes": { "type": "array", "description": "List of all Static Routes.", "items": { "$ref": "#/definitions/StaticRoute" } }, "bgpConnections": { "type": "array", "description": "The list of references to HubBgpConnection objects.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true } } }, "VpnClientConnectionHealth": { "type": "object", "description": "VpnClientConnectionHealth properties.", "properties": { "totalIngressBytesTransferred": { "type": "integer", "format": "int64", "description": "Total of the Ingress Bytes Transferred in this P2S Vpn connection.", "readOnly": true }, "totalEgressBytesTransferred": { "type": "integer", "format": "int64", "description": "Total of the Egress Bytes Transferred in this connection.", "readOnly": true }, "vpnClientConnectionsCount": { "type": "integer", "format": "int32", "description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway." }, "allocatedIpAddresses": { "type": "array", "description": "List of allocated ip addresses to the connected p2s vpn clients.", "items": { "type": "string" } } } }, "VpnConnection": { "type": "object", "description": "VpnConnection Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnConnectionProperties", "description": "Properties of the VPN connection.", "x-ms-client-flatten": true }, "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": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "VpnConnectionPacketCaptureStartParameters": { "type": "object", "description": "Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.", "properties": { "filterData": { "type": "string", "description": "Start Packet capture parameters on vpn connection." }, "linkConnectionNames": { "type": "array", "description": "List of site link connection names.", "items": { "type": "string" } } } }, "VpnConnectionPacketCaptureStopParameters": { "type": "object", "description": "Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection.", "properties": { "sasUrl": { "type": "string", "description": "SAS url for packet capture on vpn connection." }, "linkConnectionNames": { "type": "array", "description": "List of site link connection names.", "items": { "type": "string" } } } }, "VpnConnectionProperties": { "type": "object", "description": "Parameters for VpnConnection.", "properties": { "remoteVpnSite": { "$ref": "./common.json#/definitions/SubResource", "description": "Id of the connected vpn site." }, "routingWeight": { "type": "integer", "format": "int32", "description": "Routing weight for vpn connection." }, "dpdTimeoutSeconds": { "type": "integer", "format": "int32", "description": "DPD timeout in seconds for vpn connection." }, "connectionStatus": { "$ref": "./common.json#/definitions/VpnConnectionStatus", "description": "The connection status.", "readOnly": true }, "vpnConnectionProtocolType": { "$ref": "./common.json#/definitions/VirtualNetworkGatewayConnectionProtocol", "description": "Connection protocol used for this connection." }, "ingressBytesTransferred": { "type": "integer", "format": "int64", "description": "Ingress bytes transferred.", "readOnly": true }, "egressBytesTransferred": { "type": "integer", "format": "int64", "description": "Egress bytes transferred.", "readOnly": true }, "connectionBandwidth": { "type": "integer", "format": "int32", "description": "Expected bandwidth in MBPS." }, "sharedKey": { "type": "string", "description": "Deprecated: SharedKey for the vpn connection. This is no more used." }, "enableBgp": { "type": "boolean", "description": "EnableBgp flag." }, "usePolicyBasedTrafficSelectors": { "type": "boolean", "description": "Enable policy-based traffic selectors." }, "ipsecPolicies": { "type": "array", "description": "The IPSec Policies to be considered by this connection.", "items": { "$ref": "./networkGateway.json#/definitions/IpsecPolicy" } }, "trafficSelectorPolicies": { "type": "array", "description": "The Traffic Selector Policies to be considered by this connection.", "items": { "$ref": "./networkGateway.json#/definitions/TrafficSelectorPolicy" } }, "enableRateLimiting": { "type": "boolean", "description": "EnableBgp flag." }, "enableInternetSecurity": { "type": "boolean", "description": "Enable internet security." }, "useLocalAzureIpAddress": { "type": "boolean", "description": "Use local azure ip to initiate connection." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN connection resource.", "readOnly": true }, "vpnLinkConnections": { "type": "array", "description": "List of all vpn site link connections to the gateway.", "items": { "$ref": "#/definitions/VpnSiteLinkConnection" } }, "routingConfiguration": { "$ref": "#/definitions/RoutingConfiguration", "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." } } }, "VpnGateway": { "type": "object", "description": "VpnGateway Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnGatewayProperties", "description": "Properties of the VPN gateway.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/TrackedResourceWithSettableIdOptionalLocation" } ] }, "VpnGatewayIpConfiguration": { "type": "object", "description": "IP Configuration of a VPN Gateway Resource.", "properties": { "id": { "type": "string", "description": "The identifier of the IP configuration for a VPN Gateway." }, "publicIpAddress": { "type": "string", "description": "The public IP address of this IP configuration." }, "privateIpAddress": { "type": "string", "description": "The private IP address of this IP configuration." } } }, "VpnGatewayNatRule": { "type": "object", "description": "VpnGatewayNatRule Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnGatewayNatRuleProperties", "description": "Properties of the VpnGateway NAT rule.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "VpnGatewayNatRuleProperties": { "type": "object", "description": "Parameters for VpnGatewayNatRule.", "properties": { "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the NAT Rule resource.", "readOnly": true }, "type": { "$ref": "./common.json#/definitions/VpnNatRuleType", "description": "The type of NAT rule for VPN NAT." }, "mode": { "$ref": "./common.json#/definitions/VpnNatRuleMode", "description": "The Source NAT direction of a VPN NAT." }, "internalMappings": { "type": "array", "description": "The private IP address internal mapping for NAT.", "items": { "$ref": "#/definitions/VpnNatRuleMapping" } }, "externalMappings": { "type": "array", "description": "The private IP address external mapping for NAT.", "items": { "$ref": "#/definitions/VpnNatRuleMapping" } }, "ipConfigurationId": { "type": "string", "description": "The IP Configuration ID this NAT rule applies to." }, "egressVpnSiteLinkConnections": { "type": "array", "description": "List of egress VpnSiteLinkConnections.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "ingressVpnSiteLinkConnections": { "type": "array", "description": "List of ingress VpnSiteLinkConnections.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true } } }, "VpnGatewayPacketCaptureStartParameters": { "type": "object", "description": "Start packet capture parameters.", "properties": { "filterData": { "type": "string", "description": "Start Packet capture parameters on vpn gateway." } } }, "VpnGatewayPacketCaptureStopParameters": { "type": "object", "description": "Stop packet capture parameters.", "properties": { "sasUrl": { "type": "string", "description": "SAS url for packet capture on vpn gateway." } } }, "VpnGatewayProperties": { "type": "object", "description": "Parameters for VpnGateway.", "properties": { "virtualHub": { "$ref": "./common.json#/definitions/SubResource", "description": "The VirtualHub to which the gateway belongs." }, "connections": { "type": "array", "description": "List of all vpn connections to the gateway.", "items": { "$ref": "#/definitions/VpnConnection" } }, "bgpSettings": { "$ref": "./networkGateway.json#/definitions/BgpSettings", "description": "Local network gateway's BGP speaker settings." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN gateway resource.", "readOnly": true }, "vpnGatewayScaleUnit": { "type": "integer", "format": "int32", "description": "The scale unit for this vpn gateway." }, "ipConfigurations": { "type": "array", "description": "List of all IPs configured on the gateway.", "items": { "$ref": "#/definitions/VpnGatewayIpConfiguration" }, "readOnly": true }, "enableBgpRouteTranslationForNat": { "type": "boolean", "description": "Enable BGP routes translation for NAT on this VpnGateway." }, "isRoutingPreferenceInternet": { "type": "boolean", "description": "Enable Routing Preference property for the Public IP Interface of the VpnGateway." }, "natRules": { "type": "array", "description": "List of all the nat Rules associated with the gateway.", "items": { "$ref": "#/definitions/VpnGatewayNatRule" } } } }, "VpnLinkBgpSettings": { "type": "object", "description": "BGP settings details for a link.", "properties": { "asn": { "type": "integer", "format": "int64", "description": "The BGP speaker's ASN." }, "bgpPeeringAddress": { "type": "string", "description": "The BGP peering address and BGP identifier of this BGP speaker." } } }, "VpnLinkProviderProperties": { "type": "object", "description": "List of properties of a link provider.", "properties": { "linkProviderName": { "type": "string", "description": "Name of the link provider." }, "linkSpeedInMbps": { "type": "integer", "format": "int32", "description": "Link speed." } } }, "VpnNatRuleMapping": { "type": "object", "description": "Vpn NatRule mapping.", "properties": { "addressSpace": { "type": "string", "description": "Address space for Vpn NatRule mapping." }, "portRange": { "type": "string", "description": "Port range for Vpn NatRule mapping." } } }, "VpnProfileResponse": { "type": "object", "description": "Vpn Profile Response for package generation.", "properties": { "profileUrl": { "type": "string", "description": "URL to the VPN profile." } } }, "VpnServerConfigRadiusClientRootCertificate": { "type": "object", "description": "Properties of the Radius client root certificate of VpnServerConfiguration.", "properties": { "name": { "type": "string", "description": "The certificate name." }, "thumbprint": { "type": "string", "description": "The Radius client root certificate thumbprint." } } }, "VpnServerConfigRadiusServerRootCertificate": { "type": "object", "description": "Properties of Radius Server root certificate of VpnServerConfiguration.", "properties": { "name": { "type": "string", "description": "The certificate name." }, "publicCertData": { "type": "string", "description": "The certificate public data." } } }, "VpnServerConfigVpnClientRevokedCertificate": { "type": "object", "description": "Properties of the revoked VPN client certificate of VpnServerConfiguration.", "properties": { "name": { "type": "string", "description": "The certificate name." }, "thumbprint": { "type": "string", "description": "The revoked VPN client certificate thumbprint." } } }, "VpnServerConfigVpnClientRootCertificate": { "type": "object", "description": "Properties of VPN client root certificate of VpnServerConfiguration.", "properties": { "name": { "type": "string", "description": "The certificate name." }, "publicCertData": { "type": "string", "description": "The certificate public data." } } }, "VpnServerConfiguration": { "type": "object", "description": "VpnServerConfiguration Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnServerConfigurationProperties", "description": "Properties of the P2SVpnServer configuration.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/TrackedResourceWithSettableName" } ] }, "VpnServerConfigurationPolicyGroup": { "type": "object", "description": "VpnServerConfigurationPolicyGroup Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroupProperties", "description": "Properties of the VpnServerConfigurationPolicyGroup.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "VpnServerConfigurationPolicyGroupMember": { "type": "object", "description": "VpnServerConfiguration PolicyGroup member", "properties": { "name": { "type": "string", "description": "Name of the VpnServerConfigurationPolicyGroupMember." }, "attributeType": { "$ref": "./common.json#/definitions/VpnPolicyMemberAttributeType", "description": "The Vpn Policy member attribute type." }, "attributeValue": { "type": "string", "description": "The value of Attribute used for this VpnServerConfigurationPolicyGroupMember." } } }, "VpnServerConfigurationPolicyGroupProperties": { "type": "object", "description": "Parameters for VpnServerConfigurationPolicyGroup.", "properties": { "isDefault": { "type": "boolean", "description": "Shows if this is a Default VpnServerConfigurationPolicyGroup or not." }, "priority": { "type": "integer", "format": "int32", "description": "Priority for VpnServerConfigurationPolicyGroup." }, "policyMembers": { "type": "array", "description": "Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.", "items": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroupMember" }, "x-ms-identifiers": [] }, "p2SConnectionConfigurations": { "type": "array", "description": "List of references to P2SConnectionConfigurations.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the VpnServerConfigurationPolicyGroup resource.", "readOnly": true } } }, "VpnServerConfigurationProperties": { "type": "object", "description": "Parameters for VpnServerConfiguration.", "properties": { "name": { "type": "string", "description": "The name of the VpnServerConfiguration that is unique within a resource group." }, "vpnProtocols": { "type": "array", "description": "VPN protocols for the VpnServerConfiguration.", "items": { "$ref": "./common.json#/definitions/VpnGatewayTunnelingProtocol" } }, "vpnAuthenticationTypes": { "type": "array", "description": "VPN authentication types for the VpnServerConfiguration.", "items": { "$ref": "./common.json#/definitions/VpnAuthenticationType" } }, "vpnClientRootCertificates": { "type": "array", "description": "VPN client root certificate of VpnServerConfiguration.", "items": { "$ref": "#/definitions/VpnServerConfigVpnClientRootCertificate" } }, "vpnClientRevokedCertificates": { "type": "array", "description": "VPN client revoked certificate of VpnServerConfiguration.", "items": { "$ref": "#/definitions/VpnServerConfigVpnClientRevokedCertificate" } }, "radiusServerRootCertificates": { "type": "array", "description": "Radius Server root certificate of VpnServerConfiguration.", "items": { "$ref": "#/definitions/VpnServerConfigRadiusServerRootCertificate" } }, "radiusClientRootCertificates": { "type": "array", "description": "Radius client root certificate of VpnServerConfiguration.", "items": { "$ref": "#/definitions/VpnServerConfigRadiusClientRootCertificate" } }, "vpnClientIpsecPolicies": { "type": "array", "description": "VpnClientIpsecPolicies for VpnServerConfiguration.", "items": { "$ref": "./networkGateway.json#/definitions/IpsecPolicy" } }, "radiusServerAddress": { "type": "string", "description": "The radius server address property of the VpnServerConfiguration resource for point to site client connection." }, "radiusServerSecret": { "type": "string", "format": "password", "description": "The radius secret property of the VpnServerConfiguration resource for point to site client connection. We will no longer return radiusServerSecret in VpnServerConfiguration Create/Update/Get/List/UpdateTags APIs response. Please use VpnServerConfiguration ListRadiusSecrets API to fetch radius server secrets.", "x-ms-secret": true }, "radiusServers": { "type": "array", "description": "Multiple Radius Server configuration for VpnServerConfiguration.", "items": { "$ref": "./networkGateway.json#/definitions/RadiusServer" } }, "aadAuthenticationParameters": { "$ref": "#/definitions/AadAuthenticationParameters", "description": "The set of aad vpn authentication parameters." }, "provisioningState": { "type": "string", "description": "The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.", "readOnly": true }, "p2SVpnGateways": { "type": "array", "description": "List of references to P2SVpnGateways.", "items": { "$ref": "#/definitions/P2SVpnGateway" }, "readOnly": true }, "configurationPolicyGroups": { "type": "array", "description": "List of all VpnServerConfigurationPolicyGroups.", "items": { "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" } }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } } }, "VpnServerConfigurationsResponse": { "type": "object", "description": "VpnServerConfigurations list associated with VirtualWan Response.", "properties": { "vpnServerConfigurationResourceIds": { "type": "array", "description": "List of VpnServerConfigurations associated with VirtualWan.", "items": { "type": "string" } } } }, "VpnSite": { "type": "object", "description": "VpnSite Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnSiteProperties", "description": "Properties of the VPN site.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/TrackedResourceWithSettableIdOptionalLocation" } ] }, "VpnSiteLink": { "type": "object", "description": "VpnSiteLink Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnSiteLinkProperties", "description": "Properties of the VPN site link.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "VpnSiteLinkConnection": { "type": "object", "description": "VpnSiteLinkConnection Resource.", "properties": { "properties": { "$ref": "#/definitions/VpnSiteLinkConnectionProperties", "description": "Properties of the VPN site link connection.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "VpnSiteLinkConnectionProperties": { "type": "object", "description": "Parameters for VpnConnection.", "properties": { "vpnSiteLink": { "$ref": "./common.json#/definitions/SubResource", "description": "Id of the connected vpn site link." }, "routingWeight": { "type": "integer", "format": "int32", "description": "Routing weight for vpn connection." }, "vpnLinkConnectionMode": { "$ref": "./common.json#/definitions/VpnLinkConnectionMode", "description": "Vpn link connection mode." }, "connectionStatus": { "$ref": "./common.json#/definitions/VpnConnectionStatus", "description": "The connection status.", "readOnly": true }, "vpnConnectionProtocolType": { "$ref": "./common.json#/definitions/VirtualNetworkGatewayConnectionProtocol", "description": "Connection protocol used for this connection." }, "ingressBytesTransferred": { "type": "integer", "format": "int64", "description": "Ingress bytes transferred.", "readOnly": true }, "egressBytesTransferred": { "type": "integer", "format": "int64", "description": "Egress bytes transferred.", "readOnly": true }, "connectionBandwidth": { "type": "integer", "format": "int32", "description": "Expected bandwidth in MBPS." }, "sharedKey": { "type": "string", "format": "password", "description": "SharedKey for the vpn link connection. We will no longer return sharedKey in any Create/Update/Get/List/UpdateTags VpnGateway/VpnConnection/VpnLinkConnection APIs response. Please use 'Vpn Link Connections - List Default Shared Key' API to fetch Vpn link connection sharedKey.", "x-ms-secret": true }, "enableBgp": { "type": "boolean", "description": "EnableBgp flag." }, "vpnGatewayCustomBgpAddresses": { "type": "array", "description": "vpnGatewayCustomBgpAddresses used by this connection.", "items": { "$ref": "./networkGateway.json#/definitions/GatewayCustomBgpIpAddressIpConfiguration" }, "x-ms-identifiers": [] }, "usePolicyBasedTrafficSelectors": { "type": "boolean", "description": "Enable policy-based traffic selectors." }, "ipsecPolicies": { "type": "array", "description": "The IPSec Policies to be considered by this connection.", "items": { "$ref": "./networkGateway.json#/definitions/IpsecPolicy" } }, "enableRateLimiting": { "type": "boolean", "description": "EnableBgp flag." }, "useLocalAzureIpAddress": { "type": "boolean", "description": "Use local azure ip to initiate connection." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN site link connection resource.", "readOnly": true }, "ingressNatRules": { "type": "array", "description": "List of ingress NatRules.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "egressNatRules": { "type": "array", "description": "List of egress NatRules.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "dpdTimeoutSeconds": { "type": "integer", "format": "int32", "description": "Dead Peer Detection timeout in seconds for VpnLink connection." } } }, "VpnSiteLinkProperties": { "type": "object", "description": "Parameters for VpnSite.", "properties": { "linkProperties": { "$ref": "#/definitions/VpnLinkProviderProperties", "description": "The link provider properties." }, "ipAddress": { "type": "string", "description": "The ip-address for the vpn-site-link." }, "fqdn": { "type": "string", "description": "FQDN of vpn-site-link." }, "bgpProperties": { "$ref": "#/definitions/VpnLinkBgpSettings", "description": "The set of bgp properties." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN site link resource.", "readOnly": true } } }, "VpnSiteProperties": { "type": "object", "description": "Parameters for VpnSite.", "properties": { "virtualWan": { "$ref": "./common.json#/definitions/SubResource", "description": "The VirtualWAN to which the vpnSite belongs." }, "deviceProperties": { "$ref": "#/definitions/DeviceProperties", "description": "The device properties." }, "ipAddress": { "type": "string", "description": "The ip-address for the vpn-site." }, "siteKey": { "type": "string", "description": "The key for vpn-site that can be used for connections." }, "addressSpace": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "The AddressSpace that contains an array of IP address ranges." }, "bgpProperties": { "$ref": "./networkGateway.json#/definitions/BgpSettings", "description": "The set of bgp properties." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN site resource.", "readOnly": true }, "isSecuritySite": { "type": "boolean", "description": "IsSecuritySite flag." }, "vpnSiteLinks": { "type": "array", "description": "List of all vpn site links.", "items": { "$ref": "#/definitions/VpnSiteLink" } }, "o365Policy": { "$ref": "#/definitions/O365PolicyProperties", "description": "Office365 Policy." } } } }, "parameters": {} }