Vpn Sites Configuration - Download

Gives the sas-url to download the configurations for vpn-sites in a resource group.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration?api-version=2023-09-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The resource group name.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

virtualWANName
path True

string

The name of the VirtualWAN for which configuration of all vpn-sites is needed.

api-version
query True

string

Client API version.

Request Body

Name Required Type Description
outputBlobSasUrl True

string

The sas-url to download the configurations for vpn-sites.

vpnSites

string[]

List of resource-ids of the vpn-sites for which config is to be downloaded.

Responses

Name Type Description
200 OK

Request successful. Follow the location header for sas-url to output blob.

202 Accepted

Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

VpnSitesConfigurationDownload

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/wan1/vpnConfiguration?api-version=2023-09-01

{
  "vpnSites": [
    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc"
  ],
  "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b"
}

Sample Response

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

GetVpnSitesConfigurationRequest

List of Vpn-Sites.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

GetVpnSitesConfigurationRequest

List of Vpn-Sites.

Name Type Description
outputBlobSasUrl

string

The sas-url to download the configurations for vpn-sites.

vpnSites

string[]

List of resource-ids of the vpn-sites for which config is to be downloaded.