network_fabric_controllers

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

Overview

Name	network_fabric_controllers
Type	Resource
Id	azure_extras.managed_network_fabric.network_fabric_controllers

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.
annotation	string	Switch configuration description.
identity	object	The managed service identities assigned to this resource.
infrastructureExpressRouteConnections	array	As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute).
infrastructureServices	object	InfrastructureServices IP ranges.
ipv4AddressSpace	string	IPv4 Network Fabric Controller Address Space.
ipv6AddressSpace	string	IPv6 Network Fabric Controller Address Space.
isWorkloadManagementNetworkEnabled	string	A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. Known values are: "True" and "False". (True, False)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed Resource Group configuration properties.
networkFabricIds	array	The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service.
nfcSku	string	Network Fabric Controller SKU. Known values are: "Basic", "Standard", and "HighPerformance". (Basic, Standard, HighPerformance)
provisioningState	string	Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. 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.
tenantInternetGatewayIds	array	List of tenant InternetGateway resource IDs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadExpressRouteConnections	array	As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).
workloadServices	object	WorkloadServices IP ranges.

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.
annotation	string	Switch configuration description.
identity	object	The managed service identities assigned to this resource.
infrastructureExpressRouteConnections	array	As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute).
infrastructureServices	object	InfrastructureServices IP ranges.
ipv4AddressSpace	string	IPv4 Network Fabric Controller Address Space.
ipv6AddressSpace	string	IPv6 Network Fabric Controller Address Space.
isWorkloadManagementNetworkEnabled	string	A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. Known values are: "True" and "False". (True, False)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed Resource Group configuration properties.
networkFabricIds	array	The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service.
nfcSku	string	Network Fabric Controller SKU. Known values are: "Basic", "Standard", and "HighPerformance". (Basic, Standard, HighPerformance)
provisioningState	string	Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. 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.
tenantInternetGatewayIds	array	List of tenant InternetGateway resource IDs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadExpressRouteConnections	array	As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).
workloadServices	object	WorkloadServices IP ranges.

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.
annotation	string	Switch configuration description.
identity	object	The managed service identities assigned to this resource.
infrastructureExpressRouteConnections	array	As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute).
infrastructureServices	object	InfrastructureServices IP ranges.
ipv4AddressSpace	string	IPv4 Network Fabric Controller Address Space.
ipv6AddressSpace	string	IPv6 Network Fabric Controller Address Space.
isWorkloadManagementNetworkEnabled	string	A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. Known values are: "True" and "False". (True, False)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed Resource Group configuration properties.
networkFabricIds	array	The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service.
nfcSku	string	Network Fabric Controller SKU. Known values are: "Basic", "Standard", and "HighPerformance". (Basic, Standard, HighPerformance)
provisioningState	string	Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. 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.
tenantInternetGatewayIds	array	List of tenant InternetGateway resource IDs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadExpressRouteConnections	array	As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).
workloadServices	object	WorkloadServices IP ranges.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_fabric_controller_name, subscription_id		Shows the provisioning status of Network Fabric Controller.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the NetworkFabricControllers thats available in the resource group.
list_by_subscription	select	subscription_id		Lists all the NetworkFabricControllers by subscription.
create	insert	resource_group_name, network_fabric_controller_name, subscription_id, location, properties		Creates a Network Fabric Controller.
update	update	resource_group_name, network_fabric_controller_name, subscription_id		Updates are currently not supported for the Network Fabric Controller resource.
delete	delete	resource_group_name, network_fabric_controller_name, subscription_id		Deletes the Network Fabric Controller resource.

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
network_fabric_controller_name	string	Name of the Network Fabric Controller. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Shows the provisioning status of Network Fabric Controller.

SELECT
id,
name,
annotation,
identity,
infrastructureExpressRouteConnections,
infrastructureServices,
ipv4AddressSpace,
ipv6AddressSpace,
isWorkloadManagementNetworkEnabled,
lastOperation,
location,
managedResourceGroupConfiguration,
networkFabricIds,
nfcSku,
provisioningState,
systemData,
tags,
tenantInternetGatewayIds,
type,
workloadExpressRouteConnections,
workloadServices
FROM azure_extras.managed_network_fabric.network_fabric_controllers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_fabric_controller_name = '{{ network_fabric_controller_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the NetworkFabricControllers thats available in the resource group.

SELECT
id,
name,
annotation,
identity,
infrastructureExpressRouteConnections,
infrastructureServices,
ipv4AddressSpace,
ipv6AddressSpace,
isWorkloadManagementNetworkEnabled,
lastOperation,
location,
managedResourceGroupConfiguration,
networkFabricIds,
nfcSku,
provisioningState,
systemData,
tags,
tenantInternetGatewayIds,
type,
workloadExpressRouteConnections,
workloadServices
FROM azure_extras.managed_network_fabric.network_fabric_controllers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all the NetworkFabricControllers by subscription.

SELECT
id,
name,
annotation,
identity,
infrastructureExpressRouteConnections,
infrastructureServices,
ipv4AddressSpace,
ipv6AddressSpace,
isWorkloadManagementNetworkEnabled,
lastOperation,
location,
managedResourceGroupConfiguration,
networkFabricIds,
nfcSku,
provisioningState,
systemData,
tags,
tenantInternetGatewayIds,
type,
workloadExpressRouteConnections,
workloadServices
FROM azure_extras.managed_network_fabric.network_fabric_controllers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a Network Fabric Controller.

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

Manifest

# Description fields are for documentation purposes
- name: network_fabric_controllers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_fabric_controllers resource.
  - name: network_fabric_controller_name
    value: "{{ network_fabric_controller_name }}"
    description: Required parameter for the network_fabric_controllers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_fabric_controllers 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 NetworkFabricController Properties. Required.
    value:
      annotation: "{{ annotation }}"
      infrastructureExpressRouteConnections:
        - expressRouteCircuitId: "{{ expressRouteCircuitId }}"
          expressRouteAuthorizationKey: "{{ expressRouteAuthorizationKey }}"
      workloadExpressRouteConnections:
        - expressRouteCircuitId: "{{ expressRouteCircuitId }}"
          expressRouteAuthorizationKey: "{{ expressRouteAuthorizationKey }}"
      infrastructureServices:
        ipv4AddressSpaces:
          - "{{ ipv4AddressSpaces }}"
        ipv6AddressSpaces:
          - "{{ ipv6AddressSpaces }}"
      workloadServices:
        ipv4AddressSpaces:
          - "{{ ipv4AddressSpaces }}"
        ipv6AddressSpaces:
          - "{{ ipv6AddressSpaces }}"
      managedResourceGroupConfiguration:
        name: "{{ name }}"
        location: "{{ location }}"
      networkFabricIds:
        - "{{ networkFabricIds }}"
      isWorkloadManagementNetworkEnabled: "{{ isWorkloadManagementNetworkEnabled }}"
      tenantInternetGatewayIds:
        - "{{ tenantInternetGatewayIds }}"
      ipv4AddressSpace: "{{ ipv4AddressSpace }}"
      ipv6AddressSpace: "{{ ipv6AddressSpace }}"
      nfcSku: "{{ nfcSku }}"
      lastOperation:
        details: "{{ details }}"
      provisioningState: "{{ provisioningState }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates are currently not supported for the Network Fabric Controller resource.

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

DELETE examples

delete

Deletes the Network Fabric Controller resource.

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