az network vpn-gateway

Reference

Note

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

Manage site-to-site VPN gateways.

Commands

az network vpn-gateway connection	Manage site-to-site VPN gateway connections.
az network vpn-gateway connection create	Create a site-to-site VPN gateway connection.
az network vpn-gateway connection delete	Delete a site-to-site VPN gateway connection.
az network vpn-gateway connection ipsec-policy	Manage site-to-site VPN gateway connection IPSec policies.
az network vpn-gateway connection ipsec-policy add	Add an IPSec policy to a site-to-site VPN gateway connection.
az network vpn-gateway connection ipsec-policy list	List site-to-site VPN gateway connection IPSec policies.
az network vpn-gateway connection ipsec-policy remove	Remove an IPSec policy from a site-to-site VPN gateway connection.
az network vpn-gateway connection list	List site-to-site VPN gateway connections.
az network vpn-gateway connection show	Get the details of a site-to-site VPN gateway connection.
az network vpn-gateway connection update	Update settings of VPN gateway connection.
az network vpn-gateway connection vpn-site-link-conn	Manage site-to-site VPN gateway connection VPN site link connection.
az network vpn-gateway connection vpn-site-link-conn add	Add a VPN site link connection to a site-to-site VPN gateway connection.
az network vpn-gateway connection vpn-site-link-conn ipsec-policy	Manage site-to-site VPN gateway connection VPN site link IPSec policies.
az network vpn-gateway connection vpn-site-link-conn ipsec-policy add	Add an IPSec policy to a site-to-site VPN gateway connection VPN site link.
az network vpn-gateway connection vpn-site-link-conn ipsec-policy list	List site-to-site VPN gateway connection VPN site link IPSec policies.
az network vpn-gateway connection vpn-site-link-conn ipsec-policy remove	Remove an IPSec policy from a site-to-site VPN gateway connection VPN site link.
az network vpn-gateway connection vpn-site-link-conn list	List site-to-site VPN gateway connection VPN site link connection.
az network vpn-gateway connection vpn-site-link-conn remove	Remove a VPN site link connection from a site-to-site VPN gateway connection.
az network vpn-gateway connection wait	Place the CLI in a waiting state until a condition of the site-to-site VPN gateway connection is met.
az network vpn-gateway create	Create a site-to-site VPN gateway.
az network vpn-gateway delete	Delete a site-to-site VPN gateway.
az network vpn-gateway list	List site-to-site VPN gateways.
az network vpn-gateway show	Get the details of a site-to-site VPN gateway.
az network vpn-gateway update	Update settings of a site-to-site VPN gateway.

az network vpn-gateway create

Create a site-to-site VPN gateway.

az network vpn-gateway create --name
                              --resource-group
                              --vhub
                              [--asn]
                              [--bgp-peering-address]
                              [--location]
                              [--no-wait]
                              [--peer-weight]
                              [--scale-unit]
                              [--tags]

Required Parameters

--name -n

Name of the VPN gateway.

--resource-group -g

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

--vhub

Name or ID of a virtual hub.

Optional Parameters

--asn

BGP speaker's ASN.

--bgp-peering-address

Peering address and BGP identifier of this BGP speaker.

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

--peer-weight

Weight added to routes learned from this BGP speaker.

--scale-unit

The scale unit for this VPN gateway.

--tags

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

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.

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

Delete a site-to-site VPN gateway.

az network vpn-gateway delete --name
                              --resource-group

Required Parameters

--name -n

Name of the VPN gateway.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

List site-to-site VPN gateways.

az network vpn-gateway list [--resource-group]

Optional Parameters

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Get the details of a site-to-site VPN gateway.

az network vpn-gateway show --name
                            --resource-group

Required Parameters

--name -n

Name of the VPN gateway.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

Update settings of a site-to-site VPN gateway.

az network vpn-gateway update --name
                              --resource-group
                              [--add]
                              [--asn]
                              [--bgp-peering-address]
                              [--force-string]
                              [--no-wait]
                              [--peer-weight]
                              [--remove]
                              [--scale-unit]
                              [--set]
                              [--tags]
                              [--vhub]

Required Parameters

--name -n

Name of the VPN gateway.

--resource-group -g

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

Optional Parameters

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

--asn

BGP speaker's ASN.

--bgp-peering-address

Peering address and BGP identifier of this BGP speaker.

--force-string

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

--no-wait

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

--peer-weight

Weight added to routes learned from this BGP speaker.

--remove

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

--scale-unit

The scale unit for this VPN gateway.

--set

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

--tags

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

--vhub

Name or ID of a virtual hub.

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.

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

Is this page helpful?

Commands

az network vpn-gateway create

Required Parameters

Optional Parameters

az network vpn-gateway delete

Required Parameters

az network vpn-gateway list

Optional Parameters

az network vpn-gateway show

Required Parameters

az network vpn-gateway update

Required Parameters

Optional Parameters

الملاحظات