Virtual Network Gateways - Generatevpnclientpackage
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage?api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
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. |
virtual
|
path | True |
string |
The name of the virtual network gateway. |
api-version
|
query | True |
string |
Client API version. |
Request Body
Name | Type | Description |
---|---|---|
authenticationMethod |
VPN client authentication method. |
|
clientRootCertificates |
string[] |
A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS. |
processorArchitecture |
VPN client Processor Architecture. |
|
radiusServerAuthCertificate |
string |
The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
string |
VPN client package URL. |
202 Accepted |
Accepted and the operation will complete asynchronously. |
|
Other Status Codes |
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
GenerateVPNClientPackage
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/generatevpnclientpackage?api-version=2023-09-01
{}
Sample Response
""
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-09-01
Definitions
Name | Description |
---|---|
Authentication |
VPN client authentication method. |
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Processor |
VPN client Processor Architecture. |
Vpn |
Vpn Client Parameters for package generation. |
AuthenticationMethod
VPN client authentication method.
Name | Type | Description |
---|---|---|
EAPMSCHAPv2 |
string |
|
EAPTLS |
string |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
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 |
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. |
ProcessorArchitecture
VPN client Processor Architecture.
Name | Type | Description |
---|---|---|
Amd64 |
string |
|
X86 |
string |
VpnClientParameters
Vpn Client Parameters for package generation.
Name | Type | Description |
---|---|---|
authenticationMethod |
VPN client authentication method. |
|
clientRootCertificates |
string[] |
A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS. |
processorArchitecture |
VPN client Processor Architecture. |
|
radiusServerAuthCertificate |
string |
The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication. |