virtual_wans

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

Overview

Name	virtual_wans
Type	Resource
Id	azure.network.virtual_wans

Fields

vw_virtual_wans

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
VirtualWANName	text	field from the properties object
allow_branch_to_branch_traffic	text	field from the properties object
allow_vnet_to_vnet_traffic	text	field from the properties object
disable_vpn_encryption	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
location	text	Resource location.
office365_local_breakout_category	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtual_hubs	text	field from the properties object
vpn_sites	text	field from the properties object

virtual_wans

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Parameters for VirtualWAN.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	VirtualWANName, resourceGroupName, subscriptionId	Retrieves the details of a VirtualWAN.
list	SELECT	subscriptionId	Lists all the VirtualWANs in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all the VirtualWANs in a resource group.
create_or_update	INSERT	VirtualWANName, resourceGroupName, subscriptionId, data__location	Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.
delete	DELETE	VirtualWANName, resourceGroupName, subscriptionId	Deletes a VirtualWAN.
update_tags	EXEC	VirtualWANName, resourceGroupName, subscriptionId	Updates a VirtualWAN tags.

SELECT examples

Lists all the VirtualWANs in a subscription.

vw_virtual_wans

SELECT
id,
name,
VirtualWANName,
allow_branch_to_branch_traffic,
allow_vnet_to_vnet_traffic,
disable_vpn_encryption,
etag,
location,
office365_local_breakout_category,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
type,
virtual_hubs,
vpn_sites
FROM azure.network.vw_virtual_wans
WHERE subscriptionId = '{{ subscriptionId }}';

virtual_wans

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.virtual_wans
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new virtual_wans resource.

All Properties

/*+ create */
INSERT INTO azure.network.virtual_wans (
VirtualWANName,
resourceGroupName,
subscriptionId,
data__location,
properties,
id,
location,
tags
)
SELECT 
'{{ VirtualWANName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: disableVpnEncryption
          value: boolean
        - name: virtualHubs
          value:
            - - name: id
                value: string
        - name: vpnSites
          value:
            - - name: id
                value: string
        - name: allowBranchToBranchTraffic
          value: boolean
        - name: allowVnetToVnetTraffic
          value: boolean
        - name: office365LocalBreakoutCategory
          value: []
        - name: provisioningState
          value: []
        - name: type
          value: string
    - name: etag
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified virtual_wans resource.

/*+ delete */
DELETE FROM azure.network.virtual_wans
WHERE VirtualWANName = '{{ VirtualWANName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';