l3_isolation_domains

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

Overview

Name	l3_isolation_domains
Type	Resource
Id	azure_extras.managed_network_fabric.l3_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)
aggregateRouteConfiguration	object	Aggregate route configurations.
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)
connectedSubnetRoutePolicy	object	Connected Subnet RoutePolicy.
exportPolicyConfiguration	object	BMP Export Policy configuration.
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.
networkFabricId	string	ARM Resource ID of the Network Fabric. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
redistributeConnectedSubnets	string	Advertise Connected Subnets. Ex: "True" | "False". Known values are: "True" and "False". (True, False)
redistributeStaticRoutes	string	Advertise Static Routes. Ex: "True" | "False". Known values are: "True" and "False". (True, False)
staticRouteRoutePolicy	object	Static Route - route policy.
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".
uniqueRdConfiguration	object	Unique Route Distinguisher configuration.
v4routePrefixLimit	object	IPv4 VRF Limit configuration.
v6routePrefixLimit	object	IPv6 VRF Limit configuration.

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)
aggregateRouteConfiguration	object	Aggregate route configurations.
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)
connectedSubnetRoutePolicy	object	Connected Subnet RoutePolicy.
exportPolicyConfiguration	object	BMP Export Policy configuration.
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.
networkFabricId	string	ARM Resource ID of the Network Fabric. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
redistributeConnectedSubnets	string	Advertise Connected Subnets. Ex: "True" | "False". Known values are: "True" and "False". (True, False)
redistributeStaticRoutes	string	Advertise Static Routes. Ex: "True" | "False". Known values are: "True" and "False". (True, False)
staticRouteRoutePolicy	object	Static Route - route policy.
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".
uniqueRdConfiguration	object	Unique Route Distinguisher configuration.
v4routePrefixLimit	object	IPv4 VRF Limit configuration.
v6routePrefixLimit	object	IPv6 VRF Limit configuration.

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)
aggregateRouteConfiguration	object	Aggregate route configurations.
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)
connectedSubnetRoutePolicy	object	Connected Subnet RoutePolicy.
exportPolicyConfiguration	object	BMP Export Policy configuration.
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.
networkFabricId	string	ARM Resource ID of the Network Fabric. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
redistributeConnectedSubnets	string	Advertise Connected Subnets. Ex: "True" | "False". Known values are: "True" and "False". (True, False)
redistributeStaticRoutes	string	Advertise Static Routes. Ex: "True" | "False". Known values are: "True" and "False". (True, False)
staticRouteRoutePolicy	object	Static Route - route policy.
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".
uniqueRdConfiguration	object	Unique Route Distinguisher configuration.
v4routePrefixLimit	object	IPv4 VRF Limit configuration.
v6routePrefixLimit	object	IPv6 VRF Limit configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, l3_isolation_domain_name, subscription_id		Retrieves details of this L3 Isolation Domain.
list_by_resource_group	select	resource_group_name, subscription_id		Displays L3IsolationDomains list by resource group GET method.
list_by_subscription	select	subscription_id		Displays L3IsolationDomains list by subscription GET method.
create	insert	resource_group_name, l3_isolation_domain_name, subscription_id, location, properties		Create isolation domain resources for layer 3 connectivity between compute nodes and for communication with external services .This configuration is applied on the devices only after the creation of networks is completed and isolation domain is enabled.
update	update	resource_group_name, l3_isolation_domain_name, subscription_id		API to update certain properties of the L3 Isolation Domain resource.
delete	delete	resource_group_name, l3_isolation_domain_name, subscription_id		Deletes layer 3 connectivity between compute nodes by managed by named L3 Isolation name.
update_administrative_state	exec	resource_group_name, l3_isolation_domain_name, subscription_id		Updates the administrative state of the L3 Isolation Domain resource.
validate_configuration	exec	resource_group_name, l3_isolation_domain_name, subscription_id		Validates the configuration of the resources.
commit_configuration	exec	resource_group_name, l3_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
l3_isolation_domain_name	string	Name of the L3 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

Retrieves details of this L3 Isolation Domain.

SELECT
id,
name,
administrativeState,
aggregateRouteConfiguration,
annotation,
configurationState,
connectedSubnetRoutePolicy,
exportPolicyConfiguration,
identity,
lastOperation,
location,
networkFabricId,
provisioningState,
redistributeConnectedSubnets,
redistributeStaticRoutes,
staticRouteRoutePolicy,
systemData,
tags,
type,
uniqueRdConfiguration,
v4routePrefixLimit,
v6routePrefixLimit
FROM azure_extras.managed_network_fabric.l3_isolation_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND l3_isolation_domain_name = '{{ l3_isolation_domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Displays L3IsolationDomains list by resource group GET method.

SELECT
id,
name,
administrativeState,
aggregateRouteConfiguration,
annotation,
configurationState,
connectedSubnetRoutePolicy,
exportPolicyConfiguration,
identity,
lastOperation,
location,
networkFabricId,
provisioningState,
redistributeConnectedSubnets,
redistributeStaticRoutes,
staticRouteRoutePolicy,
systemData,
tags,
type,
uniqueRdConfiguration,
v4routePrefixLimit,
v6routePrefixLimit
FROM azure_extras.managed_network_fabric.l3_isolation_domains
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Displays L3IsolationDomains list by subscription GET method.

SELECT
id,
name,
administrativeState,
aggregateRouteConfiguration,
annotation,
configurationState,
connectedSubnetRoutePolicy,
exportPolicyConfiguration,
identity,
lastOperation,
location,
networkFabricId,
provisioningState,
redistributeConnectedSubnets,
redistributeStaticRoutes,
staticRouteRoutePolicy,
systemData,
tags,
type,
uniqueRdConfiguration,
v4routePrefixLimit,
v6routePrefixLimit
FROM azure_extras.managed_network_fabric.l3_isolation_domains
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create isolation domain resources for layer 3 connectivity between compute nodes and for communication with external services .This configuration is applied on the devices only after the creation of networks is completed and isolation domain is enabled.

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

Manifest

# Description fields are for documentation purposes
- name: l3_isolation_domains
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the l3_isolation_domains resource.
  - name: l3_isolation_domain_name
    value: "{{ l3_isolation_domain_name }}"
    description: Required parameter for the l3_isolation_domains resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the l3_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 L3 Isolation Domain Properties. Required.
    value:
      annotation: "{{ annotation }}"
      redistributeConnectedSubnets: "{{ redistributeConnectedSubnets }}"
      redistributeStaticRoutes: "{{ redistributeStaticRoutes }}"
      aggregateRouteConfiguration:
        ipv4Routes:
          - prefix: "{{ prefix }}"
        ipv6Routes:
          - prefix: "{{ prefix }}"
      connectedSubnetRoutePolicy:
        exportRoutePolicy:
          exportIpv4RoutePolicyId: "{{ exportIpv4RoutePolicyId }}"
          exportIpv6RoutePolicyId: "{{ exportIpv6RoutePolicyId }}"
      networkFabricId: "{{ networkFabricId }}"
      staticRouteRoutePolicy:
        exportRoutePolicy:
          exportIpv4RoutePolicyId: "{{ exportIpv4RoutePolicyId }}"
          exportIpv6RoutePolicyId: "{{ exportIpv6RoutePolicyId }}"
      uniqueRdConfiguration:
        uniqueRds:
          - "{{ uniqueRds }}"
      v4routePrefixLimit:
        hardLimit: {{ hardLimit }}
        threshold: {{ threshold }}
      v6routePrefixLimit:
        hardLimit: {{ hardLimit }}
        threshold: {{ threshold }}
      lastOperation:
        details: "{{ details }}"
      exportPolicyConfiguration:
        exportPolicies:
          - "{{ exportPolicies }}"
      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 L3 Isolation Domain resource.

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

DELETE examples

delete

Deletes layer 3 connectivity between compute nodes by managed by named L3 Isolation name.

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

Lifecycle Methods

update_administrative_state

Updates the administrative state of the L3 Isolation Domain resource.

EXEC azure_extras.managed_network_fabric.l3_isolation_domains.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_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.l3_isolation_domains.validate_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@l3_isolation_domain_name='{{ l3_isolation_domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

commit_configuration

Commits the configuration of the given resources.

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