az network vnet-gateway vpn-client

  • Reference

Download a VPN client configuration required to connect to Azure via point-to-site.

Commands

Name Description Type Status
az network vnet-gateway vpn-client generate

Generate VPN client configuration.

 Core GA

az network vnet-gateway vpn-client generate

Edit

Generate VPN client configuration.

az network vnet-gateway vpn-client generate [--ids]
                                            [--name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--processor-architecture {Amd64, X86}]
                                            [--resource-group]
                                            [--subscription]

Examples

Create the VPN client configuration for AMD64 architecture.

az network vnet-gateway vpn-client generate -g MyResourceGroup -n MyVnetGateway --processor-architecture Amd64

Generate VPN client configuration.

az network vnet-gateway vpn-client generate --name MyVnetGateway --processor-architecture Amd64 --resource-group MyResourceGroup --subscription MySubscription

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the VNet gateway.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--processor-architecture

VPN client Processor Architecture. Possible values are: 'AMD64' and 'X86'.

accepted values: Amd64, X86
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.