az network vpn-server-config

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 vpn-server-config command. Learn more about extensions.

Manage VPN server configuration.

Commands

Name	Description	Type	Status
az network vpn-server-config create	Create a VPN server configuration.	Extension	GA
az network vpn-server-config delete	Delete a VPN server configuration.	Extension	GA
az network vpn-server-config ipsec-policy	Manage VPN server configuration IPSec policies.	Extension	GA
az network vpn-server-config ipsec-policy add	Add an IPSec policy to a VPN server configuration.	Extension	GA
az network vpn-server-config ipsec-policy list	List VPN server configuration IPSec policies.	Extension	GA
az network vpn-server-config ipsec-policy remove	Remove an IPSec policy from a VPN server configuration.	Extension	GA
az network vpn-server-config ipsec-policy wait	Place the CLI in a waiting state until a condition of the IPSec policy of a VPN server configuration is met.	Extension	GA
az network vpn-server-config list	List all VPN server configuration.	Extension	GA
az network vpn-server-config set	Set settings of a VPN server configuration.	Extension	GA
az network vpn-server-config show	Show the details of a VPN server configuration.	Extension	GA
az network vpn-server-config wait	Place the CLI in a waiting state until a condition of the VPN server configuration is met.	Extension	GA

az network vpn-server-config create

Create a VPN server configuration.

az network vpn-server-config create --name
                                    --resource-group
                                    [--aad-audience]
                                    [--aad-issuer]
                                    [--aad-tenant]
                                    [--auth-types {AAD, Certificate, Radius}]
                                    [--location]
                                    [--no-wait]
                                    [--protocols {IkeV2, OpenVPN}]
                                    [--radius-client-root-certs]
                                    [--radius-server-root-certs]
                                    [--radius-servers]
                                    [--vpn-client-revoked-certs]
                                    [--vpn-client-root-certs]

Examples

Create a VPN server configuration with VPN auth type

az network vpn-server-config create -n MyVPNServerConfig -g MyRG --vpn-client-root-certs "ApplicationGatewayAuthCert.cer" --vpn-client-revoked-certs "ApplicationGatewayAuthCert.pem"

Required Parameters

--name -n

Name of the Vpn server configuration.

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

--aad-audience

AAD Vpn authentication parameter AAD audience.

Property	Value
Parameter group:	AAD Auth Arguments

--aad-issuer

AAD Vpn authentication parameter AAD issuer.

Property	Value
Parameter group:	AAD Auth Arguments

--aad-tenant

AAD Vpn authentication parameter AAD tenant.

Property	Value
Parameter group:	AAD Auth Arguments

--auth-types

List of VPN authentication types for the VpnServerConfiguration.

Property	Value
Accepted values:	AAD, Certificate, Radius

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property	Value
Default value:	False

--protocols

VPN protocols for the VpnServerConfiguration.

Property	Value
Accepted values:	IkeV2, OpenVPN

--radius-client-root-certs

List of Radius client root certificate file paths.

Property	Value
Parameter group:	Radius Auth Arguments

--radius-server-root-certs

List of Radius server root certificate file paths.

Property	Value
Parameter group:	Radius Auth Arguments

--radius-servers

Radius Server configuration.

Property	Value
Parameter group:	Radius Auth Arguments

--vpn-client-revoked-certs

List of VPN client revoked certificate file paths.

Property	Value
Parameter group:	Certificate Auth Arguments

--vpn-client-root-certs

List of VPN client root certificate file paths.

Property	Value
Parameter group:	Certificate Auth Arguments

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

az network vpn-server-config delete

Delete a VPN server configuration.

az network vpn-server-config delete --name
                                    --resource-group
                                    [--yes]

Required Parameters

--name -n

Name of the Vpn server configuration.

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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

az network vpn-server-config list

List all VPN server configuration.

az network vpn-server-config list [--resource-group]

Optional Parameters

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

--resource-group -g

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

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

az network vpn-server-config set

Set settings of a VPN server configuration.

az network vpn-server-config set --name
                                 --resource-group
                                 [--aad-audience]
                                 [--aad-issuer]
                                 [--aad-tenant]
                                 [--auth-types {AAD, Certificate, Radius}]
                                 [--location]
                                 [--no-wait]
                                 [--protocols {IkeV2, OpenVPN}]
                                 [--radius-client-root-certs]
                                 [--radius-server-root-certs]
                                 [--radius-servers]
                                 [--vpn-client-revoked-certs]
                                 [--vpn-client-root-certs]

Examples

Set a VPN server configuration with Radius auth type

az network vpn-server-config set -n MyVPNServerConfig -g MyRG --radius-client-root-certs "ApplicationGatewayAuthCert.cer" --radius-server-root-certs "ApplicationGatewayAuthCert.pem" --radius-servers address=test1 secret=clitest score=10 --radius-servers address=test2 secret=clitest score=10

Required Parameters

--name -n

Name of the Vpn server configuration.

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

--aad-audience

AAD Vpn authentication parameter AAD audience.

Property	Value
Parameter group:	AAD Auth Arguments

--aad-issuer

AAD Vpn authentication parameter AAD issuer.

Property	Value
Parameter group:	AAD Auth Arguments

--aad-tenant

AAD Vpn authentication parameter AAD tenant.

Property	Value
Parameter group:	AAD Auth Arguments

--auth-types

List of VPN authentication types for the VpnServerConfiguration.

Property	Value
Accepted values:	AAD, Certificate, Radius

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property	Value
Default value:	False

--protocols

VPN protocols for the VpnServerConfiguration.

Property	Value
Accepted values:	IkeV2, OpenVPN

--radius-client-root-certs

List of Radius client root certificate file paths.

Property	Value
Parameter group:	Radius Auth Arguments

--radius-server-root-certs

List of Radius server root certificate file paths.

Property	Value
Parameter group:	Radius Auth Arguments

--radius-servers

Radius Server configuration.

Property	Value
Parameter group:	Radius Auth Arguments

--vpn-client-revoked-certs

List of VPN client revoked certificate file paths.

Property	Value
Parameter group:	Certificate Auth Arguments

--vpn-client-root-certs

List of VPN client root certificate file paths.

Property	Value
Parameter group:	Certificate Auth Arguments

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

az network vpn-server-config show

Show the details of a VPN server configuration.

az network vpn-server-config show --name
                                  --resource-group

Required Parameters

--name -n

Name of the Vpn server configuration.

--resource-group -g

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

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

az network vpn-server-config wait

Place the CLI in a waiting state until a condition of the VPN server configuration is met.

az network vpn-server-config wait --name
                                  --resource-group
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--interval]
                                  [--timeout]
                                  [--updated]

Required Parameters

--name -n

Name of the Vpn server configuration.

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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