subnets

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

Overview

Name	subnets
Type	Resource
Id	azure.network.subnets

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting Subnet resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the subnet.
type	string	Resource type.

list

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

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the subnet.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, virtualNetworkName, subnetName, subscriptionId	$expand	Gets the specified subnet by virtual network and resource group.
list	select	resourceGroupName, virtualNetworkName, subscriptionId		Gets all subnets in a virtual network.
create_or_update	insert	resourceGroupName, virtualNetworkName, subnetName, subscriptionId		Creates or updates a subnet in the specified virtual network.
delete	delete	resourceGroupName, virtualNetworkName, subnetName, subscriptionId		Deletes the specified subnet.
prepare_network_policies	exec	resourceGroupName, virtualNetworkName, subnetName, subscriptionId		Prepares a subnet by applying network intent policies.
unprepare_network_policies	exec	resourceGroupName, virtualNetworkName, subnetName, subscriptionId		Unprepares a subnet by removing network intent policies.

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
resourceGroupName	string	The name of the resource group.
subnetName	string	The name of the subnet.
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 subnet by virtual network and resource group.

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

list

Gets all subnets in a virtual network.

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

INSERT examples

create_or_update

Creates or updates a subnet in the specified virtual network.

INSERT INTO azure.network.subnets (
data__properties,
data__name,
data__type,
data__id,
resourceGroupName,
virtualNetworkName,
subnetName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ type }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ virtualNetworkName }}',
'{{ subnetName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: subnets
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the subnets resource.
    - name: virtualNetworkName
      value: string
      description: Required parameter for the subnets resource.
    - name: subnetName
      value: string
      description: Required parameter for the subnets resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the subnets resource.
    - name: properties
      value: object
      description: |
        Properties of the subnet.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: type
      value: string
      description: |
        Resource type.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified subnet.

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

Lifecycle Methods

prepare_network_policies

Prepares a subnet by applying network intent policies.

EXEC azure.network.subnets.prepare_network_policies 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkName='{{ virtualNetworkName }}' --required, 
@subnetName='{{ subnetName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"serviceName": "{{ serviceName }}", 
"networkIntentPolicyConfigurations": "{{ networkIntentPolicyConfigurations }}"
}'
;

unprepare_network_policies

Unprepares a subnet by removing network intent policies.

EXEC azure.network.subnets.unprepare_network_policies 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@virtualNetworkName='{{ virtualNetworkName }}' --required, 
@subnetName='{{ subnetName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"serviceName": "{{ serviceName }}"
}'
;