network_fabrics

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

Overview

Name	network_fabrics
Type	Resource
Id	azure.managed_network_fabric.network_fabrics

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 Network Fabrics 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 NetworkFabrics 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, networkFabricName		Get Network Fabric resource details.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all the Network Fabric resources in the given resource group.
list_by_subscription	select	subscriptionId		List all the Network Fabric resources in the given subscription.
create	insert	subscriptionId, resourceGroupName, networkFabricName, data__properties		Create Network Fabric resource.
update	update	subscriptionId, resourceGroupName, networkFabricName		Update certain properties of the Network Fabric resource.
delete	delete	subscriptionId, resourceGroupName, networkFabricName		Delete Network Fabric resource.
provision	exec	subscriptionId, resourceGroupName, networkFabricName		Provisions the underlying resources in the given Network Fabric instance.
deprovision	exec	subscriptionId, resourceGroupName, networkFabricName		Deprovisions the underlying resources in the given Network Fabric instance.
upgrade	exec	subscriptionId, resourceGroupName, networkFabricName		Upgrades the version of the underlying resources in the given Network Fabric instance.
refresh_configuration	exec	subscriptionId, resourceGroupName, networkFabricName		Refreshes the configuration of the underlying resources in the given Network Fabric instance.
validate_configuration	exec	subscriptionId, resourceGroupName, networkFabricName		Validates the configuration of the underlying resources in the given Network Fabric instance.
commit_configuration	exec	subscriptionId, resourceGroupName, networkFabricName		Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.

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
networkFabricName	string	Name of the Network Fabric.
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

Get Network Fabric resource details.

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

list_by_resource_group

List all the Network Fabric resources in the given resource group.

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

list_by_subscription

List all the Network Fabric resources in the given subscription.

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

INSERT examples

create

Create Network Fabric resource.

INSERT INTO azure.managed_network_fabric.network_fabrics (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
networkFabricName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkFabricName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_fabrics
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the network_fabrics resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_fabrics resource.
    - name: networkFabricName
      value: string
      description: Required parameter for the network_fabrics 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

Update certain properties of the Network Fabric resource.

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

DELETE examples

delete

Delete Network Fabric resource.

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

Lifecycle Methods

provision

Provisions the underlying resources in the given Network Fabric instance.

EXEC azure.managed_network_fabric.network_fabrics.provision 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFabricName='{{ networkFabricName }}' --required
;

deprovision

Deprovisions the underlying resources in the given Network Fabric instance.

EXEC azure.managed_network_fabric.network_fabrics.deprovision 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFabricName='{{ networkFabricName }}' --required
;

upgrade

Upgrades the version of the underlying resources in the given Network Fabric instance.

EXEC azure.managed_network_fabric.network_fabrics.upgrade 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFabricName='{{ networkFabricName }}' --required 
@@json=
'{
"action": "{{ action }}", 
"version": "{{ version }}"
}'
;

refresh_configuration

Refreshes the configuration of the underlying resources in the given Network Fabric instance.

EXEC azure.managed_network_fabric.network_fabrics.refresh_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFabricName='{{ networkFabricName }}' --required
;

validate_configuration

Validates the configuration of the underlying resources in the given Network Fabric instance.

EXEC azure.managed_network_fabric.network_fabrics.validate_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFabricName='{{ networkFabricName }}' --required 
@@json=
'{
"validateAction": "{{ validateAction }}"
}'
;

commit_configuration

Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.

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