l3_networks

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

Overview

Name	l3_networks
Type	Resource
Id	azure_extras.network_cloud.l3_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associatedResourceIds	array	The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId	string	The resource ID of the Network Cloud cluster this L3 network is associated with.
detailedStatus	string	The more detailed status of the L3 network. Known values are: "Error", "Available", and "Provisioning". (Error, Available, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
hybridAksClustersAssociatedIds	array	Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network.
hybridAksIpamEnabled	string	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. Known values are: "True" and "False". (True, False)
hybridAksPluginType	string	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS. Known values are: "DPDK", "SRIOV", and "OSDevice". (DPDK, SRIOV, OSDevice)
interfaceName	string	The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
ipAllocationType	string	The type of the IP address allocation, defaulted to "DualStack". Known values are: "IPV4", "IPV6", and "DualStack". (IPV4, IPV6, DualStack)
ipv4ConnectedPrefix	string	The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
ipv6ConnectedPrefix	string	The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
l3IsolationDomainId	string	The resource ID of the Network Fabric l3IsolationDomain. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the L3 network. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachinesAssociatedIds	array	Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
vlan	integer	The VLAN from the l3IsolationDomain that is used for this network. Required.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associatedResourceIds	array	The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId	string	The resource ID of the Network Cloud cluster this L3 network is associated with.
detailedStatus	string	The more detailed status of the L3 network. Known values are: "Error", "Available", and "Provisioning". (Error, Available, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
hybridAksClustersAssociatedIds	array	Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network.
hybridAksIpamEnabled	string	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. Known values are: "True" and "False". (True, False)
hybridAksPluginType	string	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS. Known values are: "DPDK", "SRIOV", and "OSDevice". (DPDK, SRIOV, OSDevice)
interfaceName	string	The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
ipAllocationType	string	The type of the IP address allocation, defaulted to "DualStack". Known values are: "IPV4", "IPV6", and "DualStack". (IPV4, IPV6, DualStack)
ipv4ConnectedPrefix	string	The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
ipv6ConnectedPrefix	string	The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
l3IsolationDomainId	string	The resource ID of the Network Fabric l3IsolationDomain. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the L3 network. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachinesAssociatedIds	array	Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
vlan	integer	The VLAN from the l3IsolationDomain that is used for this network. Required.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
associatedResourceIds	array	The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId	string	The resource ID of the Network Cloud cluster this L3 network is associated with.
detailedStatus	string	The more detailed status of the L3 network. Known values are: "Error", "Available", and "Provisioning". (Error, Available, Provisioning)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
hybridAksClustersAssociatedIds	array	Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network.
hybridAksIpamEnabled	string	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster. Known values are: "True" and "False". (True, False)
hybridAksPluginType	string	Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS. Known values are: "DPDK", "SRIOV", and "OSDevice". (DPDK, SRIOV, OSDevice)
interfaceName	string	The default interface name for this L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
ipAllocationType	string	The type of the IP address allocation, defaulted to "DualStack". Known values are: "IPV4", "IPV6", and "DualStack". (IPV4, IPV6, DualStack)
ipv4ConnectedPrefix	string	The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
ipv6ConnectedPrefix	string	The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
l3IsolationDomainId	string	The resource ID of the Network Fabric l3IsolationDomain. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the L3 network. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachinesAssociatedIds	array	Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
vlan	integer	The VLAN from the l3IsolationDomain that is used for this network. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, l3_network_name, subscription_id		Get properties of the provided layer 3 (L3) network.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of layer 3 (L3) networks in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of layer 3 (L3) networks in the provided subscription.
create_or_update	insert	resource_group_name, l3_network_name, subscription_id, location, properties, extendedLocation		Create a new layer 3 (L3) network or update the properties of the existing network.
update	update	resource_group_name, l3_network_name, subscription_id		Update tags associated with the provided layer 3 (L3) network.
create_or_update	replace	resource_group_name, l3_network_name, subscription_id, location, properties, extendedLocation		Create a new layer 3 (L3) network or update the properties of the existing network.
delete	delete	resource_group_name, l3_network_name, subscription_id		Delete the provided layer 3 (L3) network.

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
l3_network_name	string	The name of the L3 network. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. 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 properties of the provided layer 3 (L3) network.

SELECT
id,
name,
associatedResourceIds,
clusterId,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
hybridAksClustersAssociatedIds,
hybridAksIpamEnabled,
hybridAksPluginType,
interfaceName,
ipAllocationType,
ipv4ConnectedPrefix,
ipv6ConnectedPrefix,
l3IsolationDomainId,
location,
provisioningState,
systemData,
tags,
type,
virtualMachinesAssociatedIds,
vlan
FROM azure_extras.network_cloud.l3_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND l3_network_name = '{{ l3_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get a list of layer 3 (L3) networks in the provided resource group.

SELECT
id,
name,
associatedResourceIds,
clusterId,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
hybridAksClustersAssociatedIds,
hybridAksIpamEnabled,
hybridAksPluginType,
interfaceName,
ipAllocationType,
ipv4ConnectedPrefix,
ipv6ConnectedPrefix,
l3IsolationDomainId,
location,
provisioningState,
systemData,
tags,
type,
virtualMachinesAssociatedIds,
vlan
FROM azure_extras.network_cloud.l3_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of layer 3 (L3) networks in the provided subscription.

SELECT
id,
name,
associatedResourceIds,
clusterId,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
hybridAksClustersAssociatedIds,
hybridAksIpamEnabled,
hybridAksPluginType,
interfaceName,
ipAllocationType,
ipv4ConnectedPrefix,
ipv6ConnectedPrefix,
l3IsolationDomainId,
location,
provisioningState,
systemData,
tags,
type,
virtualMachinesAssociatedIds,
vlan
FROM azure_extras.network_cloud.l3_networks
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a new layer 3 (L3) network or update the properties of the existing network.

INSERT INTO azure_extras.network_cloud.l3_networks (
tags,
location,
properties,
extendedLocation,
resource_group_name,
l3_network_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ l3_network_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: l3_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the l3_networks resource.
  - name: l3_network_name
    value: "{{ l3_network_name }}"
    description: Required parameter for the l3_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the l3_networks resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties. Required.
    value:
      hybridAksIpamEnabled: "{{ hybridAksIpamEnabled }}"
      hybridAksPluginType: "{{ hybridAksPluginType }}"
      interfaceName: "{{ interfaceName }}"
      ipAllocationType: "{{ ipAllocationType }}"
      ipv4ConnectedPrefix: "{{ ipv4ConnectedPrefix }}"
      ipv6ConnectedPrefix: "{{ ipv6ConnectedPrefix }}"
      l3IsolationDomainId: "{{ l3IsolationDomainId }}"
      vlan: {{ vlan }}
      associatedResourceIds:
        - "{{ associatedResourceIds }}"
      clusterId: "{{ clusterId }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      hybridAksClustersAssociatedIds:
        - "{{ hybridAksClustersAssociatedIds }}"
      virtualMachinesAssociatedIds:
        - "{{ virtualMachinesAssociatedIds }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Update tags associated with the provided layer 3 (L3) network.

UPDATE azure_extras.network_cloud.l3_networks
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND l3_network_name = '{{ l3_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new layer 3 (L3) network or update the properties of the existing network.

REPLACE azure_extras.network_cloud.l3_networks
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND l3_network_name = '{{ l3_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided layer 3 (L3) network.

DELETE FROM azure_extras.network_cloud.l3_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND l3_network_name = '{{ l3_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;