az network p2s-vpn-gateway vpn-client

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az network p2s-vpn-gateway vpn-client command. Learn more about extensions.

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

Commands

Name	Description	Type	Status
az network p2s-vpn-gateway vpn-client generate	Generate VPN profile for P2S client of the P2SVpnGateway in the specified resource group.	Extension	GA

az network p2s-vpn-gateway vpn-client generate

Generate VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

az network p2s-vpn-gateway vpn-client generate --name
                                               --resource-group
                                               [--authentication-method {EAPMSCHAPv2, EAPTLS}]

Required Parameters

--name -n

Name of the P2S Vpn Gateway.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--authentication-method

VPN client authentication method.

Property	Value
Accepted values:	EAPMSCHAPv2, EAPTLS

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False