virtual_wans

Creates, updates, deletes, gets or lists a virtual_wans resource.

Overview

Name	virtual_wans
Type	Resource
Id	azure.network.virtual_wans

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowBranchToBranchTraffic	boolean	True if branch to branch traffic is allowed.
allowVnetToVnetTraffic	boolean	True if Vnet to Vnet traffic is allowed.
disableVpnEncryption	boolean	Vpn encryption to be disabled or not.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
office365LocalBreakoutCategory	string	The office local breakout category. Known values are: "Optimize", "OptimizeAndAllow", "All", and "None". (Optimize, OptimizeAndAllow, All, None)
provisioningState	string	The provisioning state of the virtual WAN resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
virtualHubs	array	List of VirtualHubs in the VirtualWAN.
vpnSites	array	List of VpnSites in the VirtualWAN.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowBranchToBranchTraffic	boolean	True if branch to branch traffic is allowed.
allowVnetToVnetTraffic	boolean	True if Vnet to Vnet traffic is allowed.
disableVpnEncryption	boolean	Vpn encryption to be disabled or not.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
office365LocalBreakoutCategory	string	The office local breakout category. Known values are: "Optimize", "OptimizeAndAllow", "All", and "None". (Optimize, OptimizeAndAllow, All, None)
provisioningState	string	The provisioning state of the virtual WAN resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
virtualHubs	array	List of VirtualHubs in the VirtualWAN.
vpnSites	array	List of VpnSites in the VirtualWAN.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
allowBranchToBranchTraffic	boolean	True if branch to branch traffic is allowed.
allowVnetToVnetTraffic	boolean	True if Vnet to Vnet traffic is allowed.
disableVpnEncryption	boolean	Vpn encryption to be disabled or not.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
office365LocalBreakoutCategory	string	The office local breakout category. Known values are: "Optimize", "OptimizeAndAllow", "All", and "None". (Optimize, OptimizeAndAllow, All, None)
provisioningState	string	The provisioning state of the virtual WAN resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
tags	object	Resource tags.
type	string	Resource type.
virtualHubs	array	List of VirtualHubs in the VirtualWAN.
vpnSites	array	List of VpnSites in the VirtualWAN.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_wan_name, subscription_id		Retrieves the details of a VirtualWAN.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the VirtualWANs in a resource group.
list	select	subscription_id		Lists all the VirtualWANs in a subscription.
create_or_update	insert	resource_group_name, virtual_wan_name, subscription_id		Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.
update_tags	update	resource_group_name, virtual_wan_name, subscription_id		Updates a VirtualWAN tags.
create_or_update	replace	resource_group_name, virtual_wan_name, subscription_id		Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.
delete	delete	resource_group_name, virtual_wan_name, subscription_id		Deletes a VirtualWAN.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_wan_name	string	The name of the VirtualWAN being retrieved. Required.

SELECT examples

get

Retrieves the details of a VirtualWAN.

SELECT
id,
name,
allowBranchToBranchTraffic,
allowVnetToVnetTraffic,
disableVpnEncryption,
etag,
location,
office365LocalBreakoutCategory,
provisioningState,
tags,
type,
virtualHubs,
vpnSites
FROM azure.network.virtual_wans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_wan_name = '{{ virtual_wan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the VirtualWANs in a resource group.

SELECT
id,
name,
allowBranchToBranchTraffic,
allowVnetToVnetTraffic,
disableVpnEncryption,
etag,
location,
office365LocalBreakoutCategory,
provisioningState,
tags,
type,
virtualHubs,
vpnSites
FROM azure.network.virtual_wans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the VirtualWANs in a subscription.

SELECT
id,
name,
allowBranchToBranchTraffic,
allowVnetToVnetTraffic,
disableVpnEncryption,
etag,
location,
office365LocalBreakoutCategory,
provisioningState,
tags,
type,
virtualHubs,
vpnSites
FROM azure.network.virtual_wans
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.

INSERT INTO azure.network.virtual_wans (
id,
location,
tags,
properties,
resource_group_name,
virtual_wan_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_wan_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_wans
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_wans resource.
  - name: virtual_wan_name
    value: "{{ virtual_wan_name }}"
    description: Required parameter for the virtual_wans resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_wans resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the virtual WAN.
    value:
      disableVpnEncryption: {{ disableVpnEncryption }}
      virtualHubs:
        - id: "{{ id }}"
      vpnSites:
        - id: "{{ id }}"
      allowBranchToBranchTraffic: {{ allowBranchToBranchTraffic }}
      allowVnetToVnetTraffic: {{ allowVnetToVnetTraffic }}
      office365LocalBreakoutCategory: "{{ office365LocalBreakoutCategory }}"
      provisioningState: "{{ provisioningState }}"
      type: "{{ type }}"

UPDATE examples

update_tags

Updates a VirtualWAN tags.

UPDATE azure.network.virtual_wans
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_wan_name = '{{ virtual_wan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.

REPLACE azure.network.virtual_wans
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_wan_name = '{{ virtual_wan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a VirtualWAN.

DELETE FROM azure.network.virtual_wans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_wan_name = '{{ virtual_wan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;