Local gateways - az network local-gateway

Manage local gateways.

Commands

az network local-gateway create Create a local VPN gateway.
az network local-gateway delete Delete a local VPN gateway.
az network local-gateway list List local VPN gateways.
az network local-gateway show Show details of a local VPN gateway.
az network local-gateway update Update a local VPN gateway.
az network local-gateway wait

az network local-gateway create

Create a local VPN gateway.

az network local-gateway create --gateway-ip-address
--name
--resource-group
[--asn]
[--bgp-peering-address]
[--local-address-prefixes]
[--location]
[--no-wait]
[--peer-weight]
[--tags]

Required Parameters

--gateway-ip-address

Gateway's public IP address. (e.g. 10.1.1.1).

--name -n

Name of the local network gateway.

--resource-group -g

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

Optional Parameters

--asn

Autonomous System Number to use for the BGP settings.

--bgp-peering-address

IP address from the OnPremise VPN's subnet to use for BGP peering.

--local-address-prefixes

List of CIDR block prefixes representing the address space of the OnPremise VPN's subnet.

--location -l

Location. You can configure the default location using az configure --defaults location=.

--no-wait

Do not wait for the long running operation to finish.

--peer-weight

Weight (0-100) added to routes learned through BGP peering.

--tags

Space separated tags in 'key[=value]' format. Use "" to clear existing tags.

az network local-gateway delete

Delete a local VPN gateway.

az network local-gateway delete --name
--resource-group
[--no-wait]

Required Parameters

--name -n

Name of the local network gateway.

--resource-group -g

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

Optional Parameters

--no-wait

Do not wait for the long running operation to finish.

az network local-gateway list

List local VPN gateways.

az network local-gateway list --resource-group

Required Parameters

--resource-group -g

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

az network local-gateway show

Show details of a local VPN gateway.

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

Required Parameters

--name -n

Name of the local network gateway.

--resource-group -g

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

az network local-gateway update

Update a local VPN gateway.

az network local-gateway update --name
--resource-group
[--add]
[--asn]
[--bgp-peering-address]
[--gateway-ip-address]
[--local-address-prefixes]
[--no-wait]
[--peer-weight]
[--remove]
[--set]
[--tags]

Required Parameters

--name -n

Name of the local network gateway.

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .

--asn

Autonomous System Number to use for the BGP settings.

--bgp-peering-address

IP address from the OnPremise VPN's subnet to use for BGP peering.

--gateway-ip-address

Gateway's public IP address. (e.g. 10.1.1.1).

--local-address-prefixes

List of CIDR block prefixes representing the address space of the OnPremise VPN's subnet.

--no-wait

Do not wait for the long running operation to finish.

--peer-weight

Weight (0-100) added to routes learned through BGP peering.

--remove

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

--set

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

--tags

Space separated tags in 'key[=value]' format. Use "" to clear existing tags.

az network local-gateway wait

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

Required Parameters

--name -n

Name of the local network gateway.

--resource-group -g

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

Optional Parameters

--created

Wait till 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 till deleted.

--exists

Wait till the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait till updated with provisioningState at 'Succeeded'.