az network vpn-gateway connection
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-gateway connection command. Learn more about extensions.
Manage site-to-site VPN gateway connections.
Name | Description | Type | Status |
---|---|---|---|
az network vpn-gateway connection create |
Create a site-to-site VPN gateway connection. |
Extension | GA |
az network vpn-gateway connection delete |
Delete a site-to-site VPN gateway connection. |
Extension | GA |
az network vpn-gateway connection ipsec-policy |
Manage site-to-site VPN gateway connection IPSec policies. |
Extension | GA |
az network vpn-gateway connection ipsec-policy add |
Add an IPSec policy to a site-to-site VPN gateway connection. |
Extension | GA |
az network vpn-gateway connection ipsec-policy list |
List site-to-site VPN gateway connection IPSec policies. |
Extension | GA |
az network vpn-gateway connection ipsec-policy remove |
Remove an IPSec policy from a site-to-site VPN gateway connection. |
Extension | GA |
az network vpn-gateway connection list |
List site-to-site VPN gateway connections. |
Extension | GA |
az network vpn-gateway connection packet-capture |
Manage site-to-site VPN gateway connections packet capture. |
Extension | GA |
az network vpn-gateway connection packet-capture start |
Starts packet capture on Vpn connection in the specified resource group. |
Extension | GA |
az network vpn-gateway connection show |
Get the details of a site-to-site VPN gateway connection. |
Extension | GA |
az network vpn-gateway connection update |
Update settings of VPN gateway connection. |
Extension | GA |
az network vpn-gateway connection vpn-site-link-conn |
Manage site-to-site VPN gateway connection VPN site link connection. |
Extension | GA |
az network vpn-gateway connection vpn-site-link-conn add |
Add a VPN site link connection to a site-to-site VPN gateway connection. |
Extension | GA |
az network vpn-gateway connection vpn-site-link-conn ipsec-policy |
Manage site-to-site VPN gateway connection VPN site link IPSec policies. |
Extension | GA |
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. |
Extension | GA |
az network vpn-gateway connection vpn-site-link-conn ipsec-policy list |
List site-to-site VPN gateway connection VPN site link IPSec policies. |
Extension | GA |
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. |
Extension | GA |
az network vpn-gateway connection vpn-site-link-conn list |
List site-to-site VPN gateway connection VPN site link connection. |
Extension | GA |
az network vpn-gateway connection vpn-site-link-conn remove |
Remove a VPN site link connection from a site-to-site VPN gateway connection. |
Extension | GA |
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. |
Extension | GA |
Create a site-to-site VPN gateway connection.
az network vpn-gateway connection create --gateway-name
--name
--remote-vpn-site
--resource-group
[--associated]
[--associated-inbound-routemap]
[--associated-outbound-routemap]
[--connection-bandwidth]
[--enable-bgp {false, true}]
[--internet-security {false, true}]
[--labels]
[--no-wait]
[--propagated]
[--protocol-type {IKEv1, IKEv2}]
[--rate-limiting {false, true}]
[--routing-weight]
[--shared-key]
[--vpn-site-link]
[--with-link {false, true}]
Create a site-to-site VPN gateway connection
az network vpn-gateway connection create -g MyRG -n MyConnection --gateway-name MyGateway --remote-vpn-site /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/vpnSites/MyVPNSite --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable2 --labels label1 label2
Name of the VPN gateway.
Name of the VPN gateway connection.
Name of ID of the remote VPN site.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The resource id of route table associated with this routing configuration.
Resource uri of inbound routemap for this connection’s routing configuration.
Resource uri of outbound routemap for this connection’s routing configuration.
Expected bandwidth in Mbps.
Enable BGP.
Enable internet security.
Space-separated list of labels for propagated route tables.
Do not wait for the long-running operation to finish.
Space-separated list of resource id of propagated route tables.
Connection protocol.
Enable rate limiting.
Routing weight.
Shared key.
The resource ID of VPN Site Link.
Create VpnConnection with default link.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Delete a site-to-site VPN gateway connection.
az network vpn-gateway connection delete [--gateway-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Delete a site-to-site VPN gateway connection
az network vpn-gateway connection delete -g MyRG -n MyConnection --gateway-name MyGateway
Name of the VPN gateway.
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.
Name of the VPN gateway connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List site-to-site VPN gateway connections.
az network vpn-gateway connection list --gateway-name
--resource-group
List all connections for a given site-to-site VPN gateway
az network vpn-gateway connection list -g MyRG --gateway-name MyGateway
Name of the VPN gateway.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Get the details of a site-to-site VPN gateway connection.
az network vpn-gateway connection show [--gateway-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Get the details of a site-to-site VPN gateway connection
az network vpn-gateway connection show -g MyRG -n MyConnection --gateway-name MyGateway
Name of the VPN gateway.
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.
Name of the VPN gateway connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Update settings of VPN gateway connection.
az network vpn-gateway connection update [--add]
[--associated]
[--associated-inbound-routemap]
[--associated-outbound-routemap]
[--force-string]
[--gateway-name]
[--ids]
[--labels]
[--name]
[--no-wait]
[--propagated]
[--remove]
[--resource-group]
[--set]
[--subscription]
Add labels for propagated route tables under routing configuration.
az network vpn-gateway connection update -g MyRG -n MyConnection --gateway-name MyGateway --labels NewLabel1 NewLabels2
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>
.
The resource id of route table associated with this routing configuration.
Resource uri of inbound routemap for this connection’s routing configuration.
Resource uri of outbound routemap for this connection’s routing configuration.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Name of the VPN gateway.
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.
Space-separated list of labels for propagated route tables.
Name of the VPN gateway connection.
Do not wait for the long-running operation to finish.
Space-separated list of resource id of propagated route tables.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Place the CLI in a waiting state until a condition of the site-to-site VPN gateway connection is met.
az network vpn-gateway connection wait [--created]
[--custom]
[--deleted]
[--exists]
[--gateway-name]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Name of the VPN gateway.
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.
Polling interval in seconds.
Name of the VPN gateway connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: