{ "swagger": "2.0", "info": { "title": "VirtualWANAsAServiceManagementClient", "description": "REST API for Azure VirtualWAN As a Service.", "version": "2019-07-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}": { "get": { "operationId": "VirtualWans_Get", "x-ms-examples": { "VirtualWANGet": { "$ref": "./examples/VirtualWANGet.json" } }, "description": "Retrieves the details of a VirtualWAN.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualWan." }, { "name": "VirtualWANName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWAN being retrieved." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the VirtualWAN retrieved.", "schema": { "$ref": "#/definitions/VirtualWAN" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } }, "put": { "operationId": "VirtualWans_CreateOrUpdate", "x-ms-examples": { "VirtualWANCreate": { "$ref": "./examples/VirtualWANPut.json" } }, "description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualWan." }, { "name": "VirtualWANName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWAN being created or updated." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "WANParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualWAN" }, "description": "Parameters supplied to create or update 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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "VirtualWANs" ], "operationId": "VirtualWans_UpdateTags", "x-ms-examples": { "VirtualWANUpdate": { "$ref": "./examples/VirtualWANUpdateTags.json" } }, "description": "Updates a VirtualWAN tags.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualWan." }, { "name": "VirtualWANName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWAN being updated." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "WANParameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to Update VirtualWAN tags." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VirtualWans_Delete", "x-ms-examples": { "VirtualWANDelete": { "$ref": "./examples/VirtualWANDelete.json" } }, "description": "Deletes a VirtualWAN.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualWan." }, { "name": "VirtualWANName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWAN being deleted." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": { "get": { "operationId": "VirtualWans_ListByResourceGroup", "x-ms-examples": { "VirtualWANListByResourceGroup": { "$ref": "./examples/VirtualWANListByResourceGroup.json" } }, "description": "Lists all the VirtualWANs in a resource group.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualWan." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the VirtualWANs in the resource group.", "schema": { "$ref": "#/definitions/ListVirtualWANsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": { "get": { "operationId": "VirtualWans_List", "x-ms-examples": { "VirtualWANList": { "$ref": "./examples/VirtualWANList.json" } }, "description": "Lists all the VirtualWANs in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the VirtualWANs in the subscription.", "schema": { "$ref": "#/definitions/ListVirtualWANsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": { "get": { "operationId": "VpnSites_Get", "x-ms-examples": { "VpnSiteGet": { "$ref": "./examples/VpnSiteGet.json" } }, "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnSite." }, { "name": "vpnSiteName", "in": "path", "required": true, "type": "string", "description": "The name of the VpnSite being retrieved." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the VpnSite retrieved.", "schema": { "$ref": "#/definitions/VpnSite" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } }, "put": { "operationId": "VpnSites_CreateOrUpdate", "x-ms-examples": { "VpnSiteCreate": { "$ref": "./examples/VpnSitePut.json" } }, "description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnSite." }, { "name": "vpnSiteName", "in": "path", "required": true, "type": "string", "description": "The name of the VpnSite being created or updated." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "VpnSiteParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VpnSite" }, "description": "Parameters supplied to create or update 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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "VpnSites" ], "operationId": "VpnSites_UpdateTags", "x-ms-examples": { "VpnSiteUpdate": { "$ref": "./examples/VpnSiteUpdateTags.json" } }, "description": "Updates VpnSite tags.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnSite." }, { "name": "vpnSiteName", "in": "path", "required": true, "type": "string", "description": "The name of the VpnSite being updated." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "VpnSiteParameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update VpnSite tags." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VpnSites_Delete", "x-ms-examples": { "VpnSiteDelete": { "$ref": "./examples/VpnSiteDelete.json" } }, "description": "Deletes a VpnSite.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnSite." }, { "name": "vpnSiteName", "in": "path", "required": true, "type": "string", "description": "The name of the VpnSite being deleted." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": { "get": { "operationId": "VpnSites_ListByResourceGroup", "x-ms-examples": { "VpnSiteListByResourceGroup": { "$ref": "./examples/VpnSiteListByResourceGroup.json" } }, "description": "Lists all the vpnSites in a resource group.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnSite." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the vpnSites in the resource group.", "schema": { "$ref": "#/definitions/ListVpnSitesResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}": { "get": { "operationId": "VpnSiteLinks_Get", "x-ms-examples": { "VpnSiteGet": { "$ref": "./examples/VpnSiteLinkGet.json" } }, "description": "Retrieves the details of a VPN site link.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnSite." }, { "name": "vpnSiteName", "in": "path", "required": true, "type": "string", "description": "The name of the VpnSite." }, { "name": "vpnSiteLinkName", "in": "path", "required": true, "type": "string", "description": "The name of the VpnSiteLink being retrieved." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the VpnSiteLink retrieved.", "schema": { "$ref": "#/definitions/VpnSiteLink" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks": { "get": { "operationId": "VpnSiteLinks_ListByVpnSite", "x-ms-examples": { "VpnSiteLinkListByVpnSite": { "$ref": "./examples/VpnSiteLinkListByVpnSite.json" } }, "description": "Lists all the vpnSiteLinks in a resource group for a vpn site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnSite." }, { "name": "vpnSiteName", "in": "path", "required": true, "type": "string", "description": "The name of the VpnSite." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the vpnSites in the resource group.", "schema": { "$ref": "#/definitions/ListVpnSiteLinksResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": { "get": { "operationId": "VpnSites_List", "x-ms-examples": { "VpnSiteList": { "$ref": "./examples/VpnSiteList.json" } }, "description": "Lists all the VpnSites in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the VpnSites in the subscription.", "schema": { "$ref": "#/definitions/ListVpnSitesResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": { "post": { "operationId": "VpnSitesConfiguration_Download", "x-ms-examples": { "VpnSitesConfigurationDownload": { "$ref": "./examples/VpnSitesConfigurationDownload.json" } }, "description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name." }, { "name": "virtualWANName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWAN for which configuration of all vpn-sites is needed." }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetVpnSitesConfigurationRequest" }, "description": "Parameters supplied to download vpn-sites configuration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "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}/supportedSecurityProviders": { "get": { "operationId": "SupportedSecurityProviders", "x-ms-examples": { "supportedSecurityProviders": { "$ref": "./examples/VirtualWanSupportedSecurityProviders.json" } }, "description": "Gives the supported security providers for the virtual wan.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name." }, { "name": "virtualWANName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWAN for which supported security providers are needed." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the object containing supported security providers.", "schema": { "$ref": "#/definitions/VirtualWanSecurityProviders" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": { "get": { "operationId": "VirtualHubs_Get", "x-ms-examples": { "VirtualHubGet": { "$ref": "./examples/VirtualHubGet.json" } }, "description": "Retrieves the details of a VirtualHub.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualHub." }, { "name": "virtualHubName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualHub." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the VirtualHub retrieved.", "schema": { "$ref": "#/definitions/VirtualHub" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } }, "put": { "operationId": "VirtualHubs_CreateOrUpdate", "x-ms-examples": { "VirtualHubPut": { "$ref": "./examples/VirtualHubPut.json" } }, "description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualHub." }, { "name": "virtualHubName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualHub." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "virtualHubParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualHub" }, "description": "Parameters supplied to create or update 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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "VirtualWANs" ], "operationId": "VirtualHubs_UpdateTags", "x-ms-examples": { "VirtualHubUpdate": { "$ref": "./examples/VirtualHubUpdateTags.json" } }, "description": "Updates VirtualHub tags.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualHub." }, { "name": "virtualHubName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualHub." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "virtualHubParameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update VirtualHub tags." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VirtualHubs_Delete", "x-ms-examples": { "VirtualHubDelete": { "$ref": "./examples/VirtualHubDelete.json" } }, "description": "Deletes a VirtualHub.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualHub." }, { "name": "virtualHubName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualHub." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "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": { "operationId": "VirtualHubs_ListByResourceGroup", "x-ms-examples": { "VirtualHubListByResourceGroup": { "$ref": "./examples/VirtualHubListByResourceGroup.json" } }, "description": "Lists all the VirtualHubs in a resource group.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualHub." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the VirtualHubs in the resource group.", "schema": { "$ref": "#/definitions/ListVirtualHubsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": { "get": { "operationId": "VirtualHubs_List", "x-ms-examples": { "VirtualHubList": { "$ref": "./examples/VirtualHubList.json" } }, "description": "Lists all the VirtualHubs in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the VirtualHubs in the subscription.", "schema": { "$ref": "#/definitions/ListVirtualHubsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": { "get": { "operationId": "HubVirtualNetworkConnections_Get", "x-ms-examples": { "HubVirtualNetworkConnectionGet": { "$ref": "./examples/HubVirtualNetworkConnectionGet.json" } }, "description": "Retrieves the details of a HubVirtualNetworkConnection.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualHub." }, { "name": "virtualHubName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualHub." }, { "name": "connectionName", "in": "path", "required": true, "type": "string", "description": "The name of the vpn connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.", "schema": { "$ref": "#/definitions/HubVirtualNetworkConnection" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": { "get": { "operationId": "HubVirtualNetworkConnections_List", "x-ms-examples": { "HubVirtualNetworkConnectionList": { "$ref": "./examples/HubVirtualNetworkConnectionList.json" } }, "description": "Retrieves the details of all HubVirtualNetworkConnections.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualHub." }, { "name": "virtualHubName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualHub." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.", "schema": { "$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": { "get": { "operationId": "VpnGateways_Get", "x-ms-examples": { "VpnGatewayGet": { "$ref": "./examples/VpnGatewayGet.json" } }, "description": "Retrieves the details of a virtual wan vpn gateway.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", "schema": { "$ref": "#/definitions/VpnGateway" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } }, "put": { "operationId": "VpnGateways_CreateOrUpdate", "x-ms-examples": { "VpnGatewayPut": { "$ref": "./examples/VpnGatewayPut.json" } }, "description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "vpnGatewayParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VpnGateway" }, "description": "Parameters supplied to create or Update a virtual wan vpn gateway." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "VpnGateways" ], "operationId": "VpnGateways_UpdateTags", "x-ms-examples": { "VpnGatewayUpdate": { "$ref": "./examples/VpnGatewayUpdateTags.json" } }, "description": "Updates virtual wan vpn gateway tags.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "vpnGatewayParameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update a virtual wan vpn gateway tags." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VpnGateways_Delete", "x-ms-examples": { "VpnGatewayDelete": { "$ref": "./examples/VpnGatewayDelete.json" } }, "description": "Deletes a virtual wan vpn gateway.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "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}/reset": { "post": { "tags": [ "VpnGateways" ], "operationId": "VpnGateways_Reset", "description": "Resets the primary of the vpn gateway in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "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." } }, "x-ms-examples": { "ResetVpnGateway": { "$ref": "./examples/VpnGatewayReset.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": { "get": { "operationId": "VpnGateways_ListByResourceGroup", "x-ms-examples": { "VpnGatewayListByResourceGroup": { "$ref": "./examples/VpnGatewayListByResourceGroup.json" } }, "description": "Lists all the VpnGateways in a resource group.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the VpnGateways in the resource group.", "schema": { "$ref": "#/definitions/ListVpnGatewaysResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": { "get": { "operationId": "VpnGateways_List", "x-ms-examples": { "VpnGatewayListBySubscription": { "$ref": "./examples/VpnGatewayList.json" } }, "description": "Lists all the VpnGateways in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the VpnGateways in the subscription.", "schema": { "$ref": "#/definitions/ListVpnGatewaysResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": { "get": { "operationId": "VpnConnections_Get", "x-ms-examples": { "VpnConnectionGet": { "$ref": "./examples/VpnConnectionGet.json" } }, "description": "Retrieves the details of a vpn connection.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "name": "connectionName", "in": "path", "required": true, "type": "string", "description": "The name of the vpn connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the vpn connection.", "schema": { "$ref": "#/definitions/VpnConnection" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } }, "put": { "operationId": "VpnConnections_CreateOrUpdate", "x-ms-examples": { "VpnConnectionPut": { "$ref": "./examples/VpnConnectionPut.json" } }, "description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "name": "connectionName", "in": "path", "required": true, "type": "string", "description": "The name of the connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "VpnConnectionParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VpnConnection" }, "description": "Parameters supplied to create or Update a VPN Connection." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "delete": { "operationId": "VpnConnections_Delete", "x-ms-examples": { "VpnConnectionDelete": { "$ref": "./examples/VpnConnectionDelete.json" } }, "description": "Deletes a vpn connection.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "name": "connectionName", "in": "path", "required": true, "type": "string", "description": "The name of the connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "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/{connectionName}/vpnLinkConnections/{linkConnectionName}": { "get": { "operationId": "VpnSiteLinkConnections_Get", "x-ms-examples": { "VpnSiteLinkConnectionGet": { "$ref": "./examples/VpnSiteLinkConnectionGet.json" } }, "description": "Retrieves the details of a vpn site link connection.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "name": "connectionName", "in": "path", "required": true, "type": "string", "description": "The name of the vpn connection." }, { "name": "linkConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the vpn connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the vpn connection.", "schema": { "$ref": "#/definitions/VpnSiteLinkConnection" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": { "get": { "operationId": "VpnConnections_ListByVpnGateway", "x-ms-examples": { "VpnConnectionList": { "$ref": "./examples/VpnConnectionList.json" } }, "description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", "schema": { "$ref": "#/definitions/ListVpnConnectionsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections": { "get": { "operationId": "VpnLinkConnections_ListByVpnConnection", "x-ms-examples": { "VpnSiteLinkConnectionList": { "$ref": "./examples/VpnSiteLinkConnectionList.json" } }, "description": "Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "name": "connectionName", "in": "path", "required": true, "type": "string", "description": "The name of the vpn connection." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", "schema": { "$ref": "#/definitions/ListVpnSiteLinkConnectionsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWanName}/p2sVpnServerConfigurations/{p2SVpnServerConfigurationName}": { "get": { "operationId": "P2sVpnServerConfigurations_Get", "x-ms-examples": { "P2SVpnServerConfigurationGet": { "$ref": "./examples/P2SVpnServerConfigurationGet.json" } }, "description": "Retrieves the details of a P2SVpnServerConfiguration.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the P2SVpnServerConfiguration." }, { "name": "virtualWanName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWan." }, { "name": "p2SVpnServerConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the P2SVpnServerConfiguration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the P2SVpnServerConfiguration.", "schema": { "$ref": "#/definitions/P2SVpnServerConfiguration" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } }, "put": { "operationId": "P2sVpnServerConfigurations_CreateOrUpdate", "x-ms-examples": { "P2SVpnServerConfigurationPut": { "$ref": "./examples/P2SVpnServerConfigurationPut.json" } }, "description": "Creates a P2SVpnServerConfiguration to associate with a VirtualWan if it doesn't exist else updates the existing P2SVpnServerConfiguration.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualWan." }, { "name": "virtualWanName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWan." }, { "name": "p2SVpnServerConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the P2SVpnServerConfiguration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "p2SVpnServerConfigurationParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/P2SVpnServerConfiguration" }, "description": "Parameters supplied to create or Update a 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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "delete": { "operationId": "P2sVpnServerConfigurations_Delete", "x-ms-examples": { "P2SVpnServerConfigurationDelete": { "$ref": "./examples/P2SVpnServerConfigurationDelete.json" } }, "description": "Deletes a P2SVpnServerConfiguration.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the P2SVpnServerConfiguration." }, { "name": "virtualWanName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWan." }, { "name": "p2SVpnServerConfigurationName", "in": "path", "required": true, "type": "string", "description": "The name of the P2SVpnServerConfiguration." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "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": { "operationId": "P2sVpnServerConfigurations_ListByVirtualWan", "x-ms-examples": { "P2SVpnServerConfigurationList": { "$ref": "./examples/P2SVpnServerConfigurationList.json" } }, "description": "Retrieves all P2SVpnServerConfigurations for a particular VirtualWan.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the VirtualWan." }, { "name": "virtualWanName", "in": "path", "required": true, "type": "string", "description": "The name of the VirtualWan." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns all P2SVpnServerConfigurations for a VirtualWan.", "schema": { "$ref": "#/definitions/ListP2SVpnServerConfigurationsResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}": { "get": { "operationId": "P2sVpnGateways_Get", "x-ms-examples": { "P2SVpnGatewayGet": { "$ref": "./examples/P2SVpnGatewayGet.json" } }, "description": "Retrieves the details of a virtual wan p2s vpn gateway.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the P2SVpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", "schema": { "$ref": "#/definitions/P2SVpnGateway" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } } }, "put": { "operationId": "P2sVpnGateways_CreateOrUpdate", "x-ms-examples": { "P2SVpnGatewayPut": { "$ref": "./examples/P2SVpnGatewayPut.json" } }, "description": "Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the P2SVpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "p2SVpnGatewayParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/P2SVpnGateway" }, "description": "Parameters supplied to create or Update a virtual wan p2s vpn gateway." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "patch": { "tags": [ "P2SVpnGateways" ], "operationId": "P2sVpnGateways_UpdateTags", "x-ms-examples": { "P2SVpnGatewayUpdate": { "$ref": "./examples/P2SVpnGatewayUpdateTags.json" } }, "description": "Updates virtual wan p2s vpn gateway tags.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the P2SVpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "name": "p2SVpnGatewayParameters", "in": "body", "required": true, "schema": { "$ref": "./network.json#/definitions/TagsObject" }, "description": "Parameters supplied to update a virtual wan p2s vpn gateway tags." } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true }, "delete": { "operationId": "P2sVpnGateways_Delete", "x-ms-examples": { "P2SVpnGatewayDelete": { "$ref": "./examples/P2SVpnGatewayDelete.json" } }, "description": "Deletes a virtual wan p2s vpn gateway.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the P2SVpnGateway." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the gateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "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": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways": { "get": { "operationId": "P2sVpnGateways_ListByResourceGroup", "x-ms-examples": { "P2SVpnGatewayListByResourceGroup": { "$ref": "./examples/P2SVpnGatewayListByResourceGroup.json" } }, "description": "Lists all the P2SVpnGateways in a resource group.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name of the P2SVpnGateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the P2SVpnGateways in the resource group.", "schema": { "$ref": "#/definitions/ListP2SVpnGatewaysResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways": { "get": { "operationId": "P2sVpnGateways_List", "x-ms-examples": { "P2SVpnGatewayListBySubscription": { "$ref": "./examples/P2SVpnGatewayList.json" } }, "description": "Lists all the P2SVpnGateways in a subscription.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Request successful. Returns the details of all the P2SVpnGateways in the subscription.", "schema": { "$ref": "#/definitions/ListP2SVpnGatewaysResult" } }, "default": { "description": "Error.", "schema": { "$ref": "./network.json#/definitions/Error" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile": { "post": { "tags": [ "P2SVpnGateways" ], "operationId": "P2sVpnGateways_GenerateVpnProfile", "description": "Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the P2SVpnGateway." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/P2SVpnProfileParameters" }, "description": "Parameters supplied to the generate P2SVpnGateway VPN client package operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "VPN profile package URL.", "schema": { "$ref": "#/definitions/VpnProfileResponse" } }, "202": { "description": "Accepted and the operation will complete asynchronously." } }, "x-ms-examples": { "GenerateP2SVpnGatewayVPNProfile": { "$ref": "./examples/P2SVpnGatewayGenerateVpnProfile.json" } }, "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": { "tags": [ "P2SVpnGateways" ], "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealth", "description": "Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "gatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the P2SVpnGateway." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, { "$ref": "./network.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "P2S Vpn Gateway with P2S connection health details.", "schema": { "$ref": "#/definitions/P2SVpnGateway" } }, "202": { "description": "Accepted and the operation will complete asynchronously." } }, "x-ms-examples": { "P2SVpnGatewayGetConnectionHealth": { "$ref": "./examples/P2SVpnGatewayGetConnectionHealth.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } } }, "definitions": { "VirtualWanProperties": { "properties": { "disableVpnEncryption": { "type": "boolean", "description": "Vpn encryption to be disabled or not." }, "virtualHubs": { "type": "array", "readOnly": true, "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "List of VirtualHubs in the VirtualWAN." }, "vpnSites": { "type": "array", "readOnly": true, "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "List of VpnSites in the VirtualWAN." }, "securityProviderName": { "type": "string", "description": "The Security Provider name." }, "allowBranchToBranchTraffic": { "type": "boolean", "description": "True if branch to branch traffic is allowed." }, "allowVnetToVnetTraffic": { "type": "boolean", "description": "True if Vnet to Vnet traffic is allowed." }, "office365LocalBreakoutCategory": { "description": "The office local breakout category.", "$ref": "#/definitions/OfficeTrafficCategory" }, "p2SVpnServerConfigurations": { "type": "array", "description": "List of all P2SVpnServerConfigurations associated with the virtual wan.", "items": { "$ref": "#/definitions/P2SVpnServerConfiguration" } }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual WAN resource." } }, "description": "Parameters for VirtualWAN." }, "VirtualWAN": { "required": [ "location" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualWanProperties", "description": "Properties of the virtual WAN." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "VirtualWAN Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualWAN" }, "description": "List of VirtualWANs." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "VpnSiteProperties": { "properties": { "virtualWan": { "$ref": "./network.json#/definitions/SubResource", "description": "The VirtualWAN to which the vpnSite belongs." }, "deviceProperties": { "description": "The device properties.", "$ref": "#/definitions/DeviceProperties" }, "ipAddress": { "type": "string", "description": "The ip-address for the vpn-site." }, "siteKey": { "type": "string", "description": "The key for vpn-site that can be used for connections." }, "addressSpace": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "The AddressSpace that contains an array of IP address ranges." }, "bgpProperties": { "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", "description": "The set of bgp properties." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN site resource." }, "isSecuritySite": { "type": "boolean", "description": "IsSecuritySite flag." }, "vpnSiteLinks": { "type": "array", "description": "List of all vpn site links.", "items": { "$ref": "#/definitions/VpnSiteLink" } } }, "description": "Parameters for VpnSite." }, "VpnSite": { "required": [ "location" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VpnSiteProperties", "description": "Properties of the VPN site." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "VpnSite Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/VpnSite" }, "description": "List of VpnSites." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "VpnSiteLinkProperties": { "properties": { "linkProperties": { "description": "The link provider properties.", "$ref": "#/definitions/VpnLinkProviderProperties" }, "ipAddress": { "type": "string", "description": "The ip-address for the vpn-site-link." }, "bgpProperties": { "$ref": "#/definitions/VpnLinkBgpSettings", "description": "The set of bgp properties." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN site link resource." } }, "description": "Parameters for VpnSite." }, "VpnSiteLink": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VpnSiteLinkProperties", "description": "Properties of the VPN site link." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "VpnSiteLink Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/VpnSiteLink" }, "description": "List of VpnSitesLinks." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "GetVpnSitesConfigurationRequest": { "properties": { "vpnSites": { "type": "array", "items": { "type": "string" }, "description": "List of resource-ids of the vpn-sites for which config is to be downloaded." }, "outputBlobSasUrl": { "type": "string", "description": "The sas-url to download the configurations for vpn-sites." } }, "required": [ "outputBlobSasUrl" ], "description": "List of Vpn-Sites." }, "VirtualHubProperties": { "properties": { "virtualWan": { "$ref": "./network.json#/definitions/SubResource", "description": "The VirtualWAN to which the VirtualHub belongs." }, "vpnGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The VpnGateway associated with this VirtualHub." }, "p2SVpnGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The P2SVpnGateway associated with this VirtualHub." }, "expressRouteGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The expressRouteGateway associated with this VirtualHub." }, "virtualNetworkConnections": { "type": "array", "description": "List of all vnet connections with this VirtualHub.", "items": { "$ref": "#/definitions/HubVirtualNetworkConnection" } }, "addressPrefix": { "type": "string", "description": "Address-prefix for this VirtualHub." }, "routeTable": { "$ref": "#/definitions/VirtualHubRouteTable", "description": "The routeTable associated with this virtual hub." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the virtual hub resource." } }, "description": "Parameters for VirtualHub." }, "VirtualHubRouteTable": { "properties": { "routes": { "type": "array", "description": "List of all routes.", "items": { "$ref": "#/definitions/VirtualHubRoute" } } }, "description": "VirtualHub route table." }, "VirtualHubRoute": { "properties": { "addressPrefixes": { "type": "array", "description": "List of all addressPrefixes.", "items": { "type": "string" } }, "nextHopIpAddress": { "type": "string", "description": "NextHop ip address." } }, "description": "VirtualHub route." }, "VirtualHub": { "required": [ "location" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualHubProperties", "description": "Properties of the virtual hub." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "VirtualHub Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualHub" }, "description": "List of VirtualHubs." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "VpnGatewayProperties": { "properties": { "virtualHub": { "$ref": "./network.json#/definitions/SubResource", "description": "The VirtualHub to which the gateway belongs." }, "connections": { "type": "array", "description": "List of all vpn connections to the gateway.", "items": { "$ref": "#/definitions/VpnConnection" } }, "bgpSettings": { "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", "description": "Local network gateway's BGP speaker settings." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN gateway resource." }, "vpnGatewayScaleUnit": { "type": "integer", "format": "int32", "description": "The scale unit for this vpn gateway." } }, "description": "Parameters for VpnGateway." }, "VpnGateway": { "required": [ "location" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VpnGatewayProperties", "description": "Properties of the VPN gateway." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "VpnGateway Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/VpnGateway" }, "description": "List of VpnGateways." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "VpnConnectionProperties": { "properties": { "remoteVpnSite": { "$ref": "./network.json#/definitions/SubResource", "description": "Id of the connected vpn site." }, "routingWeight": { "type": "integer", "format": "int32", "description": "Routing weight for vpn connection." }, "connectionStatus": { "description": "The connection status.", "$ref": "#/definitions/VpnConnectionStatus" }, "vpnConnectionProtocolType": { "description": "Connection protocol used for this connection.", "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" }, "ingressBytesTransferred": { "type": "integer", "format": "int64", "readOnly": true, "description": "Ingress bytes transferred." }, "egressBytesTransferred": { "type": "integer", "format": "int64", "readOnly": true, "description": "Egress bytes transferred." }, "connectionBandwidth": { "type": "integer", "format": "int32", "description": "Expected bandwidth in MBPS." }, "sharedKey": { "type": "string", "description": "SharedKey for the vpn connection." }, "enableBgp": { "type": "boolean", "description": "EnableBgp flag." }, "usePolicyBasedTrafficSelectors": { "type": "boolean", "description": "Enable policy-based traffic selectors." }, "ipsecPolicies": { "type": "array", "items": { "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" }, "description": "The IPSec Policies to be considered by this connection." }, "enableRateLimiting": { "type": "boolean", "description": "EnableBgp flag." }, "enableInternetSecurity": { "type": "boolean", "description": "Enable internet security." }, "useLocalAzureIpAddress": { "type": "boolean", "description": "Use local azure ip to initiate connection." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN connection resource." }, "vpnLinkConnections": { "type": "array", "description": "List of all vpn site link connections to the gateway.", "items": { "$ref": "#/definitions/VpnSiteLinkConnection" } } }, "description": "Parameters for VpnConnection." }, "VpnConnection": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VpnConnectionProperties", "description": "Properties of the VPN connection." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "VpnConnection Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/VpnConnection" }, "description": "List of Vpn Connections." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "VpnSiteLinkConnectionProperties": { "properties": { "vpnSiteLink": { "$ref": "./network.json#/definitions/SubResource", "description": "Id of the connected vpn site link." }, "routingWeight": { "type": "integer", "format": "int32", "description": "Routing weight for vpn connection." }, "connectionStatus": { "description": "The connection status.", "$ref": "#/definitions/VpnConnectionStatus" }, "vpnConnectionProtocolType": { "description": "Connection protocol used for this connection.", "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" }, "ingressBytesTransferred": { "type": "integer", "format": "int64", "readOnly": true, "description": "Ingress bytes transferred." }, "egressBytesTransferred": { "type": "integer", "format": "int64", "readOnly": true, "description": "Egress bytes transferred." }, "connectionBandwidth": { "type": "integer", "format": "int32", "description": "Expected bandwidth in MBPS." }, "sharedKey": { "type": "string", "description": "SharedKey for the vpn connection." }, "enableBgp": { "type": "boolean", "description": "EnableBgp flag." }, "usePolicyBasedTrafficSelectors": { "type": "boolean", "description": "Enable policy-based traffic selectors." }, "ipsecPolicies": { "type": "array", "items": { "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" }, "description": "The IPSec Policies to be considered by this connection." }, "enableRateLimiting": { "type": "boolean", "description": "EnableBgp flag." }, "useLocalAzureIpAddress": { "type": "boolean", "description": "Use local azure ip to initiate connection." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN site link connection resource." } }, "description": "Parameters for VpnConnection." }, "VpnSiteLinkConnection": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VpnSiteLinkConnectionProperties", "description": "Properties of the VPN site link connection." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." }, "type": { "readOnly": true, "type": "string", "description": "Resource type." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "VpnSiteLinkConnection Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/VpnSiteLinkConnection" }, "description": "List of VpnSiteLinkConnections." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "HubVirtualNetworkConnectionProperties": { "properties": { "remoteVirtualNetwork": { "$ref": "./network.json#/definitions/SubResource", "description": "Reference to the remote virtual network." }, "allowHubToRemoteVnetTransit": { "type": "boolean", "description": "VirtualHub to RemoteVnet transit to enabled or not." }, "allowRemoteVnetToUseHubVnetGateways": { "type": "boolean", "description": "Allow RemoteVnet to use Virtual Hub's gateways." }, "enableInternetSecurity": { "type": "boolean", "description": "Enable internet security." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the hub virtual network connection resource." } }, "description": "Parameters for HubVirtualNetworkConnection." }, "HubVirtualNetworkConnection": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/HubVirtualNetworkConnectionProperties", "description": "Properties of the hub virtual network connection." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "HubVirtualNetworkConnection Resource." }, "ListHubVirtualNetworkConnectionsResult": { "description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/HubVirtualNetworkConnection" }, "description": "List of HubVirtualNetworkConnections." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "VpnSiteId": { "properties": { "vpnSite": { "type": "string", "readOnly": true, "description": "The resource-uri of the vpn-site for which config is to be fetched." } }, "description": "VpnSite Resource." }, "DeviceProperties": { "properties": { "deviceVendor": { "type": "string", "description": "Name of the device Vendor." }, "deviceModel": { "type": "string", "description": "Model of the device." }, "linkSpeedInMbps": { "type": "integer", "format": "int32", "description": "Link speed." } }, "description": "List of properties of the device." }, "VirtualWanSecurityProviders": { "properties": { "supportedProviders": { "type": "array", "items": { "$ref": "#/definitions/VirtualWanSecurityProvider" }, "description": "List of VirtualWAN security providers." } }, "description": "Collection of SecurityProviders." }, "VirtualWanSecurityProvider": { "properties": { "name": { "type": "string", "description": "Name of the security provider." }, "url": { "type": "string", "description": "Url of the security provider." }, "type": { "$ref": "#/definitions/VirtualWanSecurityProviderType", "description": "Name of the security provider." } }, "description": "Collection of SecurityProviders." }, "VpnConnectionStatus": { "type": "string", "description": "The current state of the vpn connection.", "readOnly": true, "enum": [ "Unknown", "Connecting", "Connected", "NotConnected" ], "x-ms-enum": { "name": "VpnConnectionStatus", "modelAsString": true } }, "TunnelConnectionStatus": { "type": "string", "description": "The current state of the tunnel.", "readOnly": true, "enum": [ "Unknown", "Connecting", "Connected", "NotConnected" ], "x-ms-enum": { "name": "TunnelConnectionStatus", "modelAsString": true } }, "HubVirtualNetworkConnectionStatus": { "type": "string", "description": "The current state of the VirtualHub to vnet connection.", "readOnly": true, "enum": [ "Unknown", "Connecting", "Connected", "NotConnected" ], "x-ms-enum": { "name": "HubVirtualNetworkConnectionStatus", "modelAsString": true } }, "OfficeTrafficCategory": { "type": "string", "description": "The office traffic category.", "readOnly": true, "enum": [ "Optimize", "OptimizeAndAllow", "All", "None" ], "x-ms-enum": { "name": "OfficeTrafficCategory", "modelAsString": true } }, "VirtualWanSecurityProviderType": { "type": "string", "description": "The virtual wan security provider type.", "readOnly": true, "enum": [ "External", "Native" ], "x-ms-enum": { "name": "VirtualWanSecurityProviderType", "modelAsString": true } }, "P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat": { "properties": { "publicCertData": { "type": "string", "description": "The certificate public data." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN client root certificate resource." } }, "required": [ "publicCertData" ], "description": "Properties of VPN client root certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigVpnClientRootCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat", "description": "Properties of the P2SVpnServerConfiguration VPN client root certificate." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "required": [ "properties" ], "description": "VPN client root certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat": { "properties": { "publicCertData": { "type": "string", "description": "The certificate public data." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the radius server root certificate resource." } }, "required": [ "publicCertData" ], "description": "Properties of Radius Server root certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigRadiusServerRootCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat", "description": "Properties of the P2SVpnServerConfiguration Radius Server root certificate." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "required": [ "properties" ], "description": "Radius Server root certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat": { "properties": { "thumbprint": { "type": "string", "description": "The revoked VPN client certificate thumbprint." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the VPN client revoked certificate resource." } }, "description": "Properties of the revoked VPN client certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigVpnClientRevokedCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat", "description": "Properties of the vpn client revoked certificate." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "VPN client revoked certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat": { "properties": { "thumbprint": { "type": "string", "description": "The Radius client root certificate thumbprint." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the radius client root certificate resource." } }, "description": "Properties of the Radius client root certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigRadiusClientRootCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat", "description": "Properties of the Radius client root certificate." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "Radius client root certificate of P2SVpnServerConfiguration." }, "P2SVpnServerConfigurationProperties": { "properties": { "name": { "type": "string", "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." }, "vpnProtocols": { "type": "array", "items": { "type": "string", "description": "VPN protocol enabled for the P2SVpnServerConfiguration.", "enum": [ "IkeV2", "OpenVPN" ], "x-ms-enum": { "name": "VpnGatewayTunnelingProtocol", "modelAsString": true } }, "description": "VPN protocols for the P2SVpnServerConfiguration." }, "p2SVpnServerConfigVpnClientRootCertificates": { "type": "array", "items": { "$ref": "#/definitions/P2SVpnServerConfigVpnClientRootCertificate" }, "description": "VPN client root certificate of P2SVpnServerConfiguration." }, "p2SVpnServerConfigVpnClientRevokedCertificates": { "type": "array", "items": { "$ref": "#/definitions/P2SVpnServerConfigVpnClientRevokedCertificate" }, "description": "VPN client revoked certificate of P2SVpnServerConfiguration." }, "p2SVpnServerConfigRadiusServerRootCertificates": { "type": "array", "items": { "$ref": "#/definitions/P2SVpnServerConfigRadiusServerRootCertificate" }, "description": "Radius Server root certificate of P2SVpnServerConfiguration." }, "p2SVpnServerConfigRadiusClientRootCertificates": { "type": "array", "items": { "$ref": "#/definitions/P2SVpnServerConfigRadiusClientRootCertificate" }, "description": "Radius client root certificate of P2SVpnServerConfiguration." }, "vpnClientIpsecPolicies": { "type": "array", "items": { "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" }, "description": "VpnClientIpsecPolicies for P2SVpnServerConfiguration." }, "radiusServerAddress": { "type": "string", "description": "The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection." }, "radiusServerSecret": { "type": "string", "description": "The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection." }, "provisioningState": { "readOnly": true, "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the P2S VPN server configuration resource." }, "p2SVpnGateways": { "type": "array", "readOnly": true, "items": { "$ref": "./network.json#/definitions/SubResource" }, "description": "List of references to P2SVpnGateways." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "description": "Parameters for P2SVpnServerConfiguration." }, "P2SVpnServerConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/P2SVpnServerConfigurationProperties", "description": "Properties of the P2SVpnServer configuration." }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "P2SVpnServerConfiguration Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/P2SVpnServerConfiguration" }, "description": "List of P2SVpnServerConfigurations." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "VpnClientConnectionHealth": { "properties": { "totalIngressBytesTransferred": { "readOnly": true, "type": "integer", "format": "int64", "description": "Total of the Ingress Bytes Transferred in this P2S Vpn connection." }, "totalEgressBytesTransferred": { "readOnly": true, "type": "integer", "format": "int64", "description": "Total of the Egress Bytes Transferred in this connection." }, "vpnClientConnectionsCount": { "type": "integer", "format": "int32", "description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway." }, "allocatedIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "List of allocated ip addresses to the connected p2s vpn clients." } }, "description": "VpnClientConnectionHealth properties." }, "P2SVpnGatewayProperties": { "properties": { "virtualHub": { "$ref": "./network.json#/definitions/SubResource", "description": "The VirtualHub to which the gateway belongs." }, "provisioningState": { "$ref": "./network.json#/definitions/ProvisioningState", "description": "The provisioning state of the P2S VPN gateway resource." }, "vpnGatewayScaleUnit": { "type": "integer", "format": "int32", "description": "The scale unit for this p2s vpn gateway." }, "p2SVpnServerConfiguration": { "$ref": "./network.json#/definitions/SubResource", "description": "The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to." }, "vpnClientAddressPool": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "The reference of the address space resource which represents Address space for P2S VpnClient." }, "customRoutes": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient." }, "vpnClientConnectionHealth": { "readOnly": true, "$ref": "#/definitions/VpnClientConnectionHealth", "description": "All P2S VPN clients' connection health status." } }, "description": "Parameters for P2SVpnGateway." }, "P2SVpnGateway": { "required": [ "location" ], "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/P2SVpnGatewayProperties", "description": "Properties of the P2SVpnGateway." }, "etag": { "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "P2SVpnGateway Resource." }, "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": { "value": { "type": "array", "items": { "$ref": "#/definitions/P2SVpnGateway" }, "description": "List of P2SVpnGateways." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any." } } }, "P2SVpnProfileParameters": { "properties": { "authenticationMethod": { "$ref": "./network.json#/definitions/AuthenticationMethod", "description": "VPN client authentication method." } }, "description": "Vpn Client Parameters for package generation." }, "VpnProfileResponse": { "properties": { "profileUrl": { "type": "string", "description": "URL to the VPN profile." } }, "description": "Vpn Profile Response for package generation." }, "VpnLinkBgpSettings": { "properties": { "asn": { "type": "integer", "format": "int64", "description": "The BGP speaker's ASN." }, "bgpPeeringAddress": { "type": "string", "description": "The BGP peering address and BGP identifier of this BGP speaker." } }, "description": "BGP settings details for a link." }, "VpnLinkProviderProperties": { "properties": { "linkProviderName": { "type": "string", "description": "Name of the link provider." }, "linkSpeedInMbps": { "type": "integer", "format": "int32", "description": "Link speed." } }, "description": "List of properties of a link provider." } } }