VirtualWANAsAServiceManagementClient
REST API for Azure VirtualWAN As a Service
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "REST API for Azure VirtualWAN As a Service.",
"title": "VirtualWANAsAServiceManagementClient",
"version": "2019-07-01",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/virtualWan.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "network-virtualWan",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways": {
"get": {
"description": "Lists all the P2SVpnGateways in a subscription.",
"operationId": "P2sVpnGateways_List",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the P2SVpnGateways in the subscription.",
"schema": {
"$ref": "#/definitions/ListP2SVpnGatewaysResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnGatewayListBySubscription": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2",
"location": "West US",
"name": "p2sVpnGateway2",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.4.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": {
"get": {
"description": "Lists all the VirtualHubs in a subscription.",
"operationId": "VirtualHubs_List",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the VirtualHubs in the subscription.",
"schema": {
"$ref": "#/definitions/ListVirtualHubsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualHubList": {
"parameters": {
"api-version": "2019-07-01",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
"location": "West US",
"name": "virtualHub1",
"properties": {
"addressPrefix": "10.10.1.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1",
"name": "connection1",
"properties": {
"allowHubToRemoteVnetTransit": true,
"allowRemoteVnetToUseHubVnetGateways": false,
"provisioningState": "Succeeded",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
}
}
}
],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"type": "Microsoft.Network/virtualHubs"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2",
"location": "East US",
"name": "virtualHub2",
"properties": {
"addressPrefix": "210.10.1.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubVirtualNetworkConnections/connection2",
"name": "connection2",
"properties": {
"allowHubToRemoteVnetTransit": true,
"allowRemoteVnetToUseHubVnetGateways": false,
"provisioningState": "Succeeded",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/SpokeVnet2"
}
}
}
],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"type": "Microsoft.Network/virtualHubs"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": {
"get": {
"description": "Lists all the VirtualWANs in a subscription.",
"operationId": "VirtualWans_List",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the VirtualWANs in the subscription.",
"schema": {
"$ref": "#/definitions/ListVirtualWANsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualWANList": {
"parameters": {
"api-version": "2019-07-01",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
"location": "West US",
"name": "wan1",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/virtualWANs"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan2",
"location": "East US",
"name": "wan2",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/virtualWANs"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": {
"get": {
"description": "Lists all the VpnGateways in a subscription.",
"operationId": "VpnGateways_List",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the VpnGateways in the subscription.",
"schema": {
"$ref": "#/definitions/ListVpnGatewaysResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnGatewayListBySubscription": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
"location": "West US",
"name": "gateway1",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
"name": "Connection-Link2",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"type": "Microsoft.Network/vpnGateways"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2",
"location": "West US",
"name": "gateway2",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2",
"name": "vpnConnection1",
"properties": {
"connectionBandwidth": 100,
"connectionStatus": "Connected",
"egressBytesTransferred": 0,
"enableBgp": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2"
},
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2"
}
},
"type": "Microsoft.Network/vpnGateways"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": {
"get": {
"description": "Lists all the VpnSites in a subscription.",
"operationId": "VpnSites_List",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the VpnSites in the subscription.",
"schema": {
"$ref": "#/definitions/ListVpnSitesResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteList": {
"parameters": {
"api-version": "2019-07-01",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"location": "West US",
"name": "vpnSite1",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"deviceProperties": {
"linkSpeedInMbps": 0
},
"isSecuritySite": false,
"provisioningState": "Succeeded",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"vpnSiteLinks": [
{
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkSpeedInMbps": 0
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/vpnSites/vpnSiteLinks"
}
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/vpnSites"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2",
"location": "East US",
"name": "vpnSite2",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"deviceProperties": {
"deviceModel": "model01",
"deviceVendor": "vendor1",
"linkSpeedInMbps": 200
},
"ipAddress": "10.1.0.0",
"isSecuritySite": false,
"provisioningState": "Succeeded",
"virtualWan": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1"
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/vpnSites"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways": {
"get": {
"description": "Lists all the P2SVpnGateways in a resource group.",
"operationId": "P2sVpnGateways_ListByResourceGroup",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the P2SVpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the P2SVpnGateways in the resource group.",
"schema": {
"$ref": "#/definitions/ListP2SVpnGatewaysResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnGatewayListByResourceGroup": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2",
"location": "West US",
"name": "p2sVpnGateway2",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.4.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}": {
"delete": {
"description": "Deletes a virtual wan p2s vpn gateway.",
"operationId": "P2sVpnGateways_Delete",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the P2SVpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. P2SVpnGateway deleted."
},
"202": {
"description": "Request received successfully. P2SVpnGateway deletion is in progress; follow the Location header to poll for final outcome."
},
"204": {
"description": "No p2s vpn gateways exist by the name provided."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnGatewayDelete": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "p2sVpnGateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"description": "Retrieves the details of a virtual wan p2s vpn gateway.",
"operationId": "P2sVpnGateways_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the P2SVpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.",
"schema": {
"$ref": "#/definitions/P2SVpnGateway"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnGatewayGet": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "p2sVpnGateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
}
}
}
}
}
},
"patch": {
"description": "Updates virtual wan p2s vpn gateway tags.",
"operationId": "P2sVpnGateways_UpdateTags",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the P2SVpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to update a virtual wan p2s vpn gateway tags.",
"in": "body",
"name": "p2SVpnGatewayParameters",
"required": true,
"schema": {
"description": "Tags object for patch operations.",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
}
}
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the updated gateway.",
"schema": {
"$ref": "#/definitions/P2SVpnGateway"
}
},
"201": {
"description": "Request received successfully. Returns the details of the updated gateway.",
"schema": {
"$ref": "#/definitions/P2SVpnGateway"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"tags": [
"P2SVpnGateways"
],
"x-ms-examples": {
"P2SVpnGatewayUpdate": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "p2sVpnGateway1",
"p2SVpnGatewayParameters": {
"tags": {
"tag1": "value1",
"tag2": "value2"
}
},
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/p2sVpnGateways"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/p2sVpnGateways"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.",
"operationId": "P2sVpnGateways_CreateOrUpdate",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the P2SVpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to create or Update a virtual wan p2s vpn gateway.",
"in": "body",
"name": "p2SVpnGatewayParameters",
"required": true,
"schema": {
"$ref": "#/definitions/P2SVpnGateway"
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the virtual wan p2s vpn Gateway created or updated.",
"schema": {
"$ref": "#/definitions/P2SVpnGateway"
}
},
"201": {
"description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.",
"schema": {
"$ref": "#/definitions/P2SVpnGateway"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnGatewayPut": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "p2sVpnGateway1",
"p2SVpnGatewayParameters": {
"location": "West US",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnGatewayScaleUnit": 1
},
"tags": {
"key1": "value1"
}
},
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [],
"totalEgressBytesTransferred": 0,
"totalIngressBytesTransferred": 0,
"vpnClientConnectionsCount": 0
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [],
"totalEgressBytesTransferred": 0,
"totalIngressBytesTransferred": 0,
"vpnClientConnectionsCount": 0
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile": {
"post": {
"description": "Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.",
"operationId": "P2sVpnGateways_GenerateVpnProfile",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the P2SVpnGateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to the generate P2SVpnGateway VPN client package operation.",
"in": "body",
"name": "parameters",
"required": true,
"schema": {
"$ref": "#/definitions/P2SVpnProfileParameters"
}
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "VPN profile package URL.",
"schema": {
"$ref": "#/definitions/VpnProfileResponse"
}
},
"202": {
"description": "Accepted and the operation will complete asynchronously."
}
},
"tags": [
"P2SVpnGateways"
],
"x-ms-examples": {
"GenerateP2SVpnGatewayVPNProfile": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "p2sVpnGateway1",
"parameters": {
"authenticationMethod": "EAPTLS"
},
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": ""
},
"202": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth": {
"post": {
"description": "Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.",
"operationId": "P2sVpnGateways_GetP2sVpnConnectionHealth",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the P2SVpnGateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "P2S Vpn Gateway with P2S connection health details.",
"schema": {
"$ref": "#/definitions/P2SVpnGateway"
}
},
"202": {
"description": "Accepted and the operation will complete asynchronously."
}
},
"tags": [
"P2SVpnGateways"
],
"x-ms-examples": {
"P2SVpnGatewayGetConnectionHealth": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "p2sVpnGateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
"location": "West US",
"name": "p2sVpnGateway1",
"properties": {
"customRoutes": {
"addressPrefixes": [
"101.168.0.6/32"
]
},
"p2SVpnServerConfiguration": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1"
},
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
},
"vpnClientAddressPool": {
"addressPrefixes": [
"101.3.0.0/16"
]
},
"vpnClientConnectionHealth": {
"allocatedIpAddresses": [
"1.1.1.1",
"2.2.2.2"
],
"totalEgressBytesTransferred": 3000,
"totalIngressBytesTransferred": 2000,
"vpnClientConnectionsCount": 2
},
"vpnGatewayScaleUnit": 1
},
"type": "Microsoft.Network/p2sVpnGateways"
}
},
"202": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs": {
"get": {
"description": "Lists all the VirtualHubs in a resource group.",
"operationId": "VirtualHubs_ListByResourceGroup",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualHub.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the VirtualHubs in the resource group.",
"schema": {
"$ref": "#/definitions/ListVirtualHubsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualHubListByResourceGroup": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
"location": "West US",
"name": "virtualHub1",
"properties": {
"addressPrefix": "10.10.1.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1",
"name": "connection1",
"properties": {
"allowHubToRemoteVnetTransit": true,
"allowRemoteVnetToUseHubVnetGateways": false,
"provisioningState": "Succeeded",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"
}
}
}
],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"type": "Microsoft.Network/virtualHubs"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
"location": "East US",
"name": "virtualHub2",
"properties": {
"addressPrefix": "210.10.1.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubVirtualNetworkConnections/connection2",
"name": "connection2",
"properties": {
"allowHubToRemoteVnetTransit": true,
"allowRemoteVnetToUseHubVnetGateways": false,
"provisioningState": "Succeeded",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/SpokeVnet2"
}
}
}
],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"type": "Microsoft.Network/virtualHubs"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": {
"delete": {
"description": "Deletes a VirtualHub.",
"operationId": "VirtualHubs_Delete",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualHub.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualHub.",
"in": "path",
"name": "virtualHubName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. VirtualHub deleted."
},
"202": {
"description": "Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome."
},
"204": {
"description": "No VirtualHubs exist by the name provided."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualHubDelete": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualHubName": "virtualHub1"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"description": "Retrieves the details of a VirtualHub.",
"operationId": "VirtualHubs_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualHub.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualHub.",
"in": "path",
"name": "virtualHubName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VirtualHub retrieved.",
"schema": {
"$ref": "#/definitions/VirtualHub"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualHubGet": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualHubName": "virtualHub1"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
"location": "West US",
"name": "virtualHub1",
"properties": {
"addressPrefix": "10.10.1.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"type": "Microsoft.Network/virtualHubs"
}
}
}
}
}
},
"patch": {
"description": "Updates VirtualHub tags.",
"operationId": "VirtualHubs_UpdateTags",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualHub.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualHub.",
"in": "path",
"name": "virtualHubName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to update VirtualHub tags.",
"in": "body",
"name": "virtualHubParameters",
"required": true,
"schema": {
"description": "Tags object for patch operations.",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
}
}
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VirtualHub updated.",
"schema": {
"$ref": "#/definitions/VirtualHub"
}
},
"201": {
"description": "Request received successfully. Returns the details of the VirtualHub updated.",
"schema": {
"$ref": "#/definitions/VirtualHub"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"tags": [
"VirtualWANs"
],
"x-ms-examples": {
"VirtualHubUpdate": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualHubName": "virtualHub2",
"virtualHubParameters": {
"tags": {
"key1": "value1",
"key2": "value2"
}
}
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
"location": "West US",
"name": "virtualHub2",
"properties": {
"addressPrefix": "10.168.0.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/virtualHubs"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
"location": "West US",
"name": "virtualHub2",
"properties": {
"addressPrefix": "10.168.0.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/virtualHubs"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.",
"operationId": "VirtualHubs_CreateOrUpdate",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualHub.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualHub.",
"in": "path",
"name": "virtualHubName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to create or update VirtualHub.",
"in": "body",
"name": "virtualHubParameters",
"required": true,
"schema": {
"$ref": "#/definitions/VirtualHub"
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VirtualHub created or updated.",
"schema": {
"$ref": "#/definitions/VirtualHub"
}
},
"201": {
"description": "Request received successfully. Returns the details of the VirtualHub created or updated.",
"schema": {
"$ref": "#/definitions/VirtualHub"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualHubPut": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualHubName": "virtualHub2",
"virtualHubParameters": {
"location": "West US",
"properties": {
"addressPrefix": "10.168.0.0/24",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"tags": {
"key1": "value1"
}
}
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
"location": "West US",
"name": "virtualHub2",
"properties": {
"addressPrefix": "10.168.0.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"type": "Microsoft.Network/virtualHubs"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
"location": "West US",
"name": "virtualHub2",
"properties": {
"addressPrefix": "10.168.0.0/24",
"provisioningState": "Succeeded",
"virtualNetworkConnections": [],
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
}
},
"type": "Microsoft.Network/virtualHubs"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": {
"get": {
"description": "Retrieves the details of all HubVirtualNetworkConnections.",
"operationId": "HubVirtualNetworkConnections_List",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualHub.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualHub.",
"in": "path",
"name": "virtualHubName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.",
"schema": {
"$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"HubVirtualNetworkConnectionList": {
"parameters": {
"api-version": "2019-07-01",
"connectionName": "connection1",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualHubName": "virtualHub1"
},
"responses": {
"200": {
"body": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1",
"name": "connection1",
"properties": {
"allowHubToRemoteVnetTransit": true,
"allowRemoteVnetToUseHubVnetGateways": false,
"provisioningState": "Succeeded",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1"
}
}
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection2",
"name": "connection2",
"properties": {
"allowHubToRemoteVnetTransit": true,
"allowRemoteVnetToUseHubVnetGateways": false,
"provisioningState": "Succeeded",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2"
}
}
}
]
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": {
"get": {
"description": "Retrieves the details of a HubVirtualNetworkConnection.",
"operationId": "HubVirtualNetworkConnections_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualHub.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualHub.",
"in": "path",
"name": "virtualHubName",
"required": true,
"type": "string"
},
{
"description": "The name of the vpn connection.",
"in": "path",
"name": "connectionName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.",
"schema": {
"$ref": "#/definitions/HubVirtualNetworkConnection"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"HubVirtualNetworkConnectionGet": {
"parameters": {
"api-version": "2019-07-01",
"connectionName": "connection1",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualHubName": "virtualHub1"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1",
"name": "connection1",
"properties": {
"allowHubToRemoteVnetTransit": true,
"allowRemoteVnetToUseHubVnetGateways": false,
"provisioningState": "Succeeded",
"remoteVirtualNetwork": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1"
}
}
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": {
"get": {
"description": "Lists all the VirtualWANs in a resource group.",
"operationId": "VirtualWans_ListByResourceGroup",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualWan.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the VirtualWANs in the resource group.",
"schema": {
"$ref": "#/definitions/ListVirtualWANsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualWANListByResourceGroup": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
"location": "West US",
"name": "wan1",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/virtualWANs"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan2",
"location": "East US",
"name": "wan2",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub3",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub4"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite3",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite4"
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/virtualWANs"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}": {
"delete": {
"description": "Deletes a VirtualWAN.",
"operationId": "VirtualWans_Delete",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualWan.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWAN being deleted.",
"in": "path",
"name": "VirtualWANName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. VirtualWAN deleted."
},
"202": {
"description": "Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome."
},
"204": {
"description": "No VirtualWANs exist by the name provided."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualWANDelete": {
"parameters": {
"VirtualWANName": "virtualWan1",
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"description": "Retrieves the details of a VirtualWAN.",
"operationId": "VirtualWans_Get",
"parameters": [
{
"description": "The resource group name of the VirtualWan.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWAN being retrieved.",
"in": "path",
"name": "VirtualWANName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VirtualWAN retrieved.",
"schema": {
"$ref": "#/definitions/VirtualWAN"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualWANGet": {
"parameters": {
"VirtualWANName": "wan1",
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
"location": "West US",
"name": "wan1",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/virtualWANs"
}
}
}
}
}
},
"patch": {
"description": "Updates a VirtualWAN tags.",
"operationId": "VirtualWans_UpdateTags",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualWan.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWAN being updated.",
"in": "path",
"name": "VirtualWANName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to Update VirtualWAN tags.",
"in": "body",
"name": "WANParameters",
"required": true,
"schema": {
"description": "Tags object for patch operations.",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
}
}
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VirtualWAN updated.",
"schema": {
"$ref": "#/definitions/VirtualWAN"
}
},
"201": {
"description": "Request received successfully. Returns the details of the VirtualWAN updated.",
"schema": {
"$ref": "#/definitions/VirtualWAN"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"tags": [
"VirtualWANs"
],
"x-ms-examples": {
"VirtualWANUpdate": {
"parameters": {
"VirtualWANName": "wan1",
"WANParameters": {
"tags": {
"key1": "value1",
"key2": "value2"
}
},
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
"location": "West US",
"name": "wan1",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/virtualWANs"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
"location": "West US",
"name": "wan1",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/virtualWANs"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.",
"operationId": "VirtualWans_CreateOrUpdate",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualWan.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWAN being created or updated.",
"in": "path",
"name": "VirtualWANName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to create or update VirtualWAN.",
"in": "body",
"name": "WANParameters",
"required": true,
"schema": {
"$ref": "#/definitions/VirtualWAN"
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VirtualWAN created or updated.",
"schema": {
"$ref": "#/definitions/VirtualWAN"
}
},
"201": {
"description": "Create successful. The operation returns the resulting VirtualWAN resource.",
"schema": {
"$ref": "#/definitions/VirtualWAN"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VirtualWANCreate": {
"parameters": {
"VirtualWANName": "wan1",
"WANParameters": {
"location": "West US",
"properties": {
"disableVpnEncryption": false
},
"tags": {
"key1": "value1"
}
},
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
"location": "West US",
"name": "wan1",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/virtualWANs"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1",
"location": "West US",
"name": "wan1",
"properties": {
"disableVpnEncryption": false,
"provisioningState": "Succeeded",
"virtualHubs": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2"
],
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2"
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/virtualWANs"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders": {
"get": {
"description": "Gives the supported security providers for the virtual wan.",
"operationId": "SupportedSecurityProviders",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWAN for which supported security providers are needed.",
"in": "path",
"name": "virtualWANName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the object containing supported security providers.",
"schema": {
"$ref": "#/definitions/VirtualWanSecurityProviders"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"supportedSecurityProviders": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualWANName": "wan1"
},
"responses": {
"200": {
"body": {
"supportedProviders": [
{
"name": "AzureFirewall",
"type": "Native",
"url": ""
}
]
},
"description": "Request successful."
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": {
"post": {
"description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.",
"operationId": "VpnSitesConfiguration_Download",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWAN for which configuration of all vpn-sites is needed.",
"in": "path",
"name": "virtualWANName",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to download vpn-sites configuration.",
"in": "body",
"name": "request",
"required": true,
"schema": {
"$ref": "#/definitions/GetVpnSitesConfigurationRequest"
}
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Follow the location header for sas-url to output blob."
},
"202": {
"description": "Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSitesConfigurationDownload": {
"parameters": {
"api-version": "2019-07-01",
"request": {
"outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b",
"vpnSites": [
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc"
]
},
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualWANName": "wan1"
},
"responses": {
"200": {
"description": "Request successful. Follow the location header for sas-url to output blob."
},
"202": {
"description": "Accepted and the operation will complete asynchronously."
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWanName}/p2sVpnServerConfigurations": {
"get": {
"description": "Retrieves all P2SVpnServerConfigurations for a particular VirtualWan.",
"operationId": "P2sVpnServerConfigurations_ListByVirtualWan",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualWan.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWan.",
"in": "path",
"name": "virtualWanName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns all P2SVpnServerConfigurations for a VirtualWan.",
"schema": {
"$ref": "#/definitions/ListP2SVpnServerConfigurationsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnServerConfigurationList": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualWanName": "virtualWan1"
},
"responses": {
"200": {
"body": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1",
"name": "p2sVpnServerConfiguration1",
"properties": {
"p2SVpnServerConfigRadiusClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1",
"name": "p2sVpnServerConfigRadiusClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
},
"type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates"
}
],
"p2SVpnServerConfigRadiusServerRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert",
"name": "p2sVpnServerConfigRadiusServerRootCert1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"
},
"type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates"
}
],
"p2SVpnServerConfigVpnClientRevokedCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/VpnClientRevokedCert2",
"name": "p2sVpnServerConfigVpnClientRevokedCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
},
"type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates"
}
],
"p2SVpnServerConfigVpnClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1",
"name": "p2sVpnServerConfigVpnClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"
},
"type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates"
}
],
"provisioningState": "Succeeded",
"radiusServerAddress": "8.9.9.9",
"radiusServerSecret": "123_abc",
"vpnClientIpsecPolicies": [
{
"dhGroup": "DHGroup14",
"ikeEncryption": "AES256",
"ikeIntegrity": "SHA384",
"ipsecEncryption": "AES256",
"ipsecIntegrity": "SHA256",
"pfsGroup": "PFS14",
"saDataSizeKilobytes": 429497,
"saLifeTimeSeconds": 86472
}
],
"vpnProtocols": [
"IkeV2"
]
}
}
]
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWanName}/p2sVpnServerConfigurations/{p2SVpnServerConfigurationName}": {
"delete": {
"description": "Deletes a P2SVpnServerConfiguration.",
"operationId": "P2sVpnServerConfigurations_Delete",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the P2SVpnServerConfiguration.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWan.",
"in": "path",
"name": "virtualWanName",
"required": true,
"type": "string"
},
{
"description": "The name of the P2SVpnServerConfiguration.",
"in": "path",
"name": "p2SVpnServerConfigurationName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. P2SVpnServerConfiguration deleted."
},
"202": {
"description": "Request received successfully. P2SVpnServerConfiguration deletion is in progress; follow the Location header to poll for final outcome."
},
"204": {
"description": "No P2SVpnServerConfigurations exist by the name provided."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnServerConfigurationDelete": {
"parameters": {
"api-version": "2019-07-01",
"p2SVpnServerConfigurationName": "p2sVpnServerConfiguration1",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualWanName": "virtualWan1"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"description": "Retrieves the details of a P2SVpnServerConfiguration.",
"operationId": "P2sVpnServerConfigurations_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the P2SVpnServerConfiguration.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWan.",
"in": "path",
"name": "virtualWanName",
"required": true,
"type": "string"
},
{
"description": "The name of the P2SVpnServerConfiguration.",
"in": "path",
"name": "p2SVpnServerConfigurationName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the P2SVpnServerConfiguration.",
"schema": {
"$ref": "#/definitions/P2SVpnServerConfiguration"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnServerConfigurationGet": {
"parameters": {
"api-version": "2019-07-01",
"p2SVpnServerConfigurationName": "p2sVpnServerConfiguration1",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualWanName": "virtualWan1"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations//p2sVpnServerConfiguration1",
"name": "p2sVpnServerConfiguration1",
"properties": {
"p2SVpnServerConfigRadiusClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1",
"name": "p2sVpnServerConfigRadiusClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigRadiusServerRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCer1",
"name": "p2sVpnServerConfigRadiusServerRootCer1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"
}
}
],
"p2SVpnServerConfigVpnClientRevokedCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1",
"name": "p2sVpnServerConfigVpnClientRevokedCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigVpnClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1",
"name": "p2sVpnServerConfigVpnClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"
}
}
],
"provisioningState": "Succeeded",
"radiusServerAddress": "8.9.9.9",
"radiusServerSecret": "123_abc",
"vpnClientIpsecPolicies": [
{
"dhGroup": "DHGroup14",
"ikeEncryption": "AES256",
"ikeIntegrity": "SHA384",
"ipsecEncryption": "AES256",
"ipsecIntegrity": "SHA256",
"pfsGroup": "PFS14",
"saDataSizeKilobytes": 429497,
"saLifeTimeSeconds": 86472
}
],
"vpnProtocols": [
"IkeV2"
]
}
}
}
}
}
}
},
"put": {
"description": "Creates a P2SVpnServerConfiguration to associate with a VirtualWan if it doesn't exist else updates the existing P2SVpnServerConfiguration.",
"operationId": "P2sVpnServerConfigurations_CreateOrUpdate",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VirtualWan.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VirtualWan.",
"in": "path",
"name": "virtualWanName",
"required": true,
"type": "string"
},
{
"description": "The name of the P2SVpnServerConfiguration.",
"in": "path",
"name": "p2SVpnServerConfigurationName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to create or Update a P2SVpnServerConfiguration.",
"in": "body",
"name": "p2SVpnServerConfigurationParameters",
"required": true,
"schema": {
"$ref": "#/definitions/P2SVpnServerConfiguration"
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the P2SVpnServerConfiguration created or updated.",
"schema": {
"$ref": "#/definitions/P2SVpnServerConfiguration"
}
},
"201": {
"description": "Request successful. Returns the details of the P2SVpnServerConfiguration created or updated.",
"schema": {
"$ref": "#/definitions/P2SVpnServerConfiguration"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"P2SVpnServerConfigurationPut": {
"parameters": {
"api-version": "2019-07-01",
"p2SVpnServerConfigurationName": "p2sVpnServerConfiguration1",
"p2SVpnServerConfigurationParameters": {
"properties": {
"p2SVpnServerConfigRadiusClientRootCertificates": [
{
"name": "p2sVpnServerConfigRadiusClientRootCert1",
"properties": {
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigRadiusServerRootCertificates": [
{
"name": "p2sVpnServerConfigRadiusServerRootCert1",
"properties": {
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"
}
}
],
"p2SVpnServerConfigVpnClientRevokedCertificates": [
{
"name": "p2sVpnServerConfigVpnClientRevokedCert1",
"properties": {
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigVpnClientRootCertificates": [
{
"name": "p2sVpnServerConfigVpnClientRootCert1",
"properties": {
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"
}
}
],
"radiusServerAddress": "8.9.9.9",
"radiusServerSecret": "123_abc",
"vpnClientIpsecPolicies": [
{
"dhGroup": "DHGroup14",
"ikeEncryption": "AES256",
"ikeIntegrity": "SHA384",
"ipsecEncryption": "AES256",
"ipsecIntegrity": "SHA256",
"pfsGroup": "PFS14",
"saDataSizeKilobytes": 429497,
"saLifeTimeSeconds": 86472
}
],
"vpnProtocols": [
"IkeV2"
]
}
},
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"virtualWanName": "virtualWan1"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations//p2sVpnServerConfiguration1",
"name": "p2sVpnServerConfiguration1",
"properties": {
"p2SVpnServerConfigRadiusClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1",
"name": "p2sVpnServerConfigRadiusClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigRadiusServerRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1",
"name": "p2sVpnServerConfigRadiusServerRootCert1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"
}
}
],
"p2SVpnServerConfigVpnClientRevokedCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1",
"name": "p2sVpnServerConfigVpnClientRevokedCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigVpnClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1",
"name": "p2sVpnServerConfigVpnClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"
}
}
],
"provisioningState": "Succeeded",
"radiusServerAddress": "8.9.9.9",
"radiusServerSecret": "123_abc",
"vpnClientIpsecPolicies": [
{
"dhGroup": "DHGroup14",
"ikeEncryption": "AES256",
"ikeIntegrity": "SHA384",
"ipsecEncryption": "AES256",
"ipsecIntegrity": "SHA256",
"pfsGroup": "PFS14",
"saDataSizeKilobytes": 429497,
"saLifeTimeSeconds": 86472
}
],
"vpnProtocols": [
"IkeV2"
]
}
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations//p2sVpnServerConfiguration1",
"name": "p2sVpnServerConfiguration1",
"properties": {
"p2SVpnServerConfigRadiusClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1",
"name": "p2sVpnServerConfigRadiusClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigRadiusServerRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1",
"name": "p2sVpnServerConfigRadiusServerRootCert1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"
}
}
],
"p2SVpnServerConfigVpnClientRevokedCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1",
"name": "p2sVpnServerConfigVpnClientRevokedCert1",
"properties": {
"provisioningState": "Succeeded",
"thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
}
}
],
"p2SVpnServerConfigVpnClientRootCertificates": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1",
"name": "p2sVpnServerConfigVpnClientRootCert1",
"properties": {
"provisioningState": "Succeeded",
"publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"
}
}
],
"provisioningState": "Succeeded",
"radiusServerAddress": "8.9.9.9",
"radiusServerSecret": "123_abc",
"vpnClientIpsecPolicies": [
{
"dhGroup": "DHGroup14",
"ikeEncryption": "AES256",
"ikeIntegrity": "SHA384",
"ipsecEncryption": "AES256",
"ipsecIntegrity": "SHA256",
"pfsGroup": "PFS14",
"saDataSizeKilobytes": 429497,
"saLifeTimeSeconds": 86472
}
],
"vpnProtocols": [
"IkeV2"
]
}
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": {
"get": {
"description": "Lists all the VpnGateways in a resource group.",
"operationId": "VpnGateways_ListByResourceGroup",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the VpnGateways in the resource group.",
"schema": {
"$ref": "#/definitions/ListVpnGatewaysResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnGatewayListByResourceGroup": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
"location": "West US",
"name": "gateway1",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
"name": "Connection-Link2",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"type": "Microsoft.Network/vpnGateways"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2",
"location": "West US",
"name": "gateway2",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2",
"name": "vpnConnection1",
"properties": {
"connectionBandwidth": 100,
"connectionStatus": "Connected",
"egressBytesTransferred": 0,
"enableBgp": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2"
},
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2"
}
},
"type": "Microsoft.Network/vpnGateways"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": {
"delete": {
"description": "Deletes a virtual wan vpn gateway.",
"operationId": "VpnGateways_Delete",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Vpn Gateway deleted."
},
"202": {
"description": "Request received successfully. Vpn Gateway deletion is in progress; follow the Location header to poll for final outcome."
},
"204": {
"description": "No vpn gateways exist by the name provided."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnGatewayDelete": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"description": "Retrieves the details of a virtual wan vpn gateway.",
"operationId": "VpnGateways_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.",
"schema": {
"$ref": "#/definitions/VpnGateway"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnGatewayGet": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
"location": "West US",
"name": "gateway1",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
"name": "Connection-Link2",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"type": "Microsoft.Network/vpnGateways"
}
}
}
}
}
},
"patch": {
"description": "Updates virtual wan vpn gateway tags.",
"operationId": "VpnGateways_UpdateTags",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to update a virtual wan vpn gateway tags.",
"in": "body",
"name": "vpnGatewayParameters",
"required": true,
"schema": {
"description": "Tags object for patch operations.",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
}
}
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the updated gateway.",
"schema": {
"$ref": "#/definitions/VpnGateway"
}
},
"201": {
"description": "Request received successfully. Returns the details of the updated gateway.",
"schema": {
"$ref": "#/definitions/VpnGateway"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"tags": [
"VpnGateways"
],
"x-ms-examples": {
"VpnGatewayUpdate": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnGatewayParameters": {
"tags": {
"tag1": "value1",
"tag2": "value2"
}
}
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
"location": "West US",
"name": "gateway1",
"properties": {
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"connectionStatus": "Connected",
"egressBytesTransferred": 0,
"enableBgp": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"routingWeight": 0,
"sharedKey": "key"
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/vpnGateways"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
"location": "West US",
"name": "gateway1",
"properties": {
"bgpSettings": {
"asn": 65515,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"connectionStatus": "Connected",
"egressBytesTransferred": 0,
"enableBgp": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"routingWeight": 0,
"sharedKey": "key"
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/vpnGateways"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.",
"operationId": "VpnGateways_CreateOrUpdate",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to create or Update a virtual wan vpn gateway.",
"in": "body",
"name": "vpnGatewayParameters",
"required": true,
"schema": {
"$ref": "#/definitions/VpnGateway"
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the virtual wan vpn Gateway created or updated.",
"schema": {
"$ref": "#/definitions/VpnGateway"
}
},
"201": {
"description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.",
"schema": {
"$ref": "#/definitions/VpnGateway"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnGatewayPut": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnGatewayParameters": {
"location": "westcentralus",
"properties": {
"bgpSettings": {
"asn": 65515,
"peerWeight": 0
},
"connections": [
{
"name": "vpnConnection1",
"properties": {
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"sharedKey": "key",
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
}
}
]
}
}
],
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"tags": {
"key1": "value1"
}
}
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
"location": "West US",
"name": "gateway1",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"type": "Microsoft.Network/vpnGateways"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1",
"location": "West US",
"name": "gateway1",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"type": "Microsoft.Network/vpnGateways"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset": {
"post": {
"description": "Resets the primary of the vpn gateway in the specified resource group.",
"operationId": "VpnGateways_Reset",
"parameters": [
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. The operation reset the primary of the VpnGateway.",
"schema": {
"$ref": "#/definitions/VpnGateway"
}
},
"202": {
"description": "Accepted and the operation will complete asynchronously."
}
},
"tags": [
"VpnGateways"
],
"x-ms-examples": {
"ResetVpnGateway": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "vpngw",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw",
"location": "West US",
"name": "vpngw",
"properties": {
"bgpSettings": {
"asn": 65514,
"bgpPeeringAddress": "10.0.1.30",
"peerWeight": 0
},
"connections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"connectionBandwidth": 100,
"connectionStatus": "Connected",
"egressBytesTransferred": 0,
"enableBgp": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false
}
}
],
"provisioningState": "Succeeded",
"virtualHub": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
}
},
"type": "Microsoft.Network/vpnGateways"
}
},
"202": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": {
"get": {
"description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.",
"operationId": "VpnConnections_ListByVpnGateway",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.",
"schema": {
"$ref": "#/definitions/ListVpnConnectionsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnConnectionList": {
"parameters": {
"api-version": "2019-07-01",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
"name": "Connection-Link2",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
]
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": {
"delete": {
"description": "Deletes a vpn connection.",
"operationId": "VpnConnections_Delete",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The name of the connection.",
"in": "path",
"name": "connectionName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Vpn Connection deleted."
},
"202": {
"description": "Request received successfully. Vpn Connection deletion is in progress; follow the Location header to poll for final outcome."
},
"204": {
"description": "No vpn connections exist by the name provided."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnConnectionDelete": {
"parameters": {
"api-version": "2019-07-01",
"connectionName": "vpnConnection1",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"description": "Retrieves the details of a vpn connection.",
"operationId": "VpnConnections_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The name of the vpn connection.",
"in": "path",
"name": "connectionName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the vpn connection.",
"schema": {
"$ref": "#/definitions/VpnConnection"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnConnectionGet": {
"parameters": {
"api-version": "2019-07-01",
"connectionName": "vpnConnection1",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2",
"name": "Connection-Link2",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
}
}
}
}
},
"put": {
"description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.",
"operationId": "VpnConnections_CreateOrUpdate",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The name of the connection.",
"in": "path",
"name": "connectionName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to create or Update a VPN Connection.",
"in": "body",
"name": "VpnConnectionParameters",
"required": true,
"schema": {
"$ref": "#/definitions/VpnConnection"
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the vpn connection created or updated.",
"schema": {
"$ref": "#/definitions/VpnConnection"
}
},
"201": {
"description": "Request successful. Returns the details of the vpn connection created or updated.",
"schema": {
"$ref": "#/definitions/VpnConnection"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnConnectionPut": {
"parameters": {
"VpnConnectionParameters": {
"properties": {
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"sharedKey": "key",
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
}
}
]
}
},
"api-version": "2019-07-01",
"connectionName": "vpnConnection1",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1",
"name": "vpnConnection1",
"properties": {
"egressBytesTransferred": 0,
"enableInternetSecurity": false,
"ingressBytesTransferred": 0,
"provisioningState": "Succeeded",
"remoteVpnSite": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"
},
"vpnLinkConnections": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
}
}
]
}
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections": {
"get": {
"description": "Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.",
"operationId": "VpnLinkConnections_ListByVpnConnection",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The name of the vpn connection.",
"in": "path",
"name": "connectionName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.",
"schema": {
"$ref": "#/definitions/ListVpnSiteLinkConnectionsResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteLinkConnectionList": {
"parameters": {
"api-version": "2019-07-01",
"connectionName": "vpnConnection1",
"gatewayName": "gateway1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
]
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}": {
"get": {
"description": "Retrieves the details of a vpn site link connection.",
"operationId": "VpnSiteLinkConnections_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnGateway.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the gateway.",
"in": "path",
"name": "gatewayName",
"required": true,
"type": "string"
},
{
"description": "The name of the vpn connection.",
"in": "path",
"name": "connectionName",
"required": true,
"type": "string"
},
{
"description": "The name of the vpn connection.",
"in": "path",
"name": "linkConnectionName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the vpn connection.",
"schema": {
"$ref": "#/definitions/VpnSiteLinkConnection"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteLinkConnectionGet": {
"parameters": {
"api-version": "2019-07-01",
"connectionName": "vpnConnection1",
"gatewayName": "gateway1",
"linkConnectionName": "Connection-Link1",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1",
"name": "Connection-Link1",
"properties": {
"connectionBandwidth": 200,
"egressBytesTransferred": 0,
"enableBgp": false,
"enableRateLimiting": false,
"ingressBytesTransferred": 0,
"ipsecPolicies": [],
"provisioningState": "Succeeded",
"routingWeight": 0,
"sharedKey": "key",
"useLocalAzureIpAddress": false,
"usePolicyBasedTrafficSelectors": false,
"vpnConnectionProtocolType": "IKEv2",
"vpnSiteLink": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"
}
},
"type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": {
"get": {
"description": "Lists all the vpnSites in a resource group.",
"operationId": "VpnSites_ListByResourceGroup",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnSite.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the vpnSites in the resource group.",
"schema": {
"$ref": "#/definitions/ListVpnSitesResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteListByResourceGroup": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"location": "West US",
"name": "vpnSite1",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"deviceProperties": {
"linkSpeedInMbps": 0
},
"isSecuritySite": false,
"provisioningState": "Succeeded",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"vpnSiteLinks": [
{
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkSpeedInMbps": 0
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/vpnSites/vpnSiteLinks"
}
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/vpnSites"
},
{
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2",
"location": "West US",
"name": "vpnSite2",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"deviceProperties": {
"deviceModel": "model01",
"deviceVendor": "vendor1",
"linkSpeedInMbps": 200
},
"ipAddress": "10.1.0.0",
"provisioningState": "Succeeded",
"virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/vpnSites"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": {
"delete": {
"description": "Deletes a VpnSite.",
"operationId": "VpnSites_Delete",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnSite.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VpnSite being deleted.",
"in": "path",
"name": "vpnSiteName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. VpnSite deleted."
},
"202": {
"description": "Request received successfully. VpnSite deletion is in progress."
},
"204": {
"description": "No VpnSites exist by the name provided."
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteDelete": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnSiteName": "vpnSite1"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"get": {
"description": "Retrieves the details of a VPN site.",
"operationId": "VpnSites_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnSite.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VpnSite being retrieved.",
"in": "path",
"name": "vpnSiteName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VpnSite retrieved.",
"schema": {
"$ref": "#/definitions/VpnSite"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteGet": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnSiteName": "vpnSite1"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"location": "West US",
"name": "vpnSite1",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"deviceProperties": {
"linkSpeedInMbps": 0
},
"isSecuritySite": false,
"provisioningState": "Succeeded",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"vpnSiteLinks": [
{
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkProviderName": "vendor1",
"linkSpeedInMbps": 0
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/vpnSites/vpnSiteLinks"
}
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/vpnSites"
}
}
}
}
}
},
"patch": {
"description": "Updates VpnSite tags.",
"operationId": "VpnSites_UpdateTags",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnSite.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VpnSite being updated.",
"in": "path",
"name": "vpnSiteName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to update VpnSite tags.",
"in": "body",
"name": "VpnSiteParameters",
"required": true,
"schema": {
"description": "Tags object for patch operations.",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
}
}
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VpnSite updated.",
"schema": {
"$ref": "#/definitions/VpnSite"
}
},
"201": {
"description": "Request received successfully. Returns the details of the VpnSite updated.",
"schema": {
"$ref": "#/definitions/VpnSite"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"tags": [
"VpnSites"
],
"x-ms-examples": {
"VpnSiteUpdate": {
"parameters": {
"VpnSiteParameters": {
"tags": {
"key1": "value1",
"key2": "value2"
}
},
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnSiteName": "vpnSite1"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"location": "West US",
"name": "vpnSite1",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"deviceProperties": {
"deviceModel": "model01",
"deviceVendor": "vendor1",
"linkSpeedInMbps": 200
},
"ipAddress": "10.0.0.0",
"provisioningState": "Succeeded",
"virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/vpnSites"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"location": "West US",
"name": "vpnSite1",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"deviceProperties": {
"deviceModel": "model01",
"deviceVendor": "vendor1",
"linkSpeedInMbps": 200
},
"ipAddress": "10.0.0.0",
"provisioningState": "Succeeded",
"virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Network/vpnSites"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"put": {
"description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.",
"operationId": "VpnSites_CreateOrUpdate",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnSite.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VpnSite being created or updated.",
"in": "path",
"name": "vpnSiteName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "Parameters supplied to create or update VpnSite.",
"in": "body",
"name": "VpnSiteParameters",
"required": true,
"schema": {
"$ref": "#/definitions/VpnSite"
}
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VpnSite created or updated.",
"schema": {
"$ref": "#/definitions/VpnSite"
}
},
"201": {
"description": "Request received successfully. Returns the details of the VpnSite created or updated.",
"schema": {
"$ref": "#/definitions/VpnSite"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteCreate": {
"parameters": {
"VpnSiteParameters": {
"location": "West US",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"isSecuritySite": false,
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"vpnSiteLinks": [
{
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkProviderName": "vendor1",
"linkSpeedInMbps": 0
}
}
}
]
},
"tags": {
"key1": "value1"
}
},
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnSiteName": "vpnSite1"
},
"responses": {
"200": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"location": "West US",
"name": "vpnSite1",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"deviceProperties": {
"linkSpeedInMbps": 0
},
"isSecuritySite": false,
"provisioningState": "Succeeded",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"vpnSiteLinks": [
{
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkProviderName": "vendor1",
"linkSpeedInMbps": 0
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/vpnSites/vpnSiteLinks"
}
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/vpnSites"
}
},
"201": {
"body": {
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"location": "West US",
"name": "vpnSite1",
"properties": {
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"deviceProperties": {
"linkSpeedInMbps": 0
},
"isSecuritySite": false,
"provisioningState": "Succeeded",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"vpnSiteLinks": [
{
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkProviderName": "vendor1",
"linkSpeedInMbps": 0
},
"provisioningState": "Succeeded"
}
}
]
},
"tags": {
"key1": "value1"
},
"type": "Microsoft.Network/vpnSites"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks": {
"get": {
"description": "Lists all the vpnSiteLinks in a resource group for a vpn site.",
"operationId": "VpnSiteLinks_ListByVpnSite",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnSite.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VpnSite.",
"in": "path",
"name": "vpnSiteName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of all the vpnSites in the resource group.",
"schema": {
"$ref": "#/definitions/ListVpnSiteLinksResult"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteLinkListByVpnSite": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnSiteName": "vpnSite1"
},
"responses": {
"200": {
"body": {
"value": [
{
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkSpeedInMbps": 200
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/vpnSites/vpnSiteLinks"
},
{
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink2",
"name": "vpnSiteLink2",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.1"
},
"ipAddress": "40.40.40.46",
"linkProperties": {
"linkSpeedInMbps": 200
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/vpnSites/vpnSiteLinks"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}": {
"get": {
"description": "Retrieves the details of a VPN site link.",
"operationId": "VpnSiteLinks_Get",
"parameters": [
{
"description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"description": "The resource group name of the VpnSite.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string"
},
{
"description": "The name of the VpnSite.",
"in": "path",
"name": "vpnSiteName",
"required": true,
"type": "string"
},
{
"description": "The name of the VpnSiteLink being retrieved.",
"in": "path",
"name": "vpnSiteLinkName",
"required": true,
"type": "string"
},
{
"description": "Client API version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the details of the VpnSiteLink retrieved.",
"schema": {
"$ref": "#/definitions/VpnSiteLink"
}
},
"default": {
"description": "Error.",
"schema": {
"description": "Common error representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"details": {
"description": "Error details.",
"items": {
"description": "Common error details representation.",
"properties": {
"code": {
"description": "Error code.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
},
"type": "array"
},
"innerError": {
"description": "Inner error message.",
"type": "string"
},
"message": {
"description": "Error message.",
"type": "string"
},
"target": {
"description": "Error target.",
"type": "string"
}
}
}
}
},
"x-ms-examples": {
"VpnSiteGet": {
"parameters": {
"api-version": "2019-07-01",
"resourceGroupName": "rg1",
"subscriptionId": "subid",
"vpnSiteLinkName": "vpnSiteLink1",
"vpnSiteName": "vpnSite1"
},
"responses": {
"200": {
"body": {
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"name": "vpnSiteLink1",
"properties": {
"bgpProperties": {
"asn": 1234,
"bgpPeeringAddress": "192.168.0.0"
},
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkSpeedInMbps": 0
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/vpnSites/vpnSiteLinks"
}
}
}
}
}
}
}
},
"definitions": {
"DeviceProperties": {
"description": "List of properties of the device.",
"properties": {
"deviceModel": {
"description": "Model of the device.",
"type": "string"
},
"deviceVendor": {
"description": "Name of the device Vendor.",
"type": "string"
},
"linkSpeedInMbps": {
"description": "Link speed.",
"format": "int32",
"type": "integer"
}
}
},
"GetVpnSitesConfigurationRequest": {
"description": "List of Vpn-Sites.",
"properties": {
"outputBlobSasUrl": {
"description": "The sas-url to download the configurations for vpn-sites.",
"type": "string"
},
"vpnSites": {
"description": "List of resource-ids of the vpn-sites for which config is to be downloaded.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"outputBlobSasUrl"
]
},
"HubVirtualNetworkConnection": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "HubVirtualNetworkConnection Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/HubVirtualNetworkConnectionProperties",
"description": "Properties of the hub virtual network connection.",
"x-ms-client-flatten": true
}
}
},
"HubVirtualNetworkConnectionProperties": {
"description": "Parameters for HubVirtualNetworkConnection.",
"properties": {
"allowHubToRemoteVnetTransit": {
"description": "VirtualHub to RemoteVnet transit to enabled or not.",
"type": "boolean"
},
"allowRemoteVnetToUseHubVnetGateways": {
"description": "Allow RemoteVnet to use Virtual Hub's gateways.",
"type": "boolean"
},
"enableInternetSecurity": {
"description": "Enable internet security.",
"type": "boolean"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"remoteVirtualNetwork": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
}
},
"HubVirtualNetworkConnectionStatus": {
"description": "The current state of the VirtualHub to vnet connection.",
"enum": [
"Unknown",
"Connecting",
"Connected",
"NotConnected"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "HubVirtualNetworkConnectionStatus"
}
},
"ListHubVirtualNetworkConnectionsResult": {
"description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.",
"properties": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of HubVirtualNetworkConnections.",
"items": {
"$ref": "#/definitions/HubVirtualNetworkConnection"
},
"type": "array"
}
}
},
"ListP2SVpnGatewaysResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of P2SVpnGateways.",
"items": {
"$ref": "#/definitions/P2SVpnGateway"
},
"type": "array"
}
}
},
"ListP2SVpnServerConfigurationsResult": {
"description": "Result of the request to list all P2SVpnServerConfigurations associated to a VirtualWan. It contains a list of P2SVpnServerConfigurations and a URL nextLink to get the next set of results.",
"properties": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of P2SVpnServerConfigurations.",
"items": {
"$ref": "#/definitions/P2SVpnServerConfiguration"
},
"type": "array"
}
}
},
"ListVirtualHubsResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of VirtualHubs.",
"items": {
"$ref": "#/definitions/VirtualHub"
},
"type": "array"
}
}
},
"ListVirtualWANsResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of VirtualWANs.",
"items": {
"$ref": "#/definitions/VirtualWAN"
},
"type": "array"
}
}
},
"ListVpnConnectionsResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of Vpn Connections.",
"items": {
"$ref": "#/definitions/VpnConnection"
},
"type": "array"
}
}
},
"ListVpnGatewaysResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of VpnGateways.",
"items": {
"$ref": "#/definitions/VpnGateway"
},
"type": "array"
}
}
},
"ListVpnSiteLinkConnectionsResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of VpnSiteLinkConnections.",
"items": {
"$ref": "#/definitions/VpnSiteLinkConnection"
},
"type": "array"
}
}
},
"ListVpnSiteLinksResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of VpnSitesLinks.",
"items": {
"$ref": "#/definitions/VpnSiteLink"
},
"type": "array"
}
}
},
"ListVpnSitesResult": {
"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": {
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"description": "List of VpnSites.",
"items": {
"$ref": "#/definitions/VpnSite"
},
"type": "array"
}
}
},
"OfficeTrafficCategory": {
"description": "The office traffic category.",
"enum": [
"Optimize",
"OptimizeAndAllow",
"All",
"None"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "OfficeTrafficCategory"
}
},
"P2SVpnGateway": {
"allOf": [
{
"description": "Common resource representation.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
},
"location": {
"description": "Resource location.",
"type": "string"
},
"name": {
"description": "Resource name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "P2SVpnGateway Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/definitions/P2SVpnGatewayProperties",
"description": "Properties of the P2SVpnGateway.",
"x-ms-client-flatten": true
}
},
"required": [
"location"
]
},
"P2SVpnGatewayProperties": {
"description": "Parameters for P2SVpnGateway.",
"properties": {
"customRoutes": {
"description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.",
"properties": {
"addressPrefixes": {
"description": "A list of address blocks reserved for this virtual network in CIDR notation.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"p2SVpnServerConfiguration": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"virtualHub": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"vpnClientAddressPool": {
"description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.",
"properties": {
"addressPrefixes": {
"description": "A list of address blocks reserved for this virtual network in CIDR notation.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"vpnClientConnectionHealth": {
"$ref": "#/definitions/VpnClientConnectionHealth",
"description": "All P2S VPN clients' connection health status.",
"readOnly": true
},
"vpnGatewayScaleUnit": {
"description": "The scale unit for this p2s vpn gateway.",
"format": "int32",
"type": "integer"
}
}
},
"P2SVpnProfileParameters": {
"description": "Vpn Client Parameters for package generation.",
"properties": {
"authenticationMethod": {
"description": "VPN client authentication method.",
"enum": [
"EAPTLS",
"EAPMSCHAPv2"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "AuthenticationMethod"
}
}
}
},
"P2SVpnServerConfigRadiusClientRootCertificate": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Radius client root certificate of P2SVpnServerConfiguration.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat",
"description": "Properties of the Radius client root certificate.",
"x-ms-client-flatten": true
}
}
},
"P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat": {
"description": "Properties of the Radius client root certificate of P2SVpnServerConfiguration.",
"properties": {
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"thumbprint": {
"description": "The Radius client root certificate thumbprint.",
"type": "string"
}
}
},
"P2SVpnServerConfigRadiusServerRootCertificate": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "Radius Server root certificate of P2SVpnServerConfiguration.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat",
"description": "Properties of the P2SVpnServerConfiguration Radius Server root certificate.",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
]
},
"P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat": {
"description": "Properties of Radius Server root certificate of P2SVpnServerConfiguration.",
"properties": {
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"publicCertData": {
"description": "The certificate public data.",
"type": "string"
}
},
"required": [
"publicCertData"
]
},
"P2SVpnServerConfigVpnClientRevokedCertificate": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VPN client revoked certificate of P2SVpnServerConfiguration.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat",
"description": "Properties of the vpn client revoked certificate.",
"x-ms-client-flatten": true
}
}
},
"P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat": {
"description": "Properties of the revoked VPN client certificate of P2SVpnServerConfiguration.",
"properties": {
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"thumbprint": {
"description": "The revoked VPN client certificate thumbprint.",
"type": "string"
}
}
},
"P2SVpnServerConfigVpnClientRootCertificate": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VPN client root certificate of P2SVpnServerConfiguration.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat",
"description": "Properties of the P2SVpnServerConfiguration VPN client root certificate.",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
]
},
"P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat": {
"description": "Properties of VPN client root certificate of P2SVpnServerConfiguration.",
"properties": {
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"publicCertData": {
"description": "The certificate public data.",
"type": "string"
}
},
"required": [
"publicCertData"
]
},
"P2SVpnServerConfiguration": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "P2SVpnServerConfiguration Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/P2SVpnServerConfigurationProperties",
"description": "Properties of the P2SVpnServer configuration.",
"x-ms-client-flatten": true
}
}
},
"P2SVpnServerConfigurationProperties": {
"description": "Parameters for P2SVpnServerConfiguration.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"type": "string"
},
"name": {
"description": "The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name.",
"type": "string"
},
"p2SVpnGateways": {
"description": "List of references to P2SVpnGateways.",
"items": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"readOnly": true,
"type": "array"
},
"p2SVpnServerConfigRadiusClientRootCertificates": {
"description": "Radius client root certificate of P2SVpnServerConfiguration.",
"items": {
"$ref": "#/definitions/P2SVpnServerConfigRadiusClientRootCertificate"
},
"type": "array"
},
"p2SVpnServerConfigRadiusServerRootCertificates": {
"description": "Radius Server root certificate of P2SVpnServerConfiguration.",
"items": {
"$ref": "#/definitions/P2SVpnServerConfigRadiusServerRootCertificate"
},
"type": "array"
},
"p2SVpnServerConfigVpnClientRevokedCertificates": {
"description": "VPN client revoked certificate of P2SVpnServerConfiguration.",
"items": {
"$ref": "#/definitions/P2SVpnServerConfigVpnClientRevokedCertificate"
},
"type": "array"
},
"p2SVpnServerConfigVpnClientRootCertificates": {
"description": "VPN client root certificate of P2SVpnServerConfiguration.",
"items": {
"$ref": "#/definitions/P2SVpnServerConfigVpnClientRootCertificate"
},
"type": "array"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"radiusServerAddress": {
"description": "The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection.",
"type": "string"
},
"radiusServerSecret": {
"description": "The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection.",
"type": "string"
},
"vpnClientIpsecPolicies": {
"description": "VpnClientIpsecPolicies for P2SVpnServerConfiguration.",
"items": {
"description": "An IPSec Policy configuration for a virtual network gateway connection.",
"properties": {
"dhGroup": {
"description": "The DH Groups used in IKE Phase 1 for initial SA.",
"enum": [
"None",
"DHGroup1",
"DHGroup2",
"DHGroup14",
"DHGroup2048",
"ECP256",
"ECP384",
"DHGroup24"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "DhGroup"
}
},
"ikeEncryption": {
"description": "The IKE encryption algorithm (IKE phase 2).",
"enum": [
"DES",
"DES3",
"AES128",
"AES192",
"AES256",
"GCMAES256",
"GCMAES128"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IkeEncryption"
}
},
"ikeIntegrity": {
"description": "The IKE integrity algorithm (IKE phase 2).",
"enum": [
"MD5",
"SHA1",
"SHA256",
"SHA384",
"GCMAES256",
"GCMAES128"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IkeIntegrity"
}
},
"ipsecEncryption": {
"description": "The IPSec encryption algorithm (IKE phase 1).",
"enum": [
"None",
"DES",
"DES3",
"AES128",
"AES192",
"AES256",
"GCMAES128",
"GCMAES192",
"GCMAES256"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IpsecEncryption"
}
},
"ipsecIntegrity": {
"description": "The IPSec integrity algorithm (IKE phase 1).",
"enum": [
"MD5",
"SHA1",
"SHA256",
"GCMAES128",
"GCMAES192",
"GCMAES256"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IpsecIntegrity"
}
},
"pfsGroup": {
"description": "The Pfs Groups used in IKE Phase 2 for new child SA.",
"enum": [
"None",
"PFS1",
"PFS2",
"PFS2048",
"ECP256",
"ECP384",
"PFS24",
"PFS14",
"PFSMM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "PfsGroup"
}
},
"saDataSizeKilobytes": {
"description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.",
"format": "int32",
"type": "integer"
},
"saLifeTimeSeconds": {
"description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.",
"format": "int32",
"type": "integer"
}
},
"required": [
"saLifeTimeSeconds",
"saDataSizeKilobytes",
"ipsecEncryption",
"ipsecIntegrity",
"ikeEncryption",
"ikeIntegrity",
"dhGroup",
"pfsGroup"
]
},
"type": "array"
},
"vpnProtocols": {
"description": "VPN protocols for the P2SVpnServerConfiguration.",
"items": {
"description": "VPN protocol enabled for the P2SVpnServerConfiguration.",
"enum": [
"IkeV2",
"OpenVPN"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "VpnGatewayTunnelingProtocol"
}
},
"type": "array"
}
}
},
"TunnelConnectionStatus": {
"description": "The current state of the tunnel.",
"enum": [
"Unknown",
"Connecting",
"Connected",
"NotConnected"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "TunnelConnectionStatus"
}
},
"VirtualHub": {
"allOf": [
{
"description": "Common resource representation.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
},
"location": {
"description": "Resource location.",
"type": "string"
},
"name": {
"description": "Resource name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VirtualHub Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/definitions/VirtualHubProperties",
"description": "Properties of the virtual hub.",
"x-ms-client-flatten": true
}
},
"required": [
"location"
]
},
"VirtualHubProperties": {
"description": "Parameters for VirtualHub.",
"properties": {
"addressPrefix": {
"description": "Address-prefix for this VirtualHub.",
"type": "string"
},
"expressRouteGateway": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"p2SVpnGateway": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"routeTable": {
"$ref": "#/definitions/VirtualHubRouteTable",
"description": "The routeTable associated with this virtual hub."
},
"virtualNetworkConnections": {
"description": "List of all vnet connections with this VirtualHub.",
"items": {
"$ref": "#/definitions/HubVirtualNetworkConnection"
},
"type": "array"
},
"virtualWan": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"vpnGateway": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
}
},
"VirtualHubRoute": {
"description": "VirtualHub route.",
"properties": {
"addressPrefixes": {
"description": "List of all addressPrefixes.",
"items": {
"type": "string"
},
"type": "array"
},
"nextHopIpAddress": {
"description": "NextHop ip address.",
"type": "string"
}
}
},
"VirtualHubRouteTable": {
"description": "VirtualHub route table.",
"properties": {
"routes": {
"description": "List of all routes.",
"items": {
"$ref": "#/definitions/VirtualHubRoute"
},
"type": "array"
}
}
},
"VirtualWAN": {
"allOf": [
{
"description": "Common resource representation.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
},
"location": {
"description": "Resource location.",
"type": "string"
},
"name": {
"description": "Resource name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VirtualWAN Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/definitions/VirtualWanProperties",
"description": "Properties of the virtual WAN.",
"x-ms-client-flatten": true
}
},
"required": [
"location"
]
},
"VirtualWanProperties": {
"description": "Parameters for VirtualWAN.",
"properties": {
"allowBranchToBranchTraffic": {
"description": "True if branch to branch traffic is allowed.",
"type": "boolean"
},
"allowVnetToVnetTraffic": {
"description": "True if Vnet to Vnet traffic is allowed.",
"type": "boolean"
},
"disableVpnEncryption": {
"description": "Vpn encryption to be disabled or not.",
"type": "boolean"
},
"office365LocalBreakoutCategory": {
"$ref": "#/definitions/OfficeTrafficCategory",
"description": "The office local breakout category."
},
"p2SVpnServerConfigurations": {
"description": "List of all P2SVpnServerConfigurations associated with the virtual wan.",
"items": {
"$ref": "#/definitions/P2SVpnServerConfiguration"
},
"type": "array"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"securityProviderName": {
"description": "The Security Provider name.",
"type": "string"
},
"virtualHubs": {
"description": "List of VirtualHubs in the VirtualWAN.",
"items": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"readOnly": true,
"type": "array"
},
"vpnSites": {
"description": "List of VpnSites in the VirtualWAN.",
"items": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"readOnly": true,
"type": "array"
}
}
},
"VirtualWanSecurityProvider": {
"description": "Collection of SecurityProviders.",
"properties": {
"name": {
"description": "Name of the security provider.",
"type": "string"
},
"type": {
"$ref": "#/definitions/VirtualWanSecurityProviderType",
"description": "Name of the security provider."
},
"url": {
"description": "Url of the security provider.",
"type": "string"
}
}
},
"VirtualWanSecurityProviderType": {
"description": "The virtual wan security provider type.",
"enum": [
"External",
"Native"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "VirtualWanSecurityProviderType"
}
},
"VirtualWanSecurityProviders": {
"description": "Collection of SecurityProviders.",
"properties": {
"supportedProviders": {
"description": "List of VirtualWAN security providers.",
"items": {
"$ref": "#/definitions/VirtualWanSecurityProvider"
},
"type": "array"
}
}
},
"VpnClientConnectionHealth": {
"description": "VpnClientConnectionHealth properties.",
"properties": {
"allocatedIpAddresses": {
"description": "List of allocated ip addresses to the connected p2s vpn clients.",
"items": {
"type": "string"
},
"type": "array"
},
"totalEgressBytesTransferred": {
"description": "Total of the Egress Bytes Transferred in this connection.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"totalIngressBytesTransferred": {
"description": "Total of the Ingress Bytes Transferred in this P2S Vpn connection.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"vpnClientConnectionsCount": {
"description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway.",
"format": "int32",
"type": "integer"
}
}
},
"VpnConnection": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VpnConnection Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/VpnConnectionProperties",
"description": "Properties of the VPN connection.",
"x-ms-client-flatten": true
}
}
},
"VpnConnectionProperties": {
"description": "Parameters for VpnConnection.",
"properties": {
"connectionBandwidth": {
"description": "Expected bandwidth in MBPS.",
"format": "int32",
"type": "integer"
},
"connectionStatus": {
"$ref": "#/definitions/VpnConnectionStatus",
"description": "The connection status."
},
"egressBytesTransferred": {
"description": "Egress bytes transferred.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"enableBgp": {
"description": "EnableBgp flag.",
"type": "boolean"
},
"enableInternetSecurity": {
"description": "Enable internet security.",
"type": "boolean"
},
"enableRateLimiting": {
"description": "EnableBgp flag.",
"type": "boolean"
},
"ingressBytesTransferred": {
"description": "Ingress bytes transferred.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"ipsecPolicies": {
"description": "The IPSec Policies to be considered by this connection.",
"items": {
"description": "An IPSec Policy configuration for a virtual network gateway connection.",
"properties": {
"dhGroup": {
"description": "The DH Groups used in IKE Phase 1 for initial SA.",
"enum": [
"None",
"DHGroup1",
"DHGroup2",
"DHGroup14",
"DHGroup2048",
"ECP256",
"ECP384",
"DHGroup24"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "DhGroup"
}
},
"ikeEncryption": {
"description": "The IKE encryption algorithm (IKE phase 2).",
"enum": [
"DES",
"DES3",
"AES128",
"AES192",
"AES256",
"GCMAES256",
"GCMAES128"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IkeEncryption"
}
},
"ikeIntegrity": {
"description": "The IKE integrity algorithm (IKE phase 2).",
"enum": [
"MD5",
"SHA1",
"SHA256",
"SHA384",
"GCMAES256",
"GCMAES128"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IkeIntegrity"
}
},
"ipsecEncryption": {
"description": "The IPSec encryption algorithm (IKE phase 1).",
"enum": [
"None",
"DES",
"DES3",
"AES128",
"AES192",
"AES256",
"GCMAES128",
"GCMAES192",
"GCMAES256"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IpsecEncryption"
}
},
"ipsecIntegrity": {
"description": "The IPSec integrity algorithm (IKE phase 1).",
"enum": [
"MD5",
"SHA1",
"SHA256",
"GCMAES128",
"GCMAES192",
"GCMAES256"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IpsecIntegrity"
}
},
"pfsGroup": {
"description": "The Pfs Groups used in IKE Phase 2 for new child SA.",
"enum": [
"None",
"PFS1",
"PFS2",
"PFS2048",
"ECP256",
"ECP384",
"PFS24",
"PFS14",
"PFSMM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "PfsGroup"
}
},
"saDataSizeKilobytes": {
"description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.",
"format": "int32",
"type": "integer"
},
"saLifeTimeSeconds": {
"description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.",
"format": "int32",
"type": "integer"
}
},
"required": [
"saLifeTimeSeconds",
"saDataSizeKilobytes",
"ipsecEncryption",
"ipsecIntegrity",
"ikeEncryption",
"ikeIntegrity",
"dhGroup",
"pfsGroup"
]
},
"type": "array"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"remoteVpnSite": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"routingWeight": {
"description": "Routing weight for vpn connection.",
"format": "int32",
"type": "integer"
},
"sharedKey": {
"description": "SharedKey for the vpn connection.",
"type": "string"
},
"useLocalAzureIpAddress": {
"description": "Use local azure ip to initiate connection.",
"type": "boolean"
},
"usePolicyBasedTrafficSelectors": {
"description": "Enable policy-based traffic selectors.",
"type": "boolean"
},
"vpnConnectionProtocolType": {
"description": "Gateway connection protocol.",
"enum": [
"IKEv2",
"IKEv1"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "VirtualNetworkGatewayConnectionProtocol"
}
},
"vpnLinkConnections": {
"description": "List of all vpn site link connections to the gateway.",
"items": {
"$ref": "#/definitions/VpnSiteLinkConnection"
},
"type": "array"
}
}
},
"VpnConnectionStatus": {
"description": "The current state of the vpn connection.",
"enum": [
"Unknown",
"Connecting",
"Connected",
"NotConnected"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "VpnConnectionStatus"
}
},
"VpnGateway": {
"allOf": [
{
"description": "Common resource representation.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
},
"location": {
"description": "Resource location.",
"type": "string"
},
"name": {
"description": "Resource name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VpnGateway Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/definitions/VpnGatewayProperties",
"description": "Properties of the VPN gateway.",
"x-ms-client-flatten": true
}
},
"required": [
"location"
]
},
"VpnGatewayProperties": {
"description": "Parameters for VpnGateway.",
"properties": {
"bgpSettings": {
"description": "BGP settings details.",
"properties": {
"asn": {
"description": "The BGP speaker's ASN.",
"format": "int64",
"type": "integer"
},
"bgpPeeringAddress": {
"description": "The BGP peering address and BGP identifier of this BGP speaker.",
"type": "string"
},
"peerWeight": {
"description": "The weight added to routes learned from this BGP speaker.",
"format": "int32",
"type": "integer"
}
}
},
"connections": {
"description": "List of all vpn connections to the gateway.",
"items": {
"$ref": "#/definitions/VpnConnection"
},
"type": "array"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"virtualHub": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"vpnGatewayScaleUnit": {
"description": "The scale unit for this vpn gateway.",
"format": "int32",
"type": "integer"
}
}
},
"VpnLinkBgpSettings": {
"description": "BGP settings details for a link.",
"properties": {
"asn": {
"description": "The BGP speaker's ASN.",
"format": "int64",
"type": "integer"
},
"bgpPeeringAddress": {
"description": "The BGP peering address and BGP identifier of this BGP speaker.",
"type": "string"
}
}
},
"VpnLinkProviderProperties": {
"description": "List of properties of a link provider.",
"properties": {
"linkProviderName": {
"description": "Name of the link provider.",
"type": "string"
},
"linkSpeedInMbps": {
"description": "Link speed.",
"format": "int32",
"type": "integer"
}
}
},
"VpnProfileResponse": {
"description": "Vpn Profile Response for package generation.",
"properties": {
"profileUrl": {
"description": "URL to the VPN profile.",
"type": "string"
}
}
},
"VpnSite": {
"allOf": [
{
"description": "Common resource representation.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
},
"location": {
"description": "Resource location.",
"type": "string"
},
"name": {
"description": "Resource name.",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VpnSite Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/definitions/VpnSiteProperties",
"description": "Properties of the VPN site.",
"x-ms-client-flatten": true
}
},
"required": [
"location"
]
},
"VpnSiteId": {
"description": "VpnSite Resource.",
"properties": {
"vpnSite": {
"description": "The resource-uri of the vpn-site for which config is to be fetched.",
"readOnly": true,
"type": "string"
}
}
},
"VpnSiteLink": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VpnSiteLink Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/VpnSiteLinkProperties",
"description": "Properties of the VPN site link.",
"x-ms-client-flatten": true
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
}
},
"VpnSiteLinkConnection": {
"allOf": [
{
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
],
"description": "VpnSiteLinkConnection Resource.",
"properties": {
"etag": {
"description": "A unique read-only string that changes whenever the resource is updated.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/VpnSiteLinkConnectionProperties",
"description": "Properties of the VPN site link connection.",
"x-ms-client-flatten": true
},
"type": {
"description": "Resource type.",
"readOnly": true,
"type": "string"
}
}
},
"VpnSiteLinkConnectionProperties": {
"description": "Parameters for VpnConnection.",
"properties": {
"connectionBandwidth": {
"description": "Expected bandwidth in MBPS.",
"format": "int32",
"type": "integer"
},
"connectionStatus": {
"$ref": "#/definitions/VpnConnectionStatus",
"description": "The connection status."
},
"egressBytesTransferred": {
"description": "Egress bytes transferred.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"enableBgp": {
"description": "EnableBgp flag.",
"type": "boolean"
},
"enableRateLimiting": {
"description": "EnableBgp flag.",
"type": "boolean"
},
"ingressBytesTransferred": {
"description": "Ingress bytes transferred.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"ipsecPolicies": {
"description": "The IPSec Policies to be considered by this connection.",
"items": {
"description": "An IPSec Policy configuration for a virtual network gateway connection.",
"properties": {
"dhGroup": {
"description": "The DH Groups used in IKE Phase 1 for initial SA.",
"enum": [
"None",
"DHGroup1",
"DHGroup2",
"DHGroup14",
"DHGroup2048",
"ECP256",
"ECP384",
"DHGroup24"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "DhGroup"
}
},
"ikeEncryption": {
"description": "The IKE encryption algorithm (IKE phase 2).",
"enum": [
"DES",
"DES3",
"AES128",
"AES192",
"AES256",
"GCMAES256",
"GCMAES128"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IkeEncryption"
}
},
"ikeIntegrity": {
"description": "The IKE integrity algorithm (IKE phase 2).",
"enum": [
"MD5",
"SHA1",
"SHA256",
"SHA384",
"GCMAES256",
"GCMAES128"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IkeIntegrity"
}
},
"ipsecEncryption": {
"description": "The IPSec encryption algorithm (IKE phase 1).",
"enum": [
"None",
"DES",
"DES3",
"AES128",
"AES192",
"AES256",
"GCMAES128",
"GCMAES192",
"GCMAES256"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IpsecEncryption"
}
},
"ipsecIntegrity": {
"description": "The IPSec integrity algorithm (IKE phase 1).",
"enum": [
"MD5",
"SHA1",
"SHA256",
"GCMAES128",
"GCMAES192",
"GCMAES256"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "IpsecIntegrity"
}
},
"pfsGroup": {
"description": "The Pfs Groups used in IKE Phase 2 for new child SA.",
"enum": [
"None",
"PFS1",
"PFS2",
"PFS2048",
"ECP256",
"ECP384",
"PFS24",
"PFS14",
"PFSMM"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "PfsGroup"
}
},
"saDataSizeKilobytes": {
"description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.",
"format": "int32",
"type": "integer"
},
"saLifeTimeSeconds": {
"description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.",
"format": "int32",
"type": "integer"
}
},
"required": [
"saLifeTimeSeconds",
"saDataSizeKilobytes",
"ipsecEncryption",
"ipsecIntegrity",
"ikeEncryption",
"ikeIntegrity",
"dhGroup",
"pfsGroup"
]
},
"type": "array"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"routingWeight": {
"description": "Routing weight for vpn connection.",
"format": "int32",
"type": "integer"
},
"sharedKey": {
"description": "SharedKey for the vpn connection.",
"type": "string"
},
"useLocalAzureIpAddress": {
"description": "Use local azure ip to initiate connection.",
"type": "boolean"
},
"usePolicyBasedTrafficSelectors": {
"description": "Enable policy-based traffic selectors.",
"type": "boolean"
},
"vpnConnectionProtocolType": {
"description": "Gateway connection protocol.",
"enum": [
"IKEv2",
"IKEv1"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "VirtualNetworkGatewayConnectionProtocol"
}
},
"vpnSiteLink": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
}
}
},
"VpnSiteLinkProperties": {
"description": "Parameters for VpnSite.",
"properties": {
"bgpProperties": {
"$ref": "#/definitions/VpnLinkBgpSettings",
"description": "The set of bgp properties."
},
"ipAddress": {
"description": "The ip-address for the vpn-site-link.",
"type": "string"
},
"linkProperties": {
"$ref": "#/definitions/VpnLinkProviderProperties",
"description": "The link provider properties."
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
}
}
},
"VpnSiteProperties": {
"description": "Parameters for VpnSite.",
"properties": {
"addressSpace": {
"description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.",
"properties": {
"addressPrefixes": {
"description": "A list of address blocks reserved for this virtual network in CIDR notation.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"bgpProperties": {
"description": "BGP settings details.",
"properties": {
"asn": {
"description": "The BGP speaker's ASN.",
"format": "int64",
"type": "integer"
},
"bgpPeeringAddress": {
"description": "The BGP peering address and BGP identifier of this BGP speaker.",
"type": "string"
},
"peerWeight": {
"description": "The weight added to routes learned from this BGP speaker.",
"format": "int32",
"type": "integer"
}
}
},
"deviceProperties": {
"$ref": "#/definitions/DeviceProperties",
"description": "The device properties."
},
"ipAddress": {
"description": "The ip-address for the vpn-site.",
"type": "string"
},
"isSecuritySite": {
"description": "IsSecuritySite flag.",
"type": "boolean"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"siteKey": {
"description": "The key for vpn-site that can be used for connections.",
"type": "string"
},
"virtualWan": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"vpnSiteLinks": {
"description": "List of all vpn site links.",
"items": {
"$ref": "#/definitions/VpnSiteLink"
},
"type": "array"
}
}
}
}
}