l2_isolation_domains

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

Overview

Name	l2_isolation_domains
Type	Resource
Id	azure_extras.managed_network_fabric.l2_isolation_domains

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.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
extendedVlan	string	Extended VLAN status, default value is Disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
identity	object	The managed service identities assigned to this resource.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
mtu	integer	Maximum transmission unit. Default value is 1500.
networkFabricId	string	ARM Resource ID of the Network Fabric. Required.
networkToNetworkInterconnectId	string	ARM Resource ID of the networkToNetworkInterconnectId of the L2 ISD resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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".
vlanId	integer	Vlan Identifier of the Network Fabric. Example: 501. 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.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
extendedVlan	string	Extended VLAN status, default value is Disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
identity	object	The managed service identities assigned to this resource.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
mtu	integer	Maximum transmission unit. Default value is 1500.
networkFabricId	string	ARM Resource ID of the Network Fabric. Required.
networkToNetworkInterconnectId	string	ARM Resource ID of the networkToNetworkInterconnectId of the L2 ISD resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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".
vlanId	integer	Vlan Identifier of the Network Fabric. Example: 501. 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.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
extendedVlan	string	Extended VLAN status, default value is Disabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
identity	object	The managed service identities assigned to this resource.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
mtu	integer	Maximum transmission unit. Default value is 1500.
networkFabricId	string	ARM Resource ID of the Network Fabric. Required.
networkToNetworkInterconnectId	string	ARM Resource ID of the networkToNetworkInterconnectId of the L2 ISD resource.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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".
vlanId	integer	Vlan Identifier of the Network Fabric. Example: 501. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, l2_isolation_domain_name, subscription_id		Implements L2 Isolation Domain GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Displays L2IsolationDomains list by resource group GET method.
list_by_subscription	select	subscription_id		Displays L2IsolationDomains list by subscription GET method.
create	insert	resource_group_name, l2_isolation_domain_name, subscription_id, location, properties		Creates layer 2 network connectivity between compute nodes within a rack and across racks.The configuration is applied on the devices only after the isolation domain is enabled.
update	update	resource_group_name, l2_isolation_domain_name, subscription_id		API to update certain properties of the L2 Isolation Domain resource.
delete	delete	resource_group_name, l2_isolation_domain_name, subscription_id		Deletes layer 2 connectivity between compute nodes by managed by named L2 Isolation name.
update_administrative_state	exec	resource_group_name, l2_isolation_domain_name, subscription_id		Enables isolation domain across the fabric or on specified racks.
validate_configuration	exec	resource_group_name, l2_isolation_domain_name, subscription_id		Validates the configuration of the resources.
commit_configuration	exec	resource_group_name, l2_isolation_domain_name, subscription_id		Commits the configuration of the given resources.

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
l2_isolation_domain_name	string	Name of the L2 Isolation Domain. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Implements L2 Isolation Domain GET method.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
extendedVlan,
identity,
lastOperation,
location,
mtu,
networkFabricId,
networkToNetworkInterconnectId,
provisioningState,
systemData,
tags,
type,
vlanId
FROM azure_extras.managed_network_fabric.l2_isolation_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND l2_isolation_domain_name = '{{ l2_isolation_domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Displays L2IsolationDomains list by resource group GET method.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
extendedVlan,
identity,
lastOperation,
location,
mtu,
networkFabricId,
networkToNetworkInterconnectId,
provisioningState,
systemData,
tags,
type,
vlanId
FROM azure_extras.managed_network_fabric.l2_isolation_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Displays L2IsolationDomains list by subscription GET method.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
extendedVlan,
identity,
lastOperation,
location,
mtu,
networkFabricId,
networkToNetworkInterconnectId,
provisioningState,
systemData,
tags,
type,
vlanId
FROM azure_extras.managed_network_fabric.l2_isolation_domains
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates layer 2 network connectivity between compute nodes within a rack and across racks.The configuration is applied on the devices only after the isolation domain is enabled.

INSERT INTO azure_extras.managed_network_fabric.l2_isolation_domains (
tags,
location,
properties,
identity,
resource_group_name,
l2_isolation_domain_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ resource_group_name }}',
'{{ l2_isolation_domain_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: l2_isolation_domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the l2_isolation_domains resource.
  - name: l2_isolation_domain_name
    value: "{{ l2_isolation_domain_name }}"
    description: Required parameter for the l2_isolation_domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the l2_isolation_domains 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 L2IsolationDomain properties. Required.
    value:
      annotation: "{{ annotation }}"
      networkFabricId: "{{ networkFabricId }}"
      vlanId: {{ vlanId }}
      mtu: {{ mtu }}
      extendedVlan: "{{ extendedVlan }}"
      networkToNetworkInterconnectId: "{{ networkToNetworkInterconnectId }}"
      lastOperation:
        details: "{{ details }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

API to update certain properties of the L2 Isolation Domain resource.

UPDATE azure_extras.managed_network_fabric.l2_isolation_domains
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND l2_isolation_domain_name = '{{ l2_isolation_domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes layer 2 connectivity between compute nodes by managed by named L2 Isolation name.

DELETE FROM azure_extras.managed_network_fabric.l2_isolation_domains
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND l2_isolation_domain_name = '{{ l2_isolation_domain_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_administrative_state

Enables isolation domain across the fabric or on specified racks.

EXEC azure_extras.managed_network_fabric.l2_isolation_domains.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l2_isolation_domain_name='{{ l2_isolation_domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

validate_configuration

Validates the configuration of the resources.

EXEC azure_extras.managed_network_fabric.l2_isolation_domains.validate_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@l2_isolation_domain_name='{{ l2_isolation_domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

commit_configuration

Commits the configuration of the given resources.

EXEC azure_extras.managed_network_fabric.l2_isolation_domains.commit_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@l2_isolation_domain_name='{{ l2_isolation_domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;