az network p2s-vpn-gateway

Manage point-to-site VPN gateway.

Commands

az network p2s-vpn-gateway connection

Manage point-to-site VPN gateway connections.

az network p2s-vpn-gateway connection list

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

az network p2s-vpn-gateway connection show

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

az network p2s-vpn-gateway create

Create a point-to-site VPN gateway.

az network p2s-vpn-gateway delete

Delete a point-to-site VPN gateway.

az network p2s-vpn-gateway list

List all point-to-site VPN gateway.

az network p2s-vpn-gateway show

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

az network p2s-vpn-gateway update

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

az network p2s-vpn-gateway wait

Place the CLI in a waiting state until a condition of the point-to-site VPN gateway is met.

az network p2s-vpn-gateway create

Create a point-to-site VPN gateway.

az network p2s-vpn-gateway create --name
                                  --resource-group
                                  --scale-unit
                                  --vhub
                                  [--address-space]
                                  [--associated]
                                  [--config-name]
                                  [--labels]
                                  [--location]
                                  [--no-wait]
                                  [--propagated]
                                  [--tags]
                                  [--vpn-server-config]

Examples

Create a point-to-site VPN gateway.

az network p2s-vpn-gateway create -g MyRG -n MyP2SVPNGateway --scale-unit 2 --vhub MyVhub --vpn-server-config MyVPNServerConfig --address-space 10.0.0.0/24 11.0.0.0/24

Create a point-to-site VPN gateway with routing configuration.

az network p2s-vpn-gateway create -g MyRG -n MyP2SVPNGateway --scale-unit 2 --vhub MyVhub --vpn-server-config MyVPNServerConfig --address-space 10.0.0.0/24 11.0.0.0/24 --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 -n

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

--scale-unit

The scale unit for this VPN gateway.

--vhub

Name or ID of a virtual hub.

Optional Parameters

--address-space

Address space for P2S VpnClient. Space-separated list of IP address ranges.

--associated --associated-route-table

The resource id of route table associated with this routing configuration.

--config-name

Name or p2s connection configuration.

default value: P2SConnectionConfigDefault
--labels

Space-separated list of labels for propagated route tables.

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

--propagated --propagated-route-tables

Space-separated list of resource id of propagated route tables.

--tags

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

--vpn-server-config

Name or ID of a vpn server configuration.

az network p2s-vpn-gateway delete

Delete a point-to-site VPN gateway.

az network p2s-vpn-gateway delete --name
                                  --resource-group
                                  [--yes]

Required Parameters

--name -n

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

az network p2s-vpn-gateway list

List all point-to-site VPN gateway.

az network p2s-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>.

az network p2s-vpn-gateway show

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

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

Required Parameters

--name -n

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

az network p2s-vpn-gateway update

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

az network p2s-vpn-gateway update --name
                                  --resource-group
                                  [--add]
                                  [--address-space]
                                  [--associated]
                                  [--config-name]
                                  [--force-string]
                                  [--labels]
                                  [--no-wait]
                                  [--propagated]
                                  [--remove]
                                  [--scale-unit]
                                  [--set]
                                  [--tags]
                                  [--vpn-server-config]

Required Parameters

--name -n

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

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

--address-space

Address space for P2S VpnClient. Space-separated list of IP address ranges.

--associated --associated-route-table

The resource id of route table associated with this routing configuration.

--config-name

Name or p2s connection configuration.

--force-string

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

--labels

Space-separated list of labels for propagated route tables.

--no-wait

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

--propagated --propagated-route-tables

Space-separated list of resource id of propagated route tables.

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

--vpn-server-config

Name or ID of a vpn server configuration.

az network p2s-vpn-gateway wait

Place the CLI in a waiting state until a condition of the point-to-site VPN gateway is met.

az network p2s-vpn-gateway wait --name
                                --resource-group
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--interval]
                                [--timeout]
                                [--updated]

Required Parameters

--name -n

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.