swagger: '2.0' info: title: Microsoft Azure VirtualWANAsAServiceManagementClient description: REST API for Azure VirtualWAN As a Service. version: '2023-11-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: microsoftAzureVirtualwansGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname tags: - Subscriptions put: operationId: microsoftAzureVirtualwansCreateorupdate 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname tags: - Subscriptions patch: tags: - VirtualWANs operationId: microsoftAzureVirtualwansUpdatetags 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' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname delete: operationId: microsoftAzureVirtualwansDelete 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans: get: operationId: microsoftAzureVirtualwansListbyresourcegroup 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans: get: operationId: microsoftAzureVirtualwansList 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Virtualwans tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}: get: operationId: microsoftAzureVpnsitesGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename tags: - Subscriptions put: operationId: microsoftAzureVpnsitesCreateorupdate 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename tags: - Subscriptions patch: tags: - VpnSites operationId: microsoftAzureVpnsitesUpdatetags 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' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename delete: operationId: microsoftAzureVpnsitesDelete 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites: get: operationId: microsoftAzureVpnsitesListbyresourcegroup 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName} : get: operationId: microsoftAzureVpnsitelinksGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename Vpnsitelinks Vpnsitelinkname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks : get: operationId: microsoftAzureVpnsitelinksListbyvpnsite 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnsites Vpnsitename Vpnsitelinks tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites: get: operationId: microsoftAzureVpnsitesList 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Vpnsites tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration : post: operationId: microsoftAzureVpnsitesconfigurationDownload 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Vpnconfiguration tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders : get: operationId: microsoftAzureSupportedsecurityproviders 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Supportedsecurityproviders tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName} : get: operationId: microsoftAzureVpnserverconfigurationsGet x-ms-examples: VpnServerConfigurationGet: $ref: ./examples/VpnServerConfigurationGet.json description: Retrieves the details of a VpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration being retrieved. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of the VpnServerConfiguration retrieved. schema: $ref: '#/definitions/VpnServerConfiguration' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname tags: - Subscriptions put: operationId: microsoftAzureVpnserverconfigurationsCreateorupdate x-ms-examples: VpnServerConfigurationCreate: $ref: ./examples/VpnServerConfigurationPut.json description: >- Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration being created or updated. - $ref: ./network.json#/parameters/ApiVersionParameter - name: VpnServerConfigurationParameters in: body required: true schema: $ref: '#/definitions/VpnServerConfiguration' description: Parameters supplied to create or update VpnServerConfiguration. responses: '200': description: >- Request successful. Returns the details of the VpnServerConfiguration created or updated. schema: $ref: '#/definitions/VpnServerConfiguration' '201': description: >- Request received successfully. Returns the details of the VpnServerConfiguration created or updated. schema: $ref: '#/definitions/VpnServerConfiguration' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname tags: - Subscriptions patch: tags: - VpnServerConfigurations operationId: microsoftAzureVpnserverconfigurationsUpdatetags x-ms-examples: VpnServerConfigurationUpdate: $ref: ./examples/VpnServerConfigurationUpdateTags.json description: Updates VpnServerConfiguration tags. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration being updated. - $ref: ./network.json#/parameters/ApiVersionParameter - name: VpnServerConfigurationParameters in: body required: true schema: $ref: ./network.json#/definitions/TagsObject description: Parameters supplied to update VpnServerConfiguration tags. responses: '200': description: >- Request successful. Returns the details of the VpnServerConfiguration updated. schema: $ref: '#/definitions/VpnServerConfiguration' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname delete: operationId: microsoftAzureVpnserverconfigurationsDelete x-ms-examples: VpnServerConfigurationDelete: $ref: ./examples/VpnServerConfigurationDelete.json description: Deletes a VpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration being deleted. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VpnServerConfiguration deleted. '202': description: >- Request received successfully. VpnServerConfiguration deletion is in progress. '204': description: No VpnServerConfigurations exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations: get: operationId: microsoftAzureVpnserverconfigurationsListbyresourcegroup x-ms-examples: VpnServerConfigurationListByResourceGroup: $ref: ./examples/VpnServerConfigurationListByResourceGroup.json description: Lists all the vpnServerConfigurations 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 VpnServerConfiguration. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of all the vpnServerConfigurations in the resource group. schema: $ref: '#/definitions/ListVpnServerConfigurationsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName} : put: operationId: microsoftAzureConfigurationpolicygroupsCreateorupdate x-ms-examples: ConfigurationPolicyGroupPut: $ref: ./examples/ConfigurationPolicyGroupPut.json description: >- Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the ConfigurationPolicyGroup. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - name: configurationPolicyGroupName in: path required: true type: string description: The name of the ConfigurationPolicyGroup. - $ref: ./network.json#/parameters/ApiVersionParameter - name: VpnServerConfigurationPolicyGroupParameters in: body required: true schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' description: >- Parameters supplied to create or update a VpnServerConfiguration PolicyGroup. responses: '200': description: >- Request successful. Returns the details of the VpnServerConfiguration PolicyGroup created or updated. schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' '201': description: >- Request successful. Returns the details of the VpnServerConfiguration PolicyGroup retrieved. schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups Configurationpolicygroupname tags: - Subscriptions delete: operationId: microsoftAzureConfigurationpolicygroupsDelete x-ms-examples: ConfigurationPolicyGroupDelete: $ref: ./examples/ConfigurationPolicyGroupDelete.json description: Deletes a ConfigurationPolicyGroup. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the ConfigurationPolicyGroup. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - name: configurationPolicyGroupName in: path required: true type: string description: The name of the ConfigurationPolicyGroup. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. ConfigurationPolicyGroup deleted. '202': description: >- Request received successfully. ConfigurationPolicyGroup deletion is in progress; follow the Location header to poll for final outcome. '204': description: No ConfigurationPolicyGroup exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups Configurationpolicygroupname tags: - Subscriptions get: operationId: microsoftAzureConfigurationpolicygroupsGet x-ms-examples: ConfigurationPolicyGroupGet: $ref: ./examples/ConfigurationPolicyGroupGet.json description: Retrieves the details of a ConfigurationPolicyGroup. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - name: configurationPolicyGroupName in: path required: true type: string description: The name of the ConfigurationPolicyGroup being retrieved. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of the ConfigurationPolicyGroup retrieved. schema: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups Configurationpolicygroupname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups : get: operationId: microsoftAzureConfigurationpolicygroupsListbyvpnserverconfiguration x-ms-examples: ConfigurationPolicyGroupListByVpnServerConfiguration: $ref: ./examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json description: >- Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VpnServerConfiguration. - name: vpnServerConfigurationName in: path required: true type: string description: The name of the VpnServerConfiguration. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of all the VpnServerConfigurations in the resource group. schema: $ref: '#/definitions/ListVpnServerConfigurationPolicyGroupsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpnserverconfigurations Vpnserverconfigurationname Configurationpolicygroups tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations: get: operationId: microsoftAzureVpnserverconfigurationsList x-ms-examples: VpnServerConfigurationList: $ref: ./examples/VpnServerConfigurationList.json description: Lists all the VpnServerConfigurations 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 VpnServerConfigurations in the subscription. schema: $ref: '#/definitions/ListVpnServerConfigurationsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Vpnserverconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName} : get: operationId: microsoftAzureVirtualhubsGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname tags: - Subscriptions put: operationId: microsoftAzureVirtualhubsCreateorupdate 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname tags: - Subscriptions patch: tags: - VirtualWANs operationId: microsoftAzureVirtualhubsUpdatetags 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' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname delete: operationId: microsoftAzureVirtualhubsDelete 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs: get: operationId: microsoftAzureVirtualhubsListbyresourcegroup 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs: get: operationId: microsoftAzureVirtualhubsList 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Virtualhubs tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName} : get: operationId: microsoftAzureRoutemapsGet x-ms-examples: RouteMapGet: $ref: ./examples/RouteMapGet.json description: Retrieves the details of a RouteMap. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - name: routeMapName in: path required: true type: string description: The name of the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the RouteMap retrieved. schema: $ref: '#/definitions/RouteMap' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps Routemapname tags: - Subscriptions put: operationId: microsoftAzureRoutemapsCreateorupdate x-ms-examples: RouteMapPut: $ref: ./examples/RouteMapPut.json description: Creates a RouteMap if it doesn't exist else updates the existing one. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - name: routeMapName in: path required: true type: string description: The name of the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter - name: routeMapParameters in: body required: true schema: $ref: '#/definitions/RouteMap' description: Parameters supplied to create or update a RouteMap. responses: '200': description: >- Request successful. Returns the details of the RouteMap created or updated. schema: $ref: '#/definitions/RouteMap' '201': description: Request successful. Returns the details of the RouteMap retrieved. schema: $ref: '#/definitions/RouteMap' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps Routemapname tags: - Subscriptions delete: operationId: microsoftAzureRoutemapsDelete x-ms-examples: RouteMapDelete: $ref: ./examples/RouteMapDelete.json description: Deletes a RouteMap. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - name: routeMapName in: path required: true type: string description: The name of the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. RouteMap deleted. '202': description: >- Request received successfully. RouteMap deletion is in progress; follow the Location header to poll for final outcome. '204': description: No RouteMaps exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps Routemapname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps : get: operationId: microsoftAzureRoutemapsList x-ms-examples: RouteMapList: $ref: ./examples/RouteMapList.json description: Retrieves the details of all RouteMaps. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteMap's resource group'. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub containing the RouteMap. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of all the RouteMaps for the VirtualHub. schema: $ref: '#/definitions/ListRouteMapsResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routemaps tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName} : put: operationId: microsoftAzureHubvirtualnetworkconnectionsCreateorupdate x-ms-examples: HubVirtualNetworkConnectionPut: $ref: ./examples/HubVirtualNetworkConnectionPut.json description: >- Creates a hub virtual network connection if it doesn't exist else updates the existing one. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the HubVirtualNetworkConnection. - 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 HubVirtualNetworkConnection. - $ref: ./network.json#/parameters/ApiVersionParameter - name: hubVirtualNetworkConnectionParameters in: body required: true schema: $ref: '#/definitions/HubVirtualNetworkConnection' description: >- Parameters supplied to create or update a hub virtual network connection. responses: '200': description: >- Request successful. Returns the details of the hub virtual network connection created or updated. schema: $ref: '#/definitions/HubVirtualNetworkConnection' '201': description: >- Request successful. Returns the details of the hub virtual network connection retrieved. schema: $ref: '#/definitions/HubVirtualNetworkConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureHubvirtualnetworkconnectionsDelete x-ms-examples: HubVirtualNetworkConnectionDelete: $ref: ./examples/HubVirtualNetworkConnectionDelete.json description: Deletes 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 HubVirtualNetworkConnection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. HubVirtualNetworkConnection deleted. '202': description: >- Request received successfully. HubVirtualNetworkConnection deletion is in progress; follow the Location header to poll for final outcome. '204': description: No HubVirtualNetworkConnection exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections Connectionname tags: - Subscriptions get: operationId: microsoftAzureHubvirtualnetworkconnectionsGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections : get: operationId: microsoftAzureHubvirtualnetworkconnectionsList 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubvirtualnetworkconnections tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}: get: operationId: microsoftAzureVpngatewaysGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname tags: - Subscriptions put: operationId: microsoftAzureVpngatewaysCreateorupdate 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname tags: - Subscriptions patch: tags: - VpnGateways operationId: microsoftAzureVpngatewaysUpdatetags 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' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname delete: operationId: microsoftAzureVpngatewaysDelete 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset : post: tags: - VpnGateways operationId: microsoftAzureVpngatewaysReset 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. - name: ipConfigurationId in: query required: false type: string description: VpnGateway ipConfigurationId to specify the gateway instance. - $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. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: ResetVpnGateway: $ref: ./examples/VpnGatewayReset.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Reset ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/startpacketcapture : post: tags: - VpnGateways operationId: microsoftAzureVpngatewaysStartpacketcapture description: Starts packet capture on 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. - name: parameters in: body required: false schema: $ref: '#/definitions/VpnGatewayPacketCaptureStartParameters' description: >- Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Request successful. The operation packet capture started on vpn gateway. schema: type: string '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Start packet capture on vpn gateway without filter: $ref: ./examples/VpnGatewayStartPacketCapture.json Start packet capture on vpn gateway with filter: $ref: ./examples/VpnGatewayStartPacketCaptureFilterData.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Startpacketcapture ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/stoppacketcapture : post: tags: - VpnGateways operationId: microsoftAzureVpngatewaysStoppacketcapture description: Stops packet capture on 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. - name: parameters in: body required: false schema: $ref: '#/definitions/VpnGatewayPacketCaptureStopParameters' description: >- Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Request successful. The operation packet capture stopped on vpn gateway. schema: type: string '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Stop packet capture on vpn gateway: $ref: ./examples/VpnGatewayStopPacketCapture.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Stoppacketcapture ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/resetconnection : post: tags: - vpnLinkConnections operationId: microsoftAzureVpnlinkconnectionsResetconnection description: Resets the VpnLink connection specified. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - 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 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 link connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '202': description: >- Accepted and the operation ResetConnection will complete asynchronously. default: description: The operation ResetConnection could not be completed. schema: $ref: ./networkWatcher.json#/definitions/ErrorResponse x-ms-examples: ResetVpnLinkConnection: $ref: ./examples/VpnSiteLinkConnectionReset.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname Vpnlinkconnections Linkconnectionname Resetconnection /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways: get: operationId: microsoftAzureVpngatewaysListbyresourcegroup 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways: get: operationId: microsoftAzureVpngatewaysList 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Vpngateways tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName} : get: operationId: microsoftAzureVpnconnectionsGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname tags: - Subscriptions put: operationId: microsoftAzureVpnconnectionsCreateorupdate 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureVpnconnectionsDelete 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName} : get: operationId: microsoftAzureVpnsitelinkconnectionsGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname Vpnlinkconnections Linkconnectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/getikesas : post: operationId: microsoftAzureVpnlinkconnectionsGetikesas x-ms-examples: GetVpnLinkConnectionIkeSa: $ref: ./examples/VpnSiteLinkConnectionGetIkeSas.json description: >- Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - 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 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 link connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. The operation getikesas completed on vpn site link connection. schema: type: string '202': description: Accepted and the operation GetIkeSas will complete asynchronously. default: description: The operation GetIkeSas could not be completed. schema: $ref: ./networkWatcher.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname Vpnlinkconnections Linkconnectionname Getikesas tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/startpacketcapture : post: operationId: microsoftAzureVpnconnectionsStartpacketcapture description: Starts packet capture on Vpn connection 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 gateway. - name: vpnConnectionName in: path required: true type: string description: The name of the vpn connection. - name: parameters in: body required: false schema: $ref: '#/definitions/VpnConnectionPacketCaptureStartParameters' description: >- Vpn Connection packet capture parameters supplied to start packet capture on gateway connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Request successful. The operation packet capture started on vpn connection. schema: type: string '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Start packet capture on vpn connection without filter: $ref: ./examples/VpnConnectionStartPacketCapture.json Start packet capture on vpn connection with filter: $ref: ./examples/VpnConnectionStartPacketCaptureFilterData.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Vpnconnectionname Startpacketcapture tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/stoppacketcapture : post: operationId: microsoftAzureVpnconnectionsStoppacketcapture description: Stops packet capture on Vpn connection 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 gateway. - name: vpnConnectionName in: path required: true type: string description: The name of the vpn connection. - name: parameters in: body required: false schema: $ref: '#/definitions/VpnConnectionPacketCaptureStopParameters' description: >- Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Request successful. The operation packet capture stopped on vpn connection. schema: type: string '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Start packet capture on vpn connection without filter: $ref: ./examples/VpnConnectionStopPacketCapture.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Vpnconnectionname Stoppacketcapture tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections : get: operationId: microsoftAzureVpnconnectionsListbyvpngateway 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections : get: operationId: microsoftAzureVpnlinkconnectionsListbyvpnconnection 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 vpn gateway. - 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Vpnconnections Connectionname Vpnlinkconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName} : get: operationId: microsoftAzureNatrulesGet x-ms-examples: NatRuleGet: $ref: ./examples/NatRuleGet.json description: Retrieves the details of a nat ruleGet. 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: natRuleName in: path required: true type: string description: The name of the nat rule. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the nat rule. schema: $ref: '#/definitions/VpnGatewayNatRule' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules Natrulename tags: - Subscriptions put: operationId: microsoftAzureNatrulesCreateorupdate x-ms-examples: NatRulePut: $ref: ./examples/NatRulePut.json description: >- Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules. 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: natRuleName in: path required: true type: string description: The name of the nat rule. - $ref: ./network.json#/parameters/ApiVersionParameter - name: NatRuleParameters in: body required: true schema: $ref: '#/definitions/VpnGatewayNatRule' description: Parameters supplied to create or Update a Nat Rule. responses: '200': description: >- Request successful. Returns the details of the nat rule created or updated. schema: $ref: '#/definitions/VpnGatewayNatRule' '201': description: >- Request successful. Returns the details of the nat rule created or updated. schema: $ref: '#/definitions/VpnGatewayNatRule' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules Natrulename tags: - Subscriptions delete: operationId: microsoftAzureNatrulesDelete x-ms-examples: NatRuleDelete: $ref: ./examples/NatRuleDelete.json description: Deletes a nat rule. 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: natRuleName in: path required: true type: string description: The name of the nat rule. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Nat Rule deleted. '202': description: >- Request received successfully. Nat Rule deletion is in progress; follow the Location header to poll for final outcome. '204': description: No nat rules exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules Natrulename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules : get: operationId: microsoftAzureNatrulesListbyvpngateway x-ms-examples: NatRuleList: $ref: ./examples/NatRuleList.json description: Retrieves all nat rules 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 Nat rules for a virtual wan vpn gateway. schema: $ref: '#/definitions/ListVpnGatewayNatRulesResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Vpngateways Gatewayname Natrules tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName} : get: operationId: microsoftAzureP2svpngatewaysGet 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname tags: - Subscriptions put: operationId: microsoftAzureP2svpngatewaysCreateorupdate 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname tags: - Subscriptions patch: tags: - P2SVpnGateways operationId: microsoftAzureP2svpngatewaysUpdatetags 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' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname delete: operationId: microsoftAzureP2svpngatewaysDelete 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname tags: - Subscriptions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways: get: operationId: microsoftAzureP2svpngatewaysListbyresourcegroup 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways tags: - Subscriptions /subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways: get: operationId: microsoftAzureP2svpngatewaysList 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 response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network P2svpngateways tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/reset : post: tags: - P2SVpnGateways operationId: microsoftAzureP2svpngatewaysReset description: >- Resets the primary of the p2s vpn gateway in the specified resource group. parameters: - 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 - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Request successful. The operation reset the primary of the P2SVpnGateway. schema: $ref: '#/definitions/P2SVpnGateway' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: ResetP2SVpnGateway: $ref: ./examples/P2SVpnGatewayReset.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname Reset ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile : post: tags: - P2SVpnGateways operationId: microsoftAzureP2svpngatewaysGeneratevpnprofile 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. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: GenerateP2SVpnGatewayVPNProfile: $ref: ./examples/P2SVpnGatewayGenerateVpnProfile.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname Generatevpnprofile ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth : post: tags: - P2SVpnGateways operationId: microsoftAzureP2svpngatewaysGetp2svpnconnectionhealth 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. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: P2SVpnGatewayGetConnectionHealth: $ref: ./examples/P2SVpnGatewayGetConnectionHealth.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname Getp2svpnconnectionhealth ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealthDetailed : post: tags: - P2SVpnGateways operationId: microsoftAzureP2svpngatewaysGetp2svpnconnectionhealthdetailed description: >- Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - 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: request in: body required: true schema: $ref: '#/definitions/P2SVpnConnectionHealthRequest' description: >- Request parameters supplied to get p2s vpn connections detailed health. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: P2S connections detailed health report. schema: $ref: '#/definitions/P2SVpnConnectionHealth' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: P2SVpnGatewayGetConnectionHealthDetailed: $ref: ./examples/P2SVpnGatewayGetConnectionHealthDetailed.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways Gatewayname Getp2svpnconnectionhealthdetailed ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations : post: operationId: microsoftAzureVpnserverconfigurationsassociatedwithvirtualwanList x-ms-examples: GetVirtualWanVpnServerConfigurations: $ref: ./examples/GetVirtualWanVpnServerConfigurations.json description: >- Gives the list of VpnServerConfigurations associated with Virtual Wan 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 whose associated VpnServerConfigurations is needed. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: List of associated VpnServerConfigurations list. schema: $ref: '#/definitions/VpnServerConfigurationsResponse' '202': description: >- Accepted and the operation will complete asynchronously. Follow the location header for list of associated VpnServerConfigurations list. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Vpnserverconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/GenerateVpnProfile : post: operationId: microsoftAzureGeneratevirtualwanvpnserverconfigurationvpnprofile x-ms-examples: GenerateVirtualWanVpnServerConfigurationVpnProfile: $ref: ./examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json description: >- Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified 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 whose associated VpnServerConfigurations is needed. - name: vpnClientParams in: body required: true schema: $ref: '#/definitions/VirtualWanVpnProfileParameters' description: >- Parameters supplied to the generate VirtualWan VPN profile generation operation. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: VPN profile package URL. schema: $ref: '#/definitions/VpnProfileResponse' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualwans Virtualwanname Generatevpnprofile tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName} : get: operationId: microsoftAzureVirtualhubroutetablev2sGet x-ms-examples: VirtualHubVirtualHubRouteTableV2Get: $ref: ./examples/VirtualHubRouteTableV2Get.json description: Retrieves the details of a VirtualHubRouteTableV2. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubRouteTableV2. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the VirtualHubRouteTableV2. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of the VirtualHubRouteTableV2 retrieved. schema: $ref: '#/definitions/VirtualHubRouteTableV2' default: description: Error. schema: $ref: ./network.json#/definitions/Error summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables Routetablename tags: - Subscriptions put: operationId: microsoftAzureVirtualhubroutetablev2sCreateorupdate x-ms-examples: VirtualHubRouteTableV2Put: $ref: ./examples/VirtualHubRouteTableV2Put.json description: >- Creates a VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2. 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: routeTableName in: path required: true type: string description: The name of the VirtualHubRouteTableV2. - $ref: ./network.json#/parameters/ApiVersionParameter - name: virtualHubRouteTableV2Parameters in: body required: true schema: $ref: '#/definitions/VirtualHubRouteTableV2' description: Parameters supplied to create or update VirtualHubRouteTableV2. responses: '200': description: >- Request successful. Returns the details of the VirtualHubRouteTableV2 created or updated. schema: $ref: '#/definitions/VirtualHubRouteTableV2' '201': description: >- Request received successfully. Returns the details of the VirtualHubRouteTableV2 created or updated. schema: $ref: '#/definitions/VirtualHubRouteTableV2' 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 summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables Routetablename tags: - Subscriptions delete: operationId: microsoftAzureVirtualhubroutetablev2sDelete x-ms-examples: VirtualHubRouteTableV2Delete: $ref: ./examples/VirtualHubRouteTableV2Delete.json description: Deletes a VirtualHubRouteTableV2. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubRouteTableV2. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the VirtualHubRouteTableV2. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualHubRouteTableV2 deleted. '202': description: >- Request received successfully. VirtualHubRouteTableV2 deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualHubRouteTableV2s 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 summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables Routetablename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables : get: operationId: microsoftAzureVirtualhubroutetablev2sList x-ms-examples: VirtualHubRouteTableV2List: $ref: ./examples/VirtualHubRouteTableV2List.json description: Retrieves the details of all VirtualHubRouteTableV2s. 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 VirtualHubRouteTableV2s for the VirtualHub. schema: $ref: '#/definitions/ListVirtualHubRouteTableV2sResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routetables tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{p2sVpnGatewayName}/disconnectP2sVpnConnections : post: tags: - P2SVpnGateways operationId: microsoftAzureP2svpngatewaysDisconnectp2svpnconnections description: >- Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: p2sVpnGatewayName in: path required: true type: string description: The name of the P2S Vpn Gateway. - name: request in: body required: true schema: $ref: '#/definitions/P2SVpnConnectionRequest' description: The parameters are supplied to disconnect p2s vpn connections. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. The operation disconnects the requested vpn connections. '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: Disconnect VpnConnections from P2sVpn Gateway: $ref: ./examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network P2svpngateways P2svpngatewayname Disconnectp2svpnconnections /subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways: get: tags: - ExpressRouteGateways operationId: microsoftAzureExpressroutegatewaysListbysubscription x-ms-examples: ExpressRouteGatewayListBySubscription: $ref: ./examples/ExpressRouteGatewayListBySubscription.json description: Lists ExpressRoute gateways under a given subscription. parameters: - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Request successful. schema: $ref: '#/definitions/ExpressRouteGatewayList' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Expressroutegateways /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways: get: tags: - ExpressRouteGateways operationId: microsoftAzureExpressroutegatewaysListbyresourcegroup x-ms-examples: ExpressRouteGatewayListByResourceGroup: $ref: ./examples/ExpressRouteGatewayListByResourceGroup.json description: Lists ExpressRoute gateways in a given resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Operation successful. schema: $ref: '#/definitions/ExpressRouteGatewayList' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName} : put: tags: - ExpressRouteGateways operationId: microsoftAzureExpressroutegatewaysCreateorupdate x-ms-examples: ExpressRouteGatewayCreate: $ref: ./examples/ExpressRouteGatewayCreate.json description: Creates or updates a ExpressRoute gateway in a specified resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: expressRouteGatewayName in: path required: true type: string description: The name of the ExpressRoute gateway. - name: putExpressRouteGatewayParameters in: body required: true schema: $ref: '#/definitions/ExpressRouteGateway' description: Parameters required in an ExpressRoute gateway PUT operation. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Update successful. The operation returns the resulting ExpressRoute gateway resource. schema: $ref: '#/definitions/ExpressRouteGateway' '201': description: >- Create successful. The operation returns the resulting ExpressRoute gateway resource. schema: $ref: '#/definitions/ExpressRouteGateway' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname patch: tags: - ExpressRouteGateways operationId: microsoftAzureExpressroutegatewaysUpdatetags x-ms-examples: ExpressRouteGatewayUpdate: $ref: ./examples/ExpressRouteGatewayUpdateTags.json description: Updates express route gateway tags. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the ExpressRouteGateway. - name: expressRouteGatewayName in: path required: true type: string description: The name of the gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - name: expressRouteGatewayParameters in: body required: true schema: $ref: ./network.json#/definitions/TagsObject description: >- Parameters supplied to update a virtual wan express route gateway tags. responses: '200': description: Request successful. Returns the details of the updated gateway. schema: $ref: '#/definitions/ExpressRouteGateway' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname get: tags: - ExpressRouteGateways operationId: microsoftAzureExpressroutegatewaysGet x-ms-examples: ExpressRouteGatewayGet: $ref: ./examples/ExpressRouteGatewayGet.json description: Fetches the details of a ExpressRoute gateway in a resource group. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: expressRouteGatewayName in: path required: true type: string description: The name of the ExpressRoute gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Operation succeeded. The operation returns the ExpressRoute gateway. schema: $ref: '#/definitions/ExpressRouteGateway' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname delete: tags: - ExpressRouteGateways operationId: microsoftAzureExpressroutegatewaysDelete x-ms-examples: ExpressRouteGatewayDelete: $ref: ./examples/ExpressRouteGatewayDelete.json description: >- Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: expressRouteGatewayName in: path required: true type: string description: The name of the ExpressRoute gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Delete successful. '202': description: Accepted and the operation will complete asynchronously. '204': description: Delete successful. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName} : put: tags: - ExpressRouteConnections operationId: microsoftAzureExpressrouteconnectionsCreateorupdate x-ms-examples: ExpressRouteConnectionCreate: $ref: ./examples/ExpressRouteConnectionCreate.json description: >- Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: expressRouteGatewayName in: path required: true type: string description: The name of the ExpressRoute gateway. - name: connectionName in: path required: true type: string description: The name of the connection subresource. - name: putExpressRouteConnectionParameters in: body required: true schema: $ref: '#/definitions/ExpressRouteConnection' description: Parameters required in an ExpressRouteConnection PUT operation. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Update successful. The operation returns the ExpressRouteConnection. schema: $ref: '#/definitions/ExpressRouteConnection' '201': description: Create successful. The operation returns the ExpressRouteConnection. schema: $ref: '#/definitions/ExpressRouteConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections Connectionname get: tags: - ExpressRouteConnections operationId: microsoftAzureExpressrouteconnectionsGet x-ms-examples: ExpressRouteConnectionGet: $ref: ./examples/ExpressRouteConnectionGet.json description: Gets the specified ExpressRouteConnection. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: expressRouteGatewayName in: path required: true type: string description: The name of the ExpressRoute gateway. - name: connectionName in: path required: true type: string description: The name of the ExpressRoute connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: >- Request successful. The operation returns the ExpressRouteConnection. schema: $ref: '#/definitions/ExpressRouteConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections Connectionname delete: tags: - ExpressRouteConnections operationId: microsoftAzureExpressrouteconnectionsDelete x-ms-examples: ExpressRouteConnectionDelete: $ref: ./examples/ExpressRouteConnectionDelete.json description: Deletes a connection to a ExpressRoute circuit. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: expressRouteGatewayName in: path required: true type: string description: The name of the ExpressRoute gateway. - name: connectionName in: path required: true type: string description: The name of the connection subresource. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Delete successful. '202': description: Accepted, and the operation will continue asynchronously. '204': description: Delete successful. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections Connectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections : get: tags: - ExpressRouteConnections operationId: microsoftAzureExpressrouteconnectionsList x-ms-examples: ExpressRouteConnectionList: $ref: ./examples/ExpressRouteConnectionList.json description: Lists ExpressRouteConnections. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: expressRouteGatewayName in: path required: true type: string description: The name of the ExpressRoute gateway. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: Request successful. schema: $ref: '#/definitions/ExpressRouteConnectionList' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Expressroutegateways Expressroutegatewayname Expressrouteconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName} : put: operationId: microsoftAzureNetworkvirtualapplianceconnectionsCreateorupdate x-ms-examples: NetworkVirtualApplianceConnectionPut: $ref: ./examples/NetworkVirtualApplianceConnectionPut.json description: >- Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection' parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string pattern: ^[A-Za-z0-9_]+ description: The name of the Network Virtual Appliance. - name: connectionName in: path required: true type: string pattern: ^[A-Za-z0-9_]+ description: The name of the NVA connection. - $ref: ./network.json#/parameters/ApiVersionParameter - name: NetworkVirtualApplianceConnectionParameters in: body required: true schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' description: >- Parameters supplied in an NetworkVirtualApplianceConnection PUT operation. responses: '200': description: >- Update successful. Returns the details of the NVA connection created or updated. schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' '201': description: >- Create successful. Returns the details of the NVA connection created or updated. schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections Connectionname tags: - Subscriptions get: operationId: microsoftAzureNetworkvirtualapplianceconnectionsGet x-ms-examples: NetworkVirtualApplianceConnectionGet: $ref: ./examples/NetworkVirtualApplianceConnectionGet.json description: Retrieves the details of specified NVA connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string description: The name of the Network Virtual Appliance. - name: connectionName in: path required: true type: string description: The name of the NVA connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the NVA connection schema: $ref: '#/definitions/NetworkVirtualApplianceConnection' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureNetworkvirtualapplianceconnectionsDelete x-ms-examples: NetworkVirtualApplianceConnectionDelete: $ref: ./examples/NetworkVirtualApplianceConnectionDelete.json description: Deletes a NVA connection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string description: The name of the Network Virtual Appliance. - name: connectionName in: path required: true type: string description: The name of the NVA connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Delete successful.NVA Connection deleted. '202': description: Accepted, and the operation will continue asynchronously. headers: location: description: >- The URL of the resource used to check the status of the asynchronous operation. type: string '204': description: No NVA connections exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections : get: operationId: microsoftAzureNetworkvirtualapplianceconnectionsList x-ms-examples: NetworkVirtualApplianceConnectionList: $ref: ./examples/NetworkVirtualApplianceConnectionList.json description: Lists NetworkVirtualApplianceConnections under the NVA. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: networkVirtualApplianceName in: path required: true type: string pattern: ^[A-Za-z0-9_]+ description: The name of the Network Virtual Appliance. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Lists all the NVA connections under an NVA. schema: $ref: '#/definitions/NetworkVirtualApplianceConnectionList' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkvirtualappliances Networkvirtualappliancename Networkvirtualapplianceconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName} : get: operationId: microsoftAzureVirtualhubbgpconnectionGet x-ms-examples: VirtualHubVirtualHubRouteTableV2Get: $ref: ./examples/VirtualHubBgpConnectionGet.json description: Retrieves the details of a Virtual Hub Bgp Connection. 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 connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of the Bgp Connection retrieved. schema: $ref: '#/definitions/BgpConnection' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections Connectionname tags: - Subscriptions put: operationId: microsoftAzureVirtualhubbgpconnectionCreateorupdate x-ms-examples: VirtualHubRouteTableV2Put: $ref: ./examples/VirtualHubBgpConnectionPut.json description: >- Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection. 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 connection. - $ref: ./network.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/BgpConnection' description: Parameters of Bgp connection. responses: '200': description: >- Request successful. Returns the details of the BgpConnection created or updated. schema: $ref: '#/definitions/BgpConnection' '201': description: >- Request received successfully. Returns the details of the BgpConnection created or updated. schema: $ref: '#/definitions/BgpConnection' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections Connectionname tags: - Subscriptions delete: operationId: microsoftAzureVirtualhubbgpconnectionDelete x-ms-examples: VirtualHubRouteTableV2Delete: $ref: ./examples/VirtualHubBgpConnectionDelete.json description: Deletes a VirtualHubBgpConnection. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubBgpConnection. - 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 connection. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualHubBgpConnection deleted. '202': description: >- Request received successfully. VirtualHubBgpConnection deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualHubBgpConnection exist by the name provided. default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections Connectionname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections : get: operationId: microsoftAzureVirtualhubbgpconnectionsList x-ms-examples: VirtualHubRouteTableV2List: $ref: ./examples/VirtualHubBgpConnectionList.json description: Retrieves the details of all VirtualHubBgpConnections. 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 VirtualHubBgpConnections for the VirtualHub. schema: $ref: '#/definitions/ListVirtualHubBgpConnectionResults' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Bgpconnections tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/learnedRoutes : post: operationId: microsoftAzureVirtualhubbgpconnectionsListlearnedroutes description: Retrieves a list of routes the virtual hub bgp connection has learned. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the virtual hub. - name: connectionName in: path required: true type: string description: The name of the virtual hub bgp connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: List of advertised BGP routes. schema: $ref: '#/definitions/PeerRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: VirtualRouterPeerListLearnedRoutes: $ref: ./examples/VirtualRouterPeerListLearnedRoute.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Hubname Bgpconnections Connectionname Learnedroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/advertisedRoutes : post: operationId: microsoftAzureVirtualhubbgpconnectionsListadvertisedroutes description: >- Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the virtual hub. - name: connectionName in: path required: true type: string description: The name of the virtual hub bgp connection. - $ref: ./network.json#/parameters/ApiVersionParameter - $ref: ./network.json#/parameters/SubscriptionIdParameter responses: '200': description: List of learned BGP routes. schema: $ref: '#/definitions/PeerRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-examples: VirtualRouterPeerListAdvertisedRoutes: $ref: ./examples/VirtualRouterPeerListAdvertisedRoute.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Hubname Bgpconnections Connectionname Advertisedroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName} : get: operationId: microsoftAzureVirtualhubipconfigurationGet x-ms-examples: VirtualHubVirtualHubRouteTableV2Get: $ref: ./examples/VirtualHubIpConfigurationGet.json description: Retrieves the details of a Virtual Hub Ip configuration. 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: ipConfigName in: path required: true type: string description: The name of the ipconfig. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of the Bgp Connection retrieved. schema: $ref: '#/definitions/HubIpConfiguration' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations Ipconfigname tags: - Subscriptions put: operationId: microsoftAzureVirtualhubipconfigurationCreateorupdate x-ms-examples: VirtualHubIpConfigurationPut: $ref: ./examples/VirtualHubIpConfigurationPut.json description: >- Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration. 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: ipConfigName in: path required: true type: string description: The name of the ipconfig. - $ref: ./network.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/HubIpConfiguration' description: Hub Ip Configuration parameters. responses: '200': description: >- Request successful. Returns the details of the IpConfiguration created or updated. schema: $ref: '#/definitions/HubIpConfiguration' '201': description: >- Request received successfully. Returns the details of the IpConfiguration created or updated. schema: $ref: '#/definitions/HubIpConfiguration' default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations Ipconfigname tags: - Subscriptions delete: operationId: microsoftAzureVirtualhubipconfigurationDelete x-ms-examples: VirtualHubIpConfigurationDelete: $ref: ./examples/VirtualHubIpConfigurationDelete.json description: Deletes a VirtualHubIpConfiguration. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the VirtualHubBgpConnection. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: ipConfigName in: path required: true type: string description: The name of the ipconfig. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. VirtualHubIpConfiguration deleted. '202': description: >- Request received successfully. VirtualHubIpConfiguration deletion is in progress; follow the Location header to poll for final outcome. '204': description: No VirtualHubIpConfiguration exist by the name provided. default: description: Error. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations Ipconfigname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations : get: operationId: microsoftAzureVirtualhubipconfigurationList x-ms-examples: VirtualHubRouteTableV2List: $ref: ./examples/VirtualHubIpConfigurationList.json description: Retrieves the details of all VirtualHubIpConfigurations. 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 VirtualHubIpConfigurations for the VirtualHub. schema: $ref: '#/definitions/ListVirtualHubIpConfigurationResults' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Ipconfigurations tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName} : put: operationId: microsoftAzureHubroutetablesCreateorupdate x-ms-examples: RouteTablePut: $ref: ./examples/HubRouteTablePut.json description: >- Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable. 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: routeTableName in: path required: true type: string description: The name of the RouteTable. - $ref: ./network.json#/parameters/ApiVersionParameter - name: routeTableParameters in: body required: true schema: $ref: '#/definitions/HubRouteTable' description: Parameters supplied to create or update RouteTable. responses: '200': description: >- Request successful. Returns the details of the RouteTable created or updated. schema: $ref: '#/definitions/HubRouteTable' '201': description: >- Request received successfully. Returns the details of the RouteTable created or updated. schema: $ref: '#/definitions/HubRouteTable' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables Routetablename tags: - Subscriptions get: operationId: microsoftAzureHubroutetablesGet x-ms-examples: RouteTableGet: $ref: ./examples/HubRouteTableGet.json description: Retrieves the details of a RouteTable. 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: routeTableName in: path required: true type: string description: The name of the RouteTable. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. Returns the details of the RouteTable retrieved. schema: $ref: '#/definitions/HubRouteTable' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables Routetablename tags: - Subscriptions delete: operationId: microsoftAzureHubroutetablesDelete x-ms-examples: RouteTableDelete: $ref: ./examples/HubRouteTableDelete.json description: Deletes a RouteTable. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RouteTable. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routeTableName in: path required: true type: string description: The name of the RouteTable. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. RouteTable deleted. '202': description: >- Request received successfully. RouteTable deletion is in progress; follow the Location header to poll for final outcome. '204': description: No RouteTables exist by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables Routetablename tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables : get: operationId: microsoftAzureHubroutetablesList x-ms-examples: RouteTableList: $ref: ./examples/HubRouteTableList.json description: Retrieves the details of all RouteTables. 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 RouteTables for the VirtualHub. schema: $ref: '#/definitions/ListHubRouteTablesResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Hubroutetables tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/effectiveRoutes : post: operationId: microsoftAzureVirtualhubsGeteffectivevirtualhubroutes x-ms-examples: Effective Routes for the Virtual Hub: $ref: ./examples/EffectiveRoutesListForVirtualHub.json Effective Routes for a Route Table resource: $ref: ./examples/EffectiveRoutesListForRouteTable.json Effective Routes for a Connection resource: $ref: ./examples/EffectiveRoutesListForConnection.json description: >- Gets the effective routes configured for the Virtual Hub resource or the specified resource . 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: effectiveRoutesParameters in: body required: false schema: $ref: '#/definitions/EffectiveRoutesParameters' description: >- Parameters supplied to get the effective routes for a specific resource. responses: '200': description: >- Request successful. Returns the list of the effective routes or follow the location header for the effective routes list. schema: $ref: '#/definitions/VirtualHubEffectiveRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Effectiveroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/inboundRoutes : post: operationId: microsoftAzureVirtualhubsGetinboundroutes x-ms-examples: Inbound Routes for the Virtual Hub on a Particular Connection: $ref: ./examples/GetInboundRoutes.json description: >- Gets the inbound routes configured for the Virtual Hub on a particular connection. 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: getInboundRoutesParameters in: body required: true schema: $ref: '#/definitions/GetInboundRoutesParameters' description: >- Parameters supplied to get the inbound routes for a connection resource. responses: '200': description: >- Request successful. Returns the list of the effective route map routes or follow the location header for the inbound routes list. schema: $ref: '#/definitions/EffectiveRouteMapRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Inboundroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes : post: operationId: microsoftAzureVirtualhubsGetoutboundroutes x-ms-examples: Outbound Routes for the Virtual Hub on a Particular Connection: $ref: ./examples/GetOutboundRoutes.json description: >- Gets the outbound routes configured for the Virtual Hub on a particular connection. 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: getOutboundRoutesParameters in: body required: true schema: $ref: '#/definitions/GetOutboundRoutesParameters' description: >- Parameters supplied to get the outbound routes for a connection resource. responses: '200': description: >- Request successful. Returns the list of the effective route map routes or follow the location header for the outbound routes list. schema: $ref: '#/definitions/EffectiveRouteMapRouteList' '202': description: Accepted and the operation will complete asynchronously. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Outboundroutes tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName} : put: operationId: microsoftAzureRoutingintentCreateorupdate x-ms-examples: RouteTablePut: $ref: ./examples/RoutingIntentPut.json description: >- Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RoutingIntent. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routingIntentName in: path required: true type: string description: The name of the per VirtualHub singleton Routing Intent resource. - $ref: ./network.json#/parameters/ApiVersionParameter - name: routingIntentParameters in: body required: true schema: $ref: '#/definitions/RoutingIntent' description: Parameters supplied to create or update RoutingIntent. responses: '200': description: >- Request successful. Returns the details of the RoutingIntent created or updated. schema: $ref: '#/definitions/RoutingIntent' '201': description: >- Request received successfully. Returns the details of the RoutingIntent created or updated. schema: $ref: '#/definitions/RoutingIntent' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent Routingintentname tags: - Subscriptions get: operationId: microsoftAzureRoutingintentGet x-ms-examples: RouteTableGet: $ref: ./examples/RoutingIntentGet.json description: Retrieves the details of a RoutingIntent. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RoutingIntent. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routingIntentName in: path required: true type: string description: The name of the RoutingIntent. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: >- Request successful. Returns the details of the RoutingIntent retrieved. schema: $ref: '#/definitions/RoutingIntent' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent Routingintentname tags: - Subscriptions delete: operationId: microsoftAzureRoutingintentDelete x-ms-examples: RouteTableDelete: $ref: ./examples/RoutingIntentDelete.json description: Deletes a RoutingIntent. parameters: - $ref: ./network.json#/parameters/SubscriptionIdParameter - name: resourceGroupName in: path required: true type: string description: The resource group name of the RoutingIntent. - name: virtualHubName in: path required: true type: string description: The name of the VirtualHub. - name: routingIntentName in: path required: true type: string description: The name of the RoutingIntent. - $ref: ./network.json#/parameters/ApiVersionParameter responses: '200': description: Request successful. RoutingIntent deleted. '202': description: >- Request received successfully. RoutingIntent deletion is in progress; follow the Location header to poll for final outcome. '204': description: No RoutingIntent exists by the name provided. default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent Routingintentname tags: - Subscriptions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent : get: operationId: microsoftAzureRoutingintentList x-ms-examples: RoutingIntentList: $ref: ./examples/RoutingIntentList.json description: >- Retrieves the details of all RoutingIntent child resources of the 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 all the RoutingIntent resources for the VirtualHub. schema: $ref: '#/definitions/ListRoutingIntentResult' default: description: Error response describing why the operation failed. schema: $ref: ./network.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualhubs Virtualhubname Routingintent tags: - Subscriptions 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. 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' provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the virtual WAN resource. type: type: string description: The type of the VirtualWAN. 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: readOnly: true $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' o365Policy: readOnly: false description: Office365 Policy. $ref: '#/definitions/O365PolicyProperties' 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. fqdn: type: string description: FQDN of vpn-site-link. bgpProperties: $ref: '#/definitions/VpnLinkBgpSettings' description: The set of bgp properties. provisioningState: readOnly: true $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. azureFirewall: $ref: ./network.json#/definitions/SubResource description: The azureFirewall associated with this VirtualHub. securityPartnerProvider: $ref: ./network.json#/definitions/SubResource description: The securityPartnerProvider associated with this VirtualHub. addressPrefix: type: string description: Address-prefix for this VirtualHub. routeTable: $ref: '#/definitions/VirtualHubRouteTable' description: The routeTable associated with this virtual hub. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the virtual hub resource. securityProviderName: type: string description: The Security Provider name. virtualHubRouteTableV2s: type: array description: >- List of all virtual hub route table v2s associated with this VirtualHub. items: $ref: '#/definitions/VirtualHubRouteTableV2' sku: type: string description: The sku of this VirtualHub. routingState: $ref: '#/definitions/RoutingState' description: The routing state. bgpConnections: type: array readOnly: true description: List of references to Bgp Connections. items: $ref: ./network.json#/definitions/SubResource ipConfigurations: type: array readOnly: true description: List of references to IpConfigurations. items: $ref: ./network.json#/definitions/SubResource routeMaps: type: array readOnly: true description: List of references to RouteMaps. items: $ref: ./network.json#/definitions/SubResource virtualRouterAsn: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: VirtualRouter ASN. virtualRouterIps: type: array readOnly: false description: VirtualRouter IPs. items: type: string allowBranchToBranchTraffic: type: boolean readOnly: false description: Flag to control transit for VirtualRouter hub. preferredRoutingGateway: $ref: '#/definitions/PreferredRoutingGateway' description: The preferred gateway to route on-prem traffic hubRoutingPreference: $ref: '#/definitions/HubRoutingPreference' description: The hubRoutingPreference of this VirtualHub. virtualRouterAutoScaleConfiguration: $ref: '#/definitions/VirtualRouterAutoScaleConfiguration' description: The VirtualHub Router autoscale configuration. description: Parameters for VirtualHub. VirtualRouterAutoScaleConfiguration: type: object properties: minCapacity: type: integer format: int32 minimum: 0 description: The minimum number of scale units for VirtualHub Router. description: The VirtualHub Router autoscale configuration. PreferredRoutingGateway: type: string description: The preferred routing gateway types enum: - ExpressRoute - VpnGateway - None x-ms-enum: name: PreferredRoutingGateway modelAsString: true HubRoutingPreference: type: string description: The hub routing preference gateway types enum: - ExpressRoute - VpnGateway - ASPath x-ms-enum: name: HubRoutingPreference modelAsString: true RoutingState: type: string description: The current routing state of the VirtualHub. readOnly: true enum: - None - Provisioned - Provisioning - Failed x-ms-enum: name: RoutingState modelAsString: true BgpConnection: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/BgpConnectionProperties' description: The properties of the Bgp connections. name: type: string description: Name of the connection. etag: type: string readOnly: true description: >- A unique read-only string that changes whenever the resource is updated. type: type: string readOnly: true description: Connection type. allOf: - $ref: ./network.json#/definitions/SubResource description: Virtual Appliance Site resource. BgpConnectionProperties: properties: peerAsn: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: Peer ASN. peerIp: type: string readOnly: false description: Peer IP. hubVirtualNetworkConnection: description: The reference to the HubVirtualNetworkConnection resource. readOnly: false $ref: ./network.json#/definitions/SubResource provisioningState: description: The provisioning state of the resource. readOnly: true $ref: ./network.json#/definitions/ProvisioningState connectionState: type: string description: The current state of the VirtualHub to Peer. readOnly: true enum: - Unknown - Connecting - Connected - NotConnected x-ms-enum: name: HubBgpConnectionStatus modelAsString: true description: Properties of the bgp connection. PeerRoute: properties: localAddress: type: string readOnly: true description: The peer's local address. network: type: string readOnly: true description: The route's network prefix. nextHop: type: string readOnly: true description: The route's next hop. sourcePeer: type: string readOnly: true description: The peer this route was learned from. origin: type: string readOnly: true description: The source this route was learned from. asPath: type: string readOnly: true description: The route's AS path sequence. weight: type: integer format: int32 readOnly: true description: The route's weight. description: Peer routing details. PeerRouteList: type: object additionalProperties: type: array items: $ref: '#/definitions/PeerRoute' x-ms-identifiers: [] description: List of peer routes. description: Map from virtual router instance to list of peer routes. HubIpConfiguration: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/HubIPConfigurationPropertiesFormat' description: The properties of the Virtual Hub IPConfigurations. name: type: string description: Name of the Ip Configuration. etag: type: string readOnly: true description: >- A unique read-only string that changes whenever the resource is updated. type: type: string readOnly: true description: Ipconfiguration type. allOf: - $ref: ./network.json#/definitions/SubResource description: IpConfigurations. HubIPConfigurationPropertiesFormat: properties: privateIPAddress: type: string description: The private IP address of the IP configuration. privateIPAllocationMethod: $ref: ./network.json#/definitions/IPAllocationMethod description: The private IP address allocation method. subnet: $ref: ./virtualNetwork.json#/definitions/Subnet description: The reference to the subnet resource. publicIPAddress: $ref: ./publicIpAddress.json#/definitions/PublicIPAddress description: The reference to the public IP resource. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the IP configuration resource. description: Properties of IP configuration. 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. kind: readOnly: true type: string description: >- Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server. 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: readOnly: true $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. ipConfigurations: type: array readOnly: true description: List of all IPs configured on the gateway. items: $ref: '#/definitions/VpnGatewayIpConfiguration' enableBgpRouteTranslationForNat: type: boolean description: Enable BGP routes translation for NAT on this VpnGateway. isRoutingPreferenceInternet: type: boolean description: >- Enable Routing Preference property for the Public IP Interface of the VpnGateway. natRules: type: array description: List of all the nat Rules associated with the gateway. items: $ref: '#/definitions/VpnGatewayNatRule' 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. VpnGatewayIpConfiguration: description: IP Configuration of a VPN Gateway Resource. properties: id: type: string description: The identifier of the IP configuration for a VPN Gateway. publicIpAddress: type: string description: The public IP address of this IP configuration. privateIpAddress: type: string description: The private IP address of this IP configuration. 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. VpnNatRuleMapping: properties: addressSpace: type: string description: Address space for Vpn NatRule mapping. portRange: type: string description: Port range for Vpn NatRule mapping. description: Vpn NatRule mapping. VpnGatewayNatRuleProperties: properties: provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the NAT Rule resource. type: type: string description: The type of NAT rule for VPN NAT. enum: - Static - Dynamic x-ms-enum: name: VpnNatRuleType modelAsString: true mode: type: string description: The Source NAT direction of a VPN NAT. enum: - EgressSnat - IngressSnat x-ms-enum: name: VpnNatRuleMode modelAsString: true internalMappings: type: array items: $ref: '#/definitions/VpnNatRuleMapping' description: The private IP address internal mapping for NAT. externalMappings: type: array items: $ref: '#/definitions/VpnNatRuleMapping' description: The private IP address external mapping for NAT. ipConfigurationId: type: string description: The IP Configuration ID this NAT rule applies to. egressVpnSiteLinkConnections: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of egress VpnSiteLinkConnections. ingressVpnSiteLinkConnections: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of ingress VpnSiteLinkConnections. description: Parameters for VpnGatewayNatRule. VpnGatewayNatRule: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnGatewayNatRuleProperties' description: Properties of the VpnGateway NAT rule. name: type: string description: >- The name of the resource that is unique within a resource group. This name can be used to access the resource. etag: 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: VpnGatewayNatRule Resource. ListVpnGatewayNatRulesResult: description: >- Result of the request to list all nat rules to a virtual wan vpn gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnGatewayNatRule' description: List of Nat Rules. 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. dpdTimeoutSeconds: type: integer format: int32 description: DPD timeout in seconds 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. trafficSelectorPolicies: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/TrafficSelectorPolicy description: The Traffic Selector 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: readOnly: true $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' routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: >- The Routing Configuration indicating the associated and propagated route tables on this connection. 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. VpnConnectionPacketCaptureStartParameters: description: >- Vpn Connection packet capture parameters supplied to start packet capture on gateway connection. properties: filterData: type: string description: Start Packet capture parameters on vpn connection. linkConnectionNames: type: array description: List of site link connection names. items: type: string VpnConnectionPacketCaptureStopParameters: description: >- Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection. properties: sasUrl: type: string description: SAS url for packet capture on vpn connection. linkConnectionNames: type: array description: List of site link connection names. items: type: string VpnGatewayPacketCaptureStartParameters: properties: filterData: type: string description: Start Packet capture parameters on vpn gateway. description: Start packet capture parameters. VpnGatewayPacketCaptureStopParameters: properties: sasUrl: type: string description: SAS url for packet capture on vpn gateway. description: Stop packet capture parameters. 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. vpnLinkConnectionMode: type: string description: Vpn link connection mode. enum: - Default - ResponderOnly - InitiatorOnly x-ms-enum: name: VpnLinkConnectionMode modelAsString: true 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. vpnGatewayCustomBgpAddresses: type: array items: $ref: >- ./virtualNetworkGateway.json#/definitions/GatewayCustomBgpIpAddressIpConfiguration description: vpnGatewayCustomBgpAddresses used by this connection. x-ms-identifiers: [] 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: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the VPN site link connection resource. ingressNatRules: type: array items: $ref: ./network.json#/definitions/SubResource description: List of ingress NatRules. egressNatRules: type: array items: $ref: ./network.json#/definitions/SubResource description: List of egress NatRules. dpdTimeoutSeconds: type: integer format: int32 description: Dead Peer Detection timeout in seconds for VpnLink connection. 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: 'Deprecated: VirtualHub to RemoteVnet transit to enabled or not.' allowRemoteVnetToUseHubVnetGateways: type: boolean description: 'Deprecated: Allow RemoteVnet to use Virtual Hub''s gateways.' enableInternetSecurity: type: boolean description: Enable internet security. routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: >- The Routing Configuration indicating the associated and propagated route tables on this connection. provisioningState: readOnly: true $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. HubRouteTableProperties: properties: routes: type: array description: List of all routes. items: $ref: '#/definitions/HubRoute' labels: type: array description: List of labels associated with this route table. items: type: string associatedConnections: type: array description: List of all connections associated with this route table. readOnly: true items: type: string propagatingConnections: type: array description: List of all connections that advertise to this route table. readOnly: true items: type: string provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the RouteTable resource. description: Parameters for RouteTable. HubRouteTable: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/HubRouteTableProperties' description: Properties of the RouteTable resource. 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: RouteTable resource in a virtual hub. HubRoute: required: - name - destinationType - destinations - nextHopType - nextHop properties: name: type: string description: >- The name of the Route that is unique within a RouteTable. This name can be used to access this route. destinationType: type: string description: 'The type of destinations (eg: CIDR, ResourceId, Service).' destinations: type: array description: List of all destinations. items: type: string nextHopType: type: string description: 'The type of next hop (eg: ResourceId).' nextHop: type: string description: NextHop resource ID. description: RouteTable route. ListHubRouteTablesResult: description: List of RouteTables and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/HubRouteTable' description: List of RouteTables. 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 VpnServerConfigVpnClientRootCertificate: properties: name: type: string description: The certificate name. publicCertData: type: string description: The certificate public data. description: Properties of VPN client root certificate of VpnServerConfiguration. VpnServerConfigRadiusServerRootCertificate: properties: name: type: string description: The certificate name. publicCertData: type: string description: The certificate public data. description: Properties of Radius Server root certificate of VpnServerConfiguration. VpnServerConfigVpnClientRevokedCertificate: properties: name: type: string description: The certificate name. thumbprint: type: string description: The revoked VPN client certificate thumbprint. description: >- Properties of the revoked VPN client certificate of VpnServerConfiguration. VpnServerConfigRadiusClientRootCertificate: properties: name: type: string description: The certificate name. thumbprint: type: string description: The Radius client root certificate thumbprint. description: >- Properties of the Radius client root certificate of VpnServerConfiguration. AadAuthenticationParameters: properties: aadTenant: type: string description: AAD Vpn authentication parameter AAD tenant. aadAudience: type: string description: AAD Vpn authentication parameter AAD audience. aadIssuer: type: string description: AAD Vpn authentication parameter AAD issuer. description: AAD Vpn authentication type related parameters. VpnServerConfigurationProperties: properties: name: type: string description: >- The name of the VpnServerConfiguration that is unique within a resource group. vpnProtocols: type: array items: type: string description: VPN protocol enabled for the VpnServerConfiguration. enum: - IkeV2 - OpenVPN x-ms-enum: name: VpnGatewayTunnelingProtocol modelAsString: true description: VPN protocols for the VpnServerConfiguration. vpnAuthenticationTypes: type: array items: type: string description: VPN authentication types enabled for the VpnServerConfiguration. enum: - Certificate - Radius - AAD x-ms-enum: name: VpnAuthenticationType modelAsString: true description: VPN authentication types for the VpnServerConfiguration. vpnClientRootCertificates: type: array items: $ref: '#/definitions/VpnServerConfigVpnClientRootCertificate' description: VPN client root certificate of VpnServerConfiguration. vpnClientRevokedCertificates: type: array items: $ref: '#/definitions/VpnServerConfigVpnClientRevokedCertificate' description: VPN client revoked certificate of VpnServerConfiguration. radiusServerRootCertificates: type: array items: $ref: '#/definitions/VpnServerConfigRadiusServerRootCertificate' description: Radius Server root certificate of VpnServerConfiguration. radiusClientRootCertificates: type: array items: $ref: '#/definitions/VpnServerConfigRadiusClientRootCertificate' description: Radius client root certificate of VpnServerConfiguration. vpnClientIpsecPolicies: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/IpsecPolicy description: VpnClientIpsecPolicies for VpnServerConfiguration. radiusServerAddress: type: string description: >- The radius server address property of the VpnServerConfiguration resource for point to site client connection. radiusServerSecret: type: string description: >- The radius secret property of the VpnServerConfiguration resource for point to site client connection. radiusServers: type: array items: $ref: ./virtualNetworkGateway.json#/definitions/RadiusServer description: Multiple Radius Server configuration for VpnServerConfiguration. aadAuthenticationParameters: $ref: '#/definitions/AadAuthenticationParameters' description: The set of aad vpn authentication parameters. provisioningState: readOnly: true type: string description: >- The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. p2SVpnGateways: type: array readOnly: true items: $ref: '#/definitions/P2SVpnGateway' description: List of references to P2SVpnGateways. configurationPolicyGroups: type: array description: List of all VpnServerConfigurationPolicyGroups. items: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' etag: readOnly: true type: string description: >- A unique read-only string that changes whenever the resource is updated. description: Parameters for VpnServerConfiguration. VpnServerConfiguration: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnServerConfigurationProperties' 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/Resource description: VpnServerConfiguration Resource. ListVpnServerConfigurationsResult: description: >- Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnServerConfiguration' description: List of VpnServerConfigurations. 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. VpnServerConfigurationPolicyGroupProperties: type: object properties: isDefault: type: boolean description: Shows if this is a Default VpnServerConfigurationPolicyGroup or not. priority: type: integer format: int32 description: Priority for VpnServerConfigurationPolicyGroup. policyMembers: type: array items: $ref: '#/definitions/VpnServerConfigurationPolicyGroupMember' description: Multiple PolicyMembers for VpnServerConfigurationPolicyGroup. x-ms-identifiers: [] p2SConnectionConfigurations: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: List of references to P2SConnectionConfigurations. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: >- The provisioning state of the VpnServerConfigurationPolicyGroup resource. description: Parameters for VpnServerConfigurationPolicyGroup. VpnServerConfigurationPolicyGroup: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VpnServerConfigurationPolicyGroupProperties' description: Properties of the VpnServerConfigurationPolicyGroup. 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: VpnServerConfigurationPolicyGroup Resource. VpnServerConfigurationPolicyGroupMember: properties: name: type: string description: Name of the VpnServerConfigurationPolicyGroupMember. attributeType: type: string description: The Vpn Policy member attribute type. enum: - CertificateGroupId - AADGroupId - RadiusAzureGroupId x-ms-enum: name: VpnPolicyMemberAttributeType modelAsString: true attributeValue: type: string description: >- The value of Attribute used for this VpnServerConfigurationPolicyGroupMember. description: VpnServerConfiguration PolicyGroup member type: object ListVpnServerConfigurationPolicyGroupsResult: type: object description: >- Result of the request to list VpnServerConfigurationPolicyGroups. It contains a list of VpnServerConfigurationPolicyGroups and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' description: List of VpnServerConfigurationPolicyGroups. nextLink: type: string description: URL to get the next set of operation list results if there are any. P2SVpnGatewayProperties: properties: virtualHub: $ref: ./network.json#/definitions/SubResource description: The VirtualHub to which the gateway belongs. p2SConnectionConfigurations: type: array description: List of all p2s connection configurations of the gateway. items: $ref: '#/definitions/P2SConnectionConfiguration' provisioningState: readOnly: true $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. vpnServerConfiguration: $ref: ./network.json#/definitions/SubResource description: The VpnServerConfiguration to which the p2sVpnGateway is attached to. vpnClientConnectionHealth: readOnly: true $ref: '#/definitions/VpnClientConnectionHealth' description: All P2S VPN clients' connection health status. customDnsServers: type: array description: List of all customer specified DNS servers IP addresses. items: type: string isRoutingPreferenceInternet: type: boolean description: >- Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. 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. VpnServerConfigurationsResponse: properties: vpnServerConfigurationResourceIds: type: array items: type: string description: VpnServerConfiguration partial resource uri. description: List of VpnServerConfigurations associated with VirtualWan. description: VpnServerConfigurations list associated with VirtualWan Response. VirtualWanVpnProfileParameters: properties: vpnServerConfigurationResourceId: type: string description: >- VpnServerConfiguration partial resource uri with which VirtualWan is associated to. authenticationMethod: $ref: ./network.json#/definitions/AuthenticationMethod description: VPN client authentication method. description: Virtual Wan Vpn profile parameters Vpn profile generation. P2SVpnConnectionHealthRequest: properties: vpnUserNamesFilter: type: array items: type: string description: P2S vpn user name. description: >- The list of p2s vpn user names whose p2s vpn connection detailed health to retrieve for. outputBlobSasUrl: type: string description: The sas-url to download the P2S Vpn connection health detail. description: List of P2S Vpn connection health request. P2SVpnConnectionHealth: properties: sasUrl: type: string description: >- Returned sas url of the blob to which the p2s vpn connection detailed health will be written. description: P2S Vpn connection detailed health written to sas url. P2SConnectionConfigurationProperties: properties: vpnClientAddressPool: $ref: ./virtualNetwork.json#/definitions/AddressSpace description: >- The reference to the address space resource which represents Address space for P2S VpnClient. routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: >- The Routing Configuration indicating the associated and propagated route tables on this connection. enableInternetSecurity: type: boolean description: >- Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. configurationPolicyGroupAssociations: type: array readOnly: true items: $ref: ./network.json#/definitions/SubResource description: >- List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to. previousConfigurationPolicyGroupAssociations: type: array readOnly: true items: $ref: '#/definitions/VpnServerConfigurationPolicyGroup' description: >- List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the P2SConnectionConfiguration resource. description: Parameters for P2SConnectionConfiguration. P2SConnectionConfiguration: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/P2SConnectionConfigurationProperties' description: Properties of the P2S connection 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: P2SConnectionConfiguration Resource. VirtualHubRouteTableV2Properties: properties: routes: type: array description: List of all routes. items: $ref: '#/definitions/VirtualHubRouteV2' attachedConnections: type: array description: List of all connections attached to this route table v2. items: type: string provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the virtual hub route table v2 resource. description: Parameters for VirtualHubRouteTableV2. VirtualHubRouteTableV2: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/VirtualHubRouteTableV2Properties' description: Properties of the virtual hub route table v2. 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: VirtualHubRouteTableV2 Resource. VirtualHubRouteV2: properties: destinationType: type: string description: The type of destinations. destinations: type: array description: List of all destinations. items: type: string nextHopType: type: string description: The type of next hops. nextHops: type: array description: NextHops ip address. items: type: string description: VirtualHubRouteTableV2 route. ListVirtualHubRouteTableV2sResult: description: >- List of VirtualHubRouteTableV2s and a URL nextLink to get the next set of results. properties: value: type: array items: $ref: '#/definitions/VirtualHubRouteTableV2' description: List of VirtualHubRouteTableV2s. nextLink: type: string description: URL to get the next set of operation list results if there are any. P2SVpnConnectionRequest: description: List of p2s vpn connections to be disconnected. properties: vpnConnectionIds: type: array items: type: string description: List of p2s vpn connection Ids. VirtualHubId: properties: id: type: string description: >- The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. description: Virtual Hub identifier. ExpressRouteCircuitPeeringId: properties: id: type: string description: The ID of the ExpressRoute circuit peering. description: ExpressRoute circuit peering identifier. ExpressRouteConnectionId: properties: id: type: string readOnly: true description: The ID of the ExpressRouteConnection. description: The ID of the ExpressRouteConnection. ExpressRouteGatewayProperties: required: - virtualHub properties: autoScaleConfiguration: properties: bounds: properties: min: type: integer description: >- Minimum number of scale units deployed for ExpressRoute gateway. max: type: integer description: >- Maximum number of scale units deployed for ExpressRoute gateway. description: Minimum and maximum number of scale units to deploy. description: Configuration for auto scaling. expressRouteConnections: type: array description: List of ExpressRoute connections to the ExpressRoute gateway. items: $ref: '#/definitions/ExpressRouteConnection' provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the express route gateway resource. virtualHub: $ref: '#/definitions/VirtualHubId' description: The Virtual Hub where the ExpressRoute gateway is or will be deployed. allowNonVirtualWanTraffic: type: boolean description: >- Configures this gateway to accept traffic from non Virtual WAN networks. description: ExpressRoute gateway resource properties. ExpressRouteGateway: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ExpressRouteGatewayProperties' description: Properties of the express route 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: ExpressRoute gateway resource. ExpressRouteGatewayList: properties: value: type: array items: $ref: '#/definitions/ExpressRouteGateway' description: List of ExpressRoute gateways. description: List of ExpressRoute gateways. ExpressRouteConnectionProperties: required: - expressRouteCircuitPeering properties: provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: The provisioning state of the express route connection resource. expressRouteCircuitPeering: $ref: '#/definitions/ExpressRouteCircuitPeeringId' description: The ExpressRoute circuit peering. authorizationKey: type: string description: Authorization key to establish the connection. routingWeight: type: integer description: The routing weight associated to the connection. enableInternetSecurity: type: boolean description: Enable internet security. expressRouteGatewayBypass: type: boolean description: Enable FastPath to vWan Firewall hub. enablePrivateLinkFastPath: type: boolean description: >- Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled. routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: >- The Routing Configuration indicating the associated and propagated route tables on this connection. description: Properties of the ExpressRouteConnection subresource. ExpressRouteConnection: required: - name properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ExpressRouteConnectionProperties' description: Properties of the express route connection. name: type: string description: The name of the resource. allOf: - $ref: ./network.json#/definitions/SubResource description: ExpressRouteConnection resource. ExpressRouteConnectionList: properties: value: type: array items: $ref: '#/definitions/ExpressRouteConnection' description: The list of ExpressRoute connections. description: ExpressRouteConnection list. NetworkVirtualApplianceConnectionProperties: type: object properties: name: type: string description: The name of the resource. provisioningState: readOnly: true $ref: ./network.json#/definitions/ProvisioningState description: >- The provisioning state of the NetworkVirtualApplianceConnection resource. asn: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: Network Virtual Appliance ASN. tunnelIdentifier: type: integer readOnly: false format: int64 minimum: 0 maximum: 4294967295 description: Unique identifier for the connection. bgpPeerAddress: type: array items: type: string description: List of bgpPeerAddresses for the NVA instances enableInternetSecurity: type: boolean description: Enable internet security. routingConfiguration: $ref: '#/definitions/RoutingConfiguration' description: >- The Routing Configuration indicating the associated and propagated route tables on this connection. description: Properties of the NetworkVirtualApplianceConnection subresource. NetworkVirtualApplianceConnection: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/NetworkVirtualApplianceConnectionProperties' description: Properties of the express route connection. name: type: string description: The name of the resource. allOf: - $ref: ./network.json#/definitions/SubResource description: NetworkVirtualApplianceConnection resource. NetworkVirtualApplianceConnectionList: type: object properties: value: type: array items: $ref: '#/definitions/NetworkVirtualApplianceConnection' description: The list of NetworkVirtualAppliance connections. nextLink: type: string description: URL to get the next set of results. description: NetworkVirtualApplianceConnection list. ListVirtualHubBgpConnectionResults: properties: value: type: array items: $ref: '#/definitions/BgpConnection' description: The list of VirtualHubBgpConnections. nextLink: type: string description: URL to get the next set of results. description: VirtualHubBgpConnections list. ListVirtualHubIpConfigurationResults: properties: value: type: array items: $ref: '#/definitions/HubIpConfiguration' description: The list of VirtualHubIpConfigurations. nextLink: type: string description: URL to get the next set of results. description: VirtualHubIpConfigurations list. RoutingConfiguration: description: >- Routing Configuration indicating the associated and propagated route tables for this connection. properties: associatedRouteTable: $ref: ./network.json#/definitions/SubResource description: The resource id RouteTable associated with this RoutingConfiguration. propagatedRouteTables: $ref: '#/definitions/PropagatedRouteTable' description: The list of RouteTables to advertise the routes to. vnetRoutes: $ref: '#/definitions/VnetRoute' description: >- List of routes that control routing from VirtualHub into a virtual network connection. inboundRouteMap: $ref: ./network.json#/definitions/SubResource description: >- The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. outboundRouteMap: $ref: ./network.json#/definitions/SubResource description: >- The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. PropagatedRouteTable: description: The list of RouteTables to advertise the routes to. properties: labels: type: array description: The list of labels. items: type: string ids: type: array description: The list of resource ids of all the RouteTables. items: $ref: ./network.json#/definitions/SubResource VnetRoute: description: >- List of routes that control routing from VirtualHub into a virtual network connection. properties: staticRoutesConfig: $ref: '#/definitions/StaticRoutesConfig' description: Configuration for static routes on this HubVnetConnection. staticRoutes: type: array description: List of all Static Routes. items: $ref: '#/definitions/StaticRoute' bgpConnections: type: array readOnly: true description: The list of references to HubBgpConnection objects. items: $ref: ./network.json#/definitions/SubResource StaticRoutesConfig: description: >- Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. type: object properties: propagateStaticRoutes: description: >- Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. type: boolean readOnly: true vnetLocalRouteOverrideCriteria: description: >- Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. $ref: '#/definitions/VnetLocalRouteOverrideCriteria' StaticRoute: description: List of all Static Routes. properties: name: type: string description: The name of the StaticRoute that is unique within a VnetRoute. addressPrefixes: type: array description: List of all address prefixes. items: type: string nextHopIpAddress: type: string description: The ip address of the next hop. VirtualHubEffectiveRouteList: description: EffectiveRoutes List. properties: value: type: array items: $ref: '#/definitions/VirtualHubEffectiveRoute' description: >- The list of effective routes configured on the virtual hub or the specified resource. VirtualHubEffectiveRoute: description: The effective route configured on the virtual hub or specified resource. properties: addressPrefixes: description: The list of address prefixes. type: array items: type: string nextHops: description: The list of next hops. type: array items: type: string nextHopType: description: The type of the next hop. type: string asPath: description: The ASPath of this route. type: string routeOrigin: description: The origin of this route. type: string EffectiveRoutesParameters: description: >- The parameters specifying the resource whose effective routes are being requested. properties: resourceId: type: string description: The resource whose effective routes are being requested. virtualWanResourceType: type: string description: >- The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection. EffectiveRouteMapRouteList: description: EffectiveRouteMapRoute List. type: object properties: value: type: array items: $ref: '#/definitions/EffectiveRouteMapRoute' description: >- The list of Effective RouteMap Routes configured on the connection resource. x-ms-identifiers: [] EffectiveRouteMapRoute: description: The effective RouteMap route configured on the connection resource. type: object properties: prefix: description: The address prefix of the route. type: string bgpCommunities: description: BGP communities of the route. type: string asPath: description: The ASPath of this route. type: string GetInboundRoutesParameters: description: >- The parameters specifying the connection resource whose inbound routes are being requested. type: object properties: resourceUri: type: string description: The connection resource whose inbound routes are being requested. connectionType: type: string description: >- The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection. GetOutboundRoutesParameters: description: >- The parameters specifying the connection resource whose outbound routes are being requested. type: object properties: resourceUri: type: string description: The connection resource whose outbound routes are being requested. connectionType: type: string description: >- The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection. O365PolicyProperties: properties: breakOutCategories: readOnly: false description: Office365 breakout categories. $ref: '#/definitions/O365BreakOutCategoryPolicies' description: The Office365 breakout policy. O365BreakOutCategoryPolicies: properties: allow: type: boolean readOnly: false description: Flag to control allow category. optimize: type: boolean readOnly: false description: Flag to control optimize category. default: type: boolean readOnly: false description: Flag to control default category. description: Office365 breakout categories. ListRoutingIntentResult: description: >- List of the routing intent result and a URL nextLink to get the next set of results. type: object properties: value: type: array items: $ref: '#/definitions/RoutingIntent' description: List of RoutingIntent resource. nextLink: type: string description: URL to get the next set of operation list results if there are any. RoutingIntent: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RoutingIntentProperties' description: Properties of the RoutingIntent resource. 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: The routing intent child resource of a Virtual hub. type: object RoutingIntentProperties: properties: routingPolicies: type: array description: List of routing policies. readOnly: false items: $ref: '#/definitions/RoutingPolicy' provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the RoutingIntent resource. description: The properties of a RoutingIntent resource. type: object RoutingPolicy: required: - name - destinations - nextHop properties: name: type: string description: The unique name for the routing policy. destinations: type: array description: >- List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). items: type: string nextHop: type: string description: >- The next hop resource id on which this routing policy is applicable to. description: The routing policy object used in a RoutingIntent resource. type: object RouteMap: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RouteMapProperties' description: Properties of the RouteMap resource. name: type: string readOnly: true 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. id: readOnly: true type: string description: Resource id. allOf: - $ref: ./network.json#/definitions/SubResource description: The RouteMap child resource of a Virtual hub. type: object ListRouteMapsResult: description: List of RouteMaps and a URL nextLink to get the next set of results. type: object properties: value: type: array items: $ref: '#/definitions/RouteMap' description: List of RouteMaps. nextLink: type: string description: URL to get the next set of operation list results if there are any. RouteMapProperties: properties: associatedInboundConnections: type: array description: >- List of connections which have this RoutMap associated for inbound traffic. items: type: string associatedOutboundConnections: type: array description: >- List of connections which have this RoutMap associated for outbound traffic. items: type: string rules: type: array description: List of RouteMap rules to be applied. items: $ref: '#/definitions/RouteMapRule' x-ms-identifiers: [] provisioningState: $ref: ./network.json#/definitions/ProvisioningState readOnly: true description: The provisioning state of the RouteMap resource. description: Properties of RouteMap resource type: object RouteMapRule: properties: name: type: string description: The unique name for the rule. matchCriteria: type: array description: List of matching criterion which will be applied to traffic. items: $ref: '#/definitions/Criterion' x-ms-identifiers: [] actions: type: array description: List of actions which will be applied on a match. items: $ref: '#/definitions/Action' x-ms-identifiers: [] nextStepIfMatched: $ref: '#/definitions/NextStep' description: >- Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'. description: A RouteMap Rule. type: object Criterion: properties: routePrefix: type: array description: List of route prefixes which this criteria matches. items: type: string community: type: array description: List of BGP communities which this criteria matches. items: type: string asPath: type: array description: List of AS paths which this criteria matches. items: type: string matchCondition: $ref: '#/definitions/RouteMapMatchCondition' description: Match condition to apply RouteMap rules. description: >- A matching criteria which matches routes based on route prefix, community, and AS path. type: object Action: properties: type: $ref: '#/definitions/RouteMapActionType' description: >- Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.' parameters: type: array description: >- List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added items: $ref: '#/definitions/Parameter' x-ms-identifiers: [] description: Action to be taken on a route matching a RouteMap criterion. type: object Parameter: properties: routePrefix: type: array description: List of route prefixes. items: type: string community: type: array description: List of BGP communities. items: type: string asPath: type: array description: List of AS paths. items: type: string description: Parameters for an Action. type: object RouteMapMatchCondition: type: string description: Match condition to apply RouteMap rules. enum: - Unknown - Contains - Equals - NotContains - NotEquals x-ms-enum: name: RouteMapMatchCondition modelAsString: true NextStep: type: string description: Supported next step behaviors after a rule is applied to a matched route enum: - Unknown - Continue - Terminate x-ms-enum: name: NextStep modelAsString: true RouteMapActionType: type: string description: >- Kind of actions which can be taken on a matched route. Add, Replace, Remove refer to parameters on the route, like community or prefix enum: - Unknown - Remove - Add - Replace - Drop x-ms-enum: name: RouteMapActionType modelAsString: true VnetLocalRouteOverrideCriteria: type: string description: >- Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet. enum: - Contains - Equal x-ms-enum: name: VnetLocalRouteOverrideCriteria modelAsString: true tags: - name: ExpressRouteConnections - name: ExpressRouteGateways - name: P2SVpnGateways - name: Subscriptions - name: VirtualWANs - name: VpnGateways - name: vpnLinkConnections - name: VpnServerConfigurations - name: VpnSites