az network vpn-gateway connection
Manage VPN gateway connections.
Commands
az network vpn-gateway connection create |
Create a VPN gateway connection. |
az network vpn-gateway connection delete |
Delete a VPN gateway connection. |
az network vpn-gateway connection ipsec-policy |
Manage VPN gateway connection IPSec policies. |
az network vpn-gateway connection ipsec-policy add |
Add an IPSec policy to a VPN gateway connection. |
az network vpn-gateway connection ipsec-policy list |
List VPN gateway connection IPSec policies. |
az network vpn-gateway connection ipsec-policy remove |
Remove an IPSec policy from a VPN gateway connection. |
az network vpn-gateway connection list |
List VPN gateway connections. |
az network vpn-gateway connection show |
Get the details of a VPN gateway connection. |
az network vpn-gateway connection wait |
Place the CLI in a waiting state until a condition of the VPN gateway connection is met. |
az network vpn-gateway connection create
Create a VPN gateway connection.
az network vpn-gateway connection create --gateway-name
--name
--remote-vpn-site
--resource-group
[--associated]
[--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]
Examples
Create a 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
Required Parameters
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>
.
Optional Parameters
The resource id of route table associated with this 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.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network vpn-gateway connection delete
Delete a VPN gateway connection.
az network vpn-gateway connection delete --gateway-name
--name
--resource-group
Examples
Delete a VPN gateway connection
az network vpn-gateway connection delete -g MyRG -n MyConnection --gateway-name MyGateway
Required Parameters
Name of the VPN gateway.
Name of the VPN gateway connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network vpn-gateway connection list
List VPN gateway connections.
az network vpn-gateway connection list --gateway-name
--resource-group
Examples
List all connections for a given VPN gateway
az network vpn-gateway connection list -g MyRG --gateway-name MyGateway
Required Parameters
Name of the VPN gateway.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network vpn-gateway connection show
Get the details of a VPN gateway connection.
az network vpn-gateway connection show --gateway-name
--name
--resource-group
Examples
Get the details of a VPN gateway connection
az network vpn-gateway connection show -g MyRG -n MyConnection --gateway-name MyGateway
Required Parameters
Name of the VPN gateway.
Name of the VPN gateway connection.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Increase logging verbosity. Use --debug for full debug logs.
az network vpn-gateway connection wait
Place the CLI in a waiting state until a condition of the VPN gateway connection is met.
az network vpn-gateway connection wait --gateway-name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Required Parameters
Name of the VPN gateway.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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.
Increase logging verbosity. Use --debug for full debug logs.