virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure.network.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting VirtualNetwork resource.

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.
extendedLocation	object	The extended location of the virtual network.
properties	object	Properties of the virtual network.
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. The operation returns a list of VirtualNetwork resources.

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.
extendedLocation	object	The extended location of the virtual network.
properties	object	Properties of the virtual network.
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_all

Request successful. The operation returns a list of VirtualNetwork resources.

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.
extendedLocation	object	The extended location of the virtual network.
properties	object	Properties of the virtual network.
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, virtualNetworkName, subscriptionId	$expand	Gets the specified virtual network by resource group.
list	select	resourceGroupName, subscriptionId		Gets all virtual networks in a resource group.
list_all	select	subscriptionId		Gets all virtual networks in a subscription.
create_or_update	insert	resourceGroupName, virtualNetworkName, subscriptionId		Creates or updates a virtual network in the specified resource group.
delete	delete	resourceGroupName, virtualNetworkName, subscriptionId		Deletes the specified virtual network.
update_tags	exec	resourceGroupName, virtualNetworkName, subscriptionId		Updates a virtual network tags.
check_ip_address_availability	exec	resourceGroupName, virtualNetworkName, ipAddress, subscriptionId		Checks whether a private IP address is available for use.

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
ipAddress	string	The private IP address to be verified.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualNetworkName	string	The name of the virtual network.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified virtual network by resource group.

SELECT
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
FROM azure.network.virtual_networks
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualNetworkName = '{{ virtualNetworkName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all virtual networks in a resource group.

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

list_all

Gets all virtual networks in a subscription.

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

INSERT examples

create_or_update

Creates or updates a virtual network in the specified resource group.

INSERT INTO azure.network.virtual_networks (
data__extendedLocation,
data__properties,
resourceGroupName,
virtualNetworkName,
subscriptionId
)
SELECT 
'{{ extendedLocation }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ virtualNetworkName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
extendedLocation,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_networks
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_networks resource.
    - name: virtualNetworkName
      value: string
      description: Required parameter for the virtual_networks resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_networks resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the virtual network.
    - name: properties
      value: object
      description: |
        Properties of the virtual network.

DELETE examples

delete

Deletes the specified virtual network.

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

Lifecycle Methods

update_tags

Updates a virtual network tags.

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

check_ip_address_availability

Checks whether a private IP address is available for use.

EXEC azure.network.virtual_networks.check_ip_address_availability 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkName='{{ virtualNetworkName }}' --required, 
@ipAddress='{{ ipAddress }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;