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

Request successful. Returns the details of the VirtualWAN retrieved.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the virtual WAN.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Request successful. Returns the details of all the VirtualWANs in the resource group.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the virtual WAN.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. Returns the details of all the VirtualWANs in the subscription.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the virtual WAN.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

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

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
VirtualWANName	string	The name of the VirtualWAN being updated.
resourceGroupName	string	The resource group name of the VirtualWan.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Retrieves the details of a VirtualWAN.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_wans
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND VirtualWANName = '{{ VirtualWANName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all the VirtualWANs in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_wans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all the VirtualWANs in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_wans
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
subscriptionId,
resourceGroupName,
VirtualWANName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ VirtualWANName }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_wans
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_wans resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_wans resource.
    - name: VirtualWANName
      value: string
      description: Required parameter for the virtual_wans resource.
    - name: properties
      value: object
      description: |
        Properties of the virtual WAN.

DELETE examples

delete

Deletes a VirtualWAN.

DELETE FROM azure.network.virtual_wans
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND VirtualWANName = '{{ VirtualWANName }}' --required
;

Lifecycle Methods

update_tags

Updates a VirtualWAN tags.

EXEC azure.network.virtual_wans.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@VirtualWANName='{{ VirtualWANName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;