virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure.dev_test_labs.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
allowedSubnets	array	The allowed subnets of the virtual network.
createdDate	string (date-time)	The creation date of the virtual network.
description	string	The description of the virtual network.
externalProviderResourceId	string	The Microsoft.Network resource identifier of the virtual network.
externalSubnets	array	The external subnet properties.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
subnetOverrides	array	The subnet overrides of the virtual network.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
allowedSubnets	array	The allowed subnets of the virtual network.
createdDate	string (date-time)	The creation date of the virtual network.
description	string	The description of the virtual network.
externalProviderResourceId	string	The Microsoft.Network resource identifier of the virtual network.
externalSubnets	array	The external subnet properties.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
subnetOverrides	array	The subnet overrides of the virtual network.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, name, subscription_id	$expand	Get virtual network.
list	select	resource_group_name, lab_name, subscription_id	$expand, $filter, $top, $orderby	List virtual networks in a given lab.
create_or_update	insert	resource_group_name, lab_name, name, subscription_id		Create or replace an existing virtual network. This operation can take a while to complete.
update	update	resource_group_name, lab_name, name, subscription_id		Allows modifying tags of virtual networks. All other properties will be ignored.
create_or_update	replace	resource_group_name, lab_name, name, subscription_id		Create or replace an existing virtual network. This operation can take a while to complete.
delete	delete	resource_group_name, lab_name, name, subscription_id		Delete virtual network. This operation can take a while to complete.

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
lab_name	string	The name of the lab. Required.
name	string	The name of the virtual network. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($expand=externalSubnets)'. Default value is None.
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get virtual network.

SELECT
id,
name,
allowedSubnets,
createdDate,
description,
externalProviderResourceId,
externalSubnets,
location,
provisioningState,
subnetOverrides,
tags,
type,
uniqueIdentifier
FROM azure.dev_test_labs.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List virtual networks in a given lab.

SELECT
id,
name,
allowedSubnets,
createdDate,
description,
externalProviderResourceId,
externalSubnets,
location,
provisioningState,
subnetOverrides,
tags,
type,
uniqueIdentifier
FROM azure.dev_test_labs.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or replace an existing virtual network. This operation can take a while to complete.

INSERT INTO azure.dev_test_labs.virtual_networks (
location,
tags,
properties,
resource_group_name,
lab_name,
name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_networks resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the virtual_networks resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the virtual_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_networks resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: properties
    value:
      allowedSubnets:
        - resourceId: "{{ resourceId }}"
          labSubnetName: "{{ labSubnetName }}"
          allowPublicIp: "{{ allowPublicIp }}"
      description: "{{ description }}"
      externalProviderResourceId: "{{ externalProviderResourceId }}"
      subnetOverrides:
        - resourceId: "{{ resourceId }}"
          labSubnetName: "{{ labSubnetName }}"
          useInVmCreationPermission: "{{ useInVmCreationPermission }}"
          usePublicIpAddressPermission: "{{ usePublicIpAddressPermission }}"
          sharedPublicIpAddressConfiguration:
            allowedPorts:
              - transportProtocol: "{{ transportProtocol }}"
                backendPort: {{ backendPort }}
          virtualNetworkPoolName: "{{ virtualNetworkPoolName }}"

UPDATE examples

update

Allows modifying tags of virtual networks. All other properties will be ignored.

UPDATE azure.dev_test_labs.virtual_networks
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or replace an existing virtual network. This operation can take a while to complete.

REPLACE azure.dev_test_labs.virtual_networks
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete virtual network. This operation can take a while to complete.

DELETE FROM azure.dev_test_labs.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;