l3_isolation_domains

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

Overview

Name	l3_isolation_domains
Type	Resource
Id	azure.managed_network_fabric.l3_isolation_domains

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

Lists all L3IsolationDomains under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_subscription

Lists all L3IsolationDomains under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, l3IsolationDomainName		Retrieves details of this L3 Isolation Domain.
list_by_resource_group	select	subscriptionId, resourceGroupName		Displays L3IsolationDomains list by resource group GET method.
list_by_subscription	select	subscriptionId		Displays L3IsolationDomains list by subscription GET method.
create	insert	subscriptionId, resourceGroupName, l3IsolationDomainName, data__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	subscriptionId, resourceGroupName, l3IsolationDomainName		API to update certain properties of the L3 Isolation Domain resource.
delete	delete	subscriptionId, resourceGroupName, l3IsolationDomainName		Deletes layer 3 connectivity between compute nodes by managed by named L3 Isolation name.
update_administrative_state	exec	subscriptionId, resourceGroupName, l3IsolationDomainName		Enables racks for this Isolation Domain.
validate_configuration	exec	subscriptionId, resourceGroupName, l3IsolationDomainName		Validates the configuration of the resources.
commit_configuration	exec	subscriptionId, resourceGroupName, l3IsolationDomainName		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
l3IsolationDomainName	string	Name of the L3 Isolation Domain.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Retrieves details of this L3 Isolation Domain.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.l3_isolation_domains
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND l3IsolationDomainName = '{{ l3IsolationDomainName }}' -- required
;

list_by_resource_group

Displays L3IsolationDomains list by resource group GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.l3_isolation_domains
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Displays L3IsolationDomains list by subscription GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.l3_isolation_domains
WHERE subscriptionId = '{{ subscriptionId }}' -- 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.managed_network_fabric.l3_isolation_domains (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
l3IsolationDomainName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ l3IsolationDomainName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: l3_isolation_domains
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the l3_isolation_domains resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the l3_isolation_domains resource.
    - name: l3IsolationDomainName
      value: string
      description: Required parameter for the l3_isolation_domains resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

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

UPDATE azure.managed_network_fabric.l3_isolation_domains
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND l3IsolationDomainName = '{{ l3IsolationDomainName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

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

DELETE FROM azure.managed_network_fabric.l3_isolation_domains
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND l3IsolationDomainName = '{{ l3IsolationDomainName }}' --required
;

Lifecycle Methods

update_administrative_state

Enables racks for this Isolation Domain.

EXEC azure.managed_network_fabric.l3_isolation_domains.update_administrative_state 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@l3IsolationDomainName='{{ l3IsolationDomainName }}' --required 
@@json=
'{
"state": "{{ state }}", 
"resourceIds": "{{ resourceIds }}"
}'
;

validate_configuration

Validates the configuration of the resources.

EXEC azure.managed_network_fabric.l3_isolation_domains.validate_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@l3IsolationDomainName='{{ l3IsolationDomainName }}' --required
;

commit_configuration

Commits the configuration of the given resources.

EXEC azure.managed_network_fabric.l3_isolation_domains.commit_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@l3IsolationDomainName='{{ l3IsolationDomainName }}' --required
;