az network vpn-site link

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

Manage VPN site link.

Commands

Name	Description	Type	Status
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 link add

Add a VPN site link to VPN site configuration.

az network vpn-site link add --ip-address
                             --name
                             [--asn]
                             [--bgp-peering-address]
                             [--fqdn]
                             [--ids]
                             [--link-provider-name]
                             [--link-speed-in-mbps]
                             [--no-wait]
                             [--resource-group]
                             [--site-name]
                             [--subscription]

Examples

Add a VPN site link to VPN site configuration

az network vpn-site link add -g MyRG --site-name VpnSite -n VpnSiteLinkName --ip-address 10.0.1.111 --asn 1234 --bgp-peering-address 192.168.0.0

Required Parameters

--ip-address

IP address of the VPN site.

--name -n

The name of vpn site link.

Optional Parameters

--asn

BGP speaker's ASN.

--bgp-peering-address

Peering address and BGP identifier of this BGP speaker.

--fqdn

FQDN of vpn-site-link.

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

--link-provider-name

Name of the link provider.

--link-speed-in-mbps

Link speed.

--no-wait

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

Default value: False

--resource-group -g

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

--site-name

Name of the VPN site config.

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

az network vpn-site link list

List VPN site links on VPN site configuration.

az network vpn-site link list --resource-group
                              --site-name

Examples

List VPN site links on VPN site configuration

az network vpn-site link list -g MyRG --site-name VpnSite

Required Parameters

--resource-group -g

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

--site-name

Name of the VPN site config.

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.

az network vpn-site link remove

Remove a VPN site link from VPN site configuration.

az network vpn-site link remove --index
                                [--ids]
                                [--no-wait]
                                [--resource-group]
                                [--site-name]
                                [--subscription]

Examples

Remove a VPN site links from VPN site configuration

az network vpn-site link remove -g MyRG --site-name VpnSite --index 1

Required Parameters

--index

List index of the item (starting with 1).

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.

--no-wait

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

Default value: False

--resource-group -g

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

--site-name

Name of the VPN site config.

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