az network vpn-site

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-site command. Learn more about extensions.

Manage VPN site configurations.

Commands

Name	Description	Type	Status
az network vpn-site create	Create a VPN site configuration.	Extension	GA
az network vpn-site delete	Delete a VPN site configuration.	Extension	GA
az network vpn-site download	Provide a SAS-URL to download the configuration for a VPN site.	Extension	GA
az network vpn-site link	Manage VPN site link.	Extension	GA
az network vpn-site link add	Add a VPN site link to VPN site configuration.	Extension	GA
az network vpn-site link list	List VPN site links on VPN site configuration.	Extension	GA
az network vpn-site link remove	Remove a VPN site link from VPN site configuration.	Extension	GA
az network vpn-site list	List VPN site configurations.	Extension	GA
az network vpn-site show	Get the details of a VPN site configuration.	Extension	GA
az network vpn-site update	Update settings of a VPN site configuration.	Extension	GA

az network vpn-site create

Create a VPN site configuration.

az network vpn-site create --ip-address
                           --name
                           --resource-group
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--device-model]
                           [--device-vendor]
                           [--link-speed]
                           [--location]
                           [--no-wait]
                           [--peer-weight]
                           [--security-site {false, true}]
                           [--site-key]
                           [--tags]
                           [--virtual-wan]
                           [--with-link {false, true}]

Required Parameters

--ip-address

IP address of the VPN site.

--name -n

Name of the VPN site config.

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

--address-prefixes

Space-separated list of CIDR address prefixes.

--asn

BGP speaker's ASN.

Property	Value
Parameter group:	BGP Peering Arguments

--bgp-peering-address

Peering address and BGP identifier of this BGP speaker.

Property	Value
Parameter group:	BGP Peering Arguments

--device-model

Model of the device.

Property	Value
Parameter group:	Device Property Arguments

--device-vendor

Name of the device vendor.

Property	Value
Parameter group:	Device Property Arguments

--link-speed

Link speed in Mbps.

Property	Value
Parameter group:	Device Property Arguments

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

--peer-weight

Weight added to routes learned from this BGP speaker.

Property	Value
Parameter group:	BGP Peering Arguments

--security-site

Whether the VPN site is security-related.

Property	Value
Accepted values:	false, true

--site-key

Key for the VPN site that can be used for connections.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--virtual-wan

Name or ID of the virtual WAN.

--with-link

Create VPN site with default link.

Property	Value
Accepted values:	false, true

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-site delete

Delete a VPN site configuration.

az network vpn-site delete [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Optional Parameters

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

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the VPN site config.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

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

Property	Value
Default value:	False

az network vpn-site download

Provide a SAS-URL to download the configuration for a VPN site.

az network vpn-site download --request
                             --resource-group
                             --vwan-name

Required Parameters

--request

Parameters supplied to download vpn-sites configuration. Is either a model type or a IO type. Required.

--resource-group -g

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

--vwan-name

Name of the virtual WAN.

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-site list

List VPN site configurations.

az network vpn-site 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-site show

Get the details of a VPN site configuration.

az network vpn-site show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Optional Parameters

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

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the VPN site config.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

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

Property	Value
Default value:	False

az network vpn-site update

Update settings of a VPN site configuration.

az network vpn-site update [--add]
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--device-model]
                           [--device-vendor]
                           [--force-string]
                           [--ids]
                           [--ip-address]
                           [--link-speed]
                           [--name]
                           [--no-wait]
                           [--peer-weight]
                           [--remove]
                           [--resource-group]
                           [--security-site {false, true}]
                           [--set]
                           [--site-key]
                           [--subscription]
                           [--tags]
                           [--virtual-wan]

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--address-prefixes

Space-separated list of CIDR address prefixes.

--asn

BGP speaker's ASN.

Property	Value
Parameter group:	BGP Peering Arguments

--bgp-peering-address

Peering address and BGP identifier of this BGP speaker.

Property	Value
Parameter group:	BGP Peering Arguments

--device-model

Model of the device.

Property	Value
Parameter group:	Device Property Arguments

--device-vendor

Name of the device vendor.

Property	Value
Parameter group:	Device Property Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	False

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

Property	Value
Parameter group:	Resource Id Arguments

--ip-address

IP address of the VPN site.

--link-speed

Link speed in Mbps.

Property	Value
Parameter group:	Device Property Arguments

--name -n

Name of the VPN site config.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Default value:	False

--peer-weight

Weight added to routes learned from this BGP speaker.

Property	Value
Parameter group:	BGP Peering Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--security-site

Whether the VPN site is security-related.

Property	Value
Accepted values:	false, true

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments
Default value:	[]

--site-key

Key for the VPN site that can be used for connections.

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--virtual-wan

Name or ID of the virtual WAN.

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.

--verbose

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

Property	Value
Default value:	False