az network p2s-vpn-gateway connection

  • Preview
  • Reference

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 p2s-vpn-gateway connection command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage point-to-site VPN gateway connections.

Commands

Name Description Type Status
az network p2s-vpn-gateway connection list

List all connections for a given point-to-site VPN gateway.

 Extension Preview
az network p2s-vpn-gateway connection show

Show the details of a point-to-site VPN gateway connection.

 Extension Preview

az network p2s-vpn-gateway connection list

Preview

Command group 'network p2s-vpn-gateway connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all connections for a given point-to-site VPN gateway.

az network p2s-vpn-gateway connection list --gateway-name
                                           --resource-group

Examples

List all connections for a given point-to-site VPN gateway

az network p2s-vpn-gateway connection list -g MyRG --gateway-name MyP2SVPNGateway

Required Parameters

--gateway-name

Name of the P2S 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.

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 p2s-vpn-gateway connection show

Preview

Command group 'network p2s-vpn-gateway connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the details of a point-to-site VPN gateway connection.

az network p2s-vpn-gateway connection show [--gateway-name]
                                           [--ids]
                                           [--name]
                                           [--resource-group]
                                           [--subscription]

Examples

Show the details of a point-to-site VPN gateway connection

az network p2s-vpn-gateway connection show -g MyRG -n connection --gateway-name MyP2SVPNGateway

Optional Parameters

--gateway-name

Name of the P2S VPN gateway.

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

--name -n

Name of the P2S VPN gateway connection.

--resource-group -g

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

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