az network vwan

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.39.0 or higher). The extension will automatically install the first time you run an az network vwan command. Learn more about extensions.

Manage virtual WANs.

Commands

az network vwan create

Create a virtual WAN.

az network vwan delete

Delete a virtual WAN.

az network vwan list

List virtual WANs.

az network vwan show

Get the details of a virtual WAN.

az network vwan update

Update settings of a virtual WAN.

az network vwan create

Create a virtual WAN.

az network vwan create --name
                       --resource-group
                       [--branch-to-branch-traffic {false, true}]
                       [--disable-vpn-encryption {false, true}]
                       [--location]
                       [--office365-category]
                       [--security-provider-name]
                       [--tags]
                       [--type {Basic, Standard}]

Required Parameters

--name -n

Name of the virtual WAN.

--resource-group -g

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

Optional Parameters

--branch-to-branch-traffic

Allow branch-to-branch traffic flow.

accepted values: false, true
--disable-vpn-encryption

State of VPN encryption.

accepted values: false, true
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--office365-category

The office local breakout category.

--security-provider-name

The security provider name.

--tags

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

--type

The type of the VirtualWAN.

accepted values: Basic, Standard

az network vwan delete

Delete a virtual WAN.

az network vwan delete --name
                       --resource-group

Required Parameters

--name -n

Name of the virtual WAN.

--resource-group -g

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

az network vwan list

List virtual WANs.

az network vwan 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 vwan show

Get the details of a virtual WAN.

az network vwan show --name
                     --resource-group

Required Parameters

--name -n

Name of the virtual WAN.

--resource-group -g

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

az network vwan update

Update settings of a virtual WAN.

az network vwan update --name
                       --resource-group
                       [--add]
                       [--branch-to-branch-traffic {false, true}]
                       [--disable-vpn-encryption {false, true}]
                       [--force-string]
                       [--office365-category]
                       [--remove]
                       [--security-provider-name]
                       [--set]
                       [--tags]
                       [--type {Basic, Standard}]

Required Parameters

--name -n

Name of the virtual WAN.

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

--branch-to-branch-traffic

Allow branch-to-branch traffic flow.

accepted values: false, true
--disable-vpn-encryption

State of VPN encryption.

accepted values: false, true
--force-string

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

--office365-category

The office local breakout category.

--remove

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

--security-provider-name

The security provider name.

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

--type

The type of the VirtualWAN.

accepted values: Basic, Standard