Microsoft Azure VirtualWANAsAServiceManagementClient is a service management client that provides a centralized platform for managing virtual wide area networks (WANs) hosted on the Azure cloud computing platform. This service allows users to easily create, configure, and manage virtual WANs to securely connect multiple branch offices, data centers, and cloud environments.
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
# --- truncated at 32 KB (276 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/virtualwanasaservicemanagementclient-openapi-original.yml