network_fabrics

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

Overview

Name	network_fabrics
Type	Resource
Id	azure_extras.managed_network_fabric.network_fabrics

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.
activeCommitBatches	array	Active commit batch identifiers.
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.
authorizedTransceiver	object	Authorized transciever configuration for NetworkFabric.
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)
controlPlaneAcls	array	Control Plane Access Control List ARM resource IDs.
fabricASN	integer	ASN of CE devices for CE/PE connectivity. Required.
fabricLocks	array	Network Fabric Lock details.
fabricVersion	string	The version of Network Fabric.
featureFlags	array	NetworkFabric feature flag configuration information.
hardwareAlertThreshold	integer	Hardware alert threshold percentage. Possible values are from 20 to 100.
identity	object	The managed service identities assigned to this resource.
ipv4Prefix	string	IPv4Prefix for Management Network. Example: 10.1.0.0/19. Required.
ipv6Prefix	string	IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.
l2IsolationDomains	array	List of L2 Isolation Domain resource IDs under the Network Fabric.
l3IsolationDomains	array	List of L3 Isolation Domain resource IDs under the Network Fabric.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
managementNetworkConfiguration	object	Configuration to be used to setup the management network. Required.
networkFabricControllerId	string	Azure resource ID for the NetworkFabricController the NetworkFabric belongs. Required.
networkFabricSku	string	Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. Required.
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)
qosConfiguration	object	NetworkFabric QoS Configuration.
rackCount	integer	Number of compute racks associated to Network Fabric.
racks	array	List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU.
routerIds	array	Array of router IDs.
secretRotationSummary	object	Overview of secret rotation for the Network Fabric.
serverCountPerRack	integer	Number of servers.Possible values are from 1-16. Required.
storageAccountConfiguration	object	Bring your own storage account configurations for Network Fabric.
storageArrayCount	integer	Number of Storage arrays associated with the Network Fabric.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
terminalServerConfiguration	object	Network and credentials configuration currently applied to terminal server. Required.
trustedIpPrefixes	array	Trusted IP Prefixes ARM resource IDs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueRdConfiguration	object	Unique Route Distinguisher 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.
activeCommitBatches	array	Active commit batch identifiers.
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.
authorizedTransceiver	object	Authorized transciever configuration for NetworkFabric.
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)
controlPlaneAcls	array	Control Plane Access Control List ARM resource IDs.
fabricASN	integer	ASN of CE devices for CE/PE connectivity. Required.
fabricLocks	array	Network Fabric Lock details.
fabricVersion	string	The version of Network Fabric.
featureFlags	array	NetworkFabric feature flag configuration information.
hardwareAlertThreshold	integer	Hardware alert threshold percentage. Possible values are from 20 to 100.
identity	object	The managed service identities assigned to this resource.
ipv4Prefix	string	IPv4Prefix for Management Network. Example: 10.1.0.0/19. Required.
ipv6Prefix	string	IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.
l2IsolationDomains	array	List of L2 Isolation Domain resource IDs under the Network Fabric.
l3IsolationDomains	array	List of L3 Isolation Domain resource IDs under the Network Fabric.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
managementNetworkConfiguration	object	Configuration to be used to setup the management network. Required.
networkFabricControllerId	string	Azure resource ID for the NetworkFabricController the NetworkFabric belongs. Required.
networkFabricSku	string	Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. Required.
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)
qosConfiguration	object	NetworkFabric QoS Configuration.
rackCount	integer	Number of compute racks associated to Network Fabric.
racks	array	List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU.
routerIds	array	Array of router IDs.
secretRotationSummary	object	Overview of secret rotation for the Network Fabric.
serverCountPerRack	integer	Number of servers.Possible values are from 1-16. Required.
storageAccountConfiguration	object	Bring your own storage account configurations for Network Fabric.
storageArrayCount	integer	Number of Storage arrays associated with the Network Fabric.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
terminalServerConfiguration	object	Network and credentials configuration currently applied to terminal server. Required.
trustedIpPrefixes	array	Trusted IP Prefixes ARM resource IDs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueRdConfiguration	object	Unique Route Distinguisher 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.
activeCommitBatches	array	Active commit batch identifiers.
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.
authorizedTransceiver	object	Authorized transciever configuration for NetworkFabric.
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)
controlPlaneAcls	array	Control Plane Access Control List ARM resource IDs.
fabricASN	integer	ASN of CE devices for CE/PE connectivity. Required.
fabricLocks	array	Network Fabric Lock details.
fabricVersion	string	The version of Network Fabric.
featureFlags	array	NetworkFabric feature flag configuration information.
hardwareAlertThreshold	integer	Hardware alert threshold percentage. Possible values are from 20 to 100.
identity	object	The managed service identities assigned to this resource.
ipv4Prefix	string	IPv4Prefix for Management Network. Example: 10.1.0.0/19. Required.
ipv6Prefix	string	IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.
l2IsolationDomains	array	List of L2 Isolation Domain resource IDs under the Network Fabric.
l3IsolationDomains	array	List of L3 Isolation Domain resource IDs under the Network Fabric.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
managementNetworkConfiguration	object	Configuration to be used to setup the management network. Required.
networkFabricControllerId	string	Azure resource ID for the NetworkFabricController the NetworkFabric belongs. Required.
networkFabricSku	string	Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. Required.
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)
qosConfiguration	object	NetworkFabric QoS Configuration.
rackCount	integer	Number of compute racks associated to Network Fabric.
racks	array	List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU.
routerIds	array	Array of router IDs.
secretRotationSummary	object	Overview of secret rotation for the Network Fabric.
serverCountPerRack	integer	Number of servers.Possible values are from 1-16. Required.
storageAccountConfiguration	object	Bring your own storage account configurations for Network Fabric.
storageArrayCount	integer	Number of Storage arrays associated with the Network Fabric.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
terminalServerConfiguration	object	Network and credentials configuration currently applied to terminal server. Required.
trustedIpPrefixes	array	Trusted IP Prefixes ARM resource IDs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueRdConfiguration	object	Unique Route Distinguisher configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_fabric_name, subscription_id		Get Network Fabric resource details.
list_by_resource_group	select	resource_group_name, subscription_id		List all the Network Fabric resources in the given resource group.
list_by_subscription	select	subscription_id		List all the Network Fabric resources in the given subscription.
create	insert	resource_group_name, network_fabric_name, subscription_id, location, properties		Create Network Fabric resource.
update	update	resource_group_name, network_fabric_name, subscription_id		Update certain properties of the Network Fabric resource.
delete	delete	resource_group_name, network_fabric_name, subscription_id		Delete Network Fabric resource.
get_topology	exec	resource_group_name, network_fabric_name, subscription_id		Gets Topology of the underlying resources in the given Network Fabric instance.
provision	exec	resource_group_name, network_fabric_name, subscription_id		Provisions the underlying resources in the given Network Fabric instance.
deprovision	exec	resource_group_name, network_fabric_name, subscription_id		Deprovisions the underlying resources in the given Network Fabric instance.
upgrade	exec	resource_group_name, network_fabric_name, subscription_id		Upgrades the version of the underlying resources in the given Network Fabric instance.
refresh_configuration	exec	resource_group_name, network_fabric_name, subscription_id		Refreshes the configuration of the underlying resources in the given Network Fabric instance.
update_workload_management_bfd_configuration	exec	resource_group_name, network_fabric_name, subscription_id		Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.
update_infra_management_bfd_configuration	exec	resource_group_name, network_fabric_name, subscription_id		Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.
validate_configuration	exec	resource_group_name, network_fabric_name, subscription_id		Validates the configuration of the underlying resources in the given Network Fabric instance.
commit_configuration	exec	resource_group_name, network_fabric_name, subscription_id		Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.
commit_batch_status	exec	resource_group_name, network_fabric_name, subscription_id		Post action: Returns a status of commit batch operation.
discard_commit_batch	exec	resource_group_name, network_fabric_name, subscription_id		Post action: Discards a Batch operation in progress.
lock_fabric	exec	resource_group_name, network_fabric_name, subscription_id		Post action: Triggers network fabric lock operation.
view_device_configuration	exec	resource_group_name, network_fabric_name, subscription_id		Post action: Triggers view of network fabric configuration.
arm_configuration_diff	exec	resource_group_name, network_fabric_name, subscription_id		Post action: Triggers diff of NetworkFabric ARM Configuration.
rotate_passwords	exec	resource_group_name, network_fabric_name, subscription_id		Rotate all passwords on the Terminal Server and Network Devices. Creates new passwords, then updates the Terminal Server and Network Devices to use the new passwords. Note that disabled devices cannot be updated and must be resynchronized with the new passwords once they are enabled. Fails if any of the devices could not be updated with the new password. Failed devices should be resynchronized with the new passwords once possible.
resync_passwords	exec	resource_group_name, network_fabric_name, subscription_id		Resync the latest passwords to the Terminal Server and Network Devices. Updates the Terminal Server and all Network Devices to use the latest passwords. Does not generate new passwords. Allows devices to be brought back in sync after a partially successful password rotation.
rotate_certificates	exec	resource_group_name, network_fabric_name, subscription_id		Rotate all certificates on Network Devices. Creates new certificates, then updates the Network Devices to use the new certificates. Note that disabled devices cannot be updated and must be resynchronized with the new certificates once they are enabled.
resync_certificates	exec	resource_group_name, network_fabric_name, subscription_id		Re-sync all certificates on Network Devices. Updates all Network Devices to use the latest certificates. Does not generate new certificates. Allows network devices missed during a previous certificate rotation to be brought back into sync.

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

SELECT examples

get

Get Network Fabric resource details.

SELECT
id,
name,
activeCommitBatches,
administrativeState,
annotation,
authorizedTransceiver,
configurationState,
controlPlaneAcls,
fabricASN,
fabricLocks,
fabricVersion,
featureFlags,
hardwareAlertThreshold,
identity,
ipv4Prefix,
ipv6Prefix,
l2IsolationDomains,
l3IsolationDomains,
lastOperation,
location,
managementNetworkConfiguration,
networkFabricControllerId,
networkFabricSku,
provisioningState,
qosConfiguration,
rackCount,
racks,
routerIds,
secretRotationSummary,
serverCountPerRack,
storageAccountConfiguration,
storageArrayCount,
systemData,
tags,
terminalServerConfiguration,
trustedIpPrefixes,
type,
uniqueRdConfiguration
FROM azure_extras.managed_network_fabric.network_fabrics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_fabric_name = '{{ network_fabric_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
activeCommitBatches,
administrativeState,
annotation,
authorizedTransceiver,
configurationState,
controlPlaneAcls,
fabricASN,
fabricLocks,
fabricVersion,
featureFlags,
hardwareAlertThreshold,
identity,
ipv4Prefix,
ipv6Prefix,
l2IsolationDomains,
l3IsolationDomains,
lastOperation,
location,
managementNetworkConfiguration,
networkFabricControllerId,
networkFabricSku,
provisioningState,
qosConfiguration,
rackCount,
racks,
routerIds,
secretRotationSummary,
serverCountPerRack,
storageAccountConfiguration,
storageArrayCount,
systemData,
tags,
terminalServerConfiguration,
trustedIpPrefixes,
type,
uniqueRdConfiguration
FROM azure_extras.managed_network_fabric.network_fabrics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all the Network Fabric resources in the given subscription.

SELECT
id,
name,
activeCommitBatches,
administrativeState,
annotation,
authorizedTransceiver,
configurationState,
controlPlaneAcls,
fabricASN,
fabricLocks,
fabricVersion,
featureFlags,
hardwareAlertThreshold,
identity,
ipv4Prefix,
ipv6Prefix,
l2IsolationDomains,
l3IsolationDomains,
lastOperation,
location,
managementNetworkConfiguration,
networkFabricControllerId,
networkFabricSku,
provisioningState,
qosConfiguration,
rackCount,
racks,
routerIds,
secretRotationSummary,
serverCountPerRack,
storageAccountConfiguration,
storageArrayCount,
systemData,
tags,
terminalServerConfiguration,
trustedIpPrefixes,
type,
uniqueRdConfiguration
FROM azure_extras.managed_network_fabric.network_fabrics
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Network Fabric resource.

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

Manifest

# Description fields are for documentation purposes
- name: network_fabrics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_fabrics resource.
  - name: network_fabric_name
    value: "{{ network_fabric_name }}"
    description: Required parameter for the network_fabrics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_fabrics 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 NetworkFabric Properties. Required.
    value:
      annotation: "{{ annotation }}"
      networkFabricSku: "{{ networkFabricSku }}"
      fabricVersion: "{{ fabricVersion }}"
      routerIds:
        - "{{ routerIds }}"
      storageAccountConfiguration:
        storageAccountId: "{{ storageAccountId }}"
        storageAccountIdentity:
          identityType: "{{ identityType }}"
          userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
      fabricLocks:
        - lockState: "{{ lockState }}"
          lockType: "{{ lockType }}"
      networkFabricControllerId: "{{ networkFabricControllerId }}"
      rackCount: {{ rackCount }}
      serverCountPerRack: {{ serverCountPerRack }}
      ipv4Prefix: "{{ ipv4Prefix }}"
      ipv6Prefix: "{{ ipv6Prefix }}"
      fabricASN: {{ fabricASN }}
      terminalServerConfiguration:
        username: "{{ username }}"
        password: "{{ password }}"
        serialNumber: "{{ serialNumber }}"
        primaryIpv4Prefix: "{{ primaryIpv4Prefix }}"
        primaryIpv6Prefix: "{{ primaryIpv6Prefix }}"
        secondaryIpv4Prefix: "{{ secondaryIpv4Prefix }}"
        secondaryIpv6Prefix: "{{ secondaryIpv6Prefix }}"
        networkDeviceId: "{{ networkDeviceId }}"
        secretRotationStatus:
          - lastRotationTime: "{{ lastRotationTime }}"
            synchronizationStatus: "{{ synchronizationStatus }}"
            secretArchiveReference:
              keyVaultUri: "{{ keyVaultUri }}"
              keyVaultId: "{{ keyVaultId }}"
              secretName: "{{ secretName }}"
              secretVersion: "{{ secretVersion }}"
            secretType: "{{ secretType }}"
      managementNetworkConfiguration:
        infrastructureVpnConfiguration:
          networkToNetworkInterconnectId: "{{ networkToNetworkInterconnectId }}"
          administrativeState: "{{ administrativeState }}"
          peeringOption: "{{ peeringOption }}"
          optionBProperties:
            importRouteTargets:
              - "{{ importRouteTargets }}"
            exportRouteTargets:
              - "{{ exportRouteTargets }}"
            routeTargets:
              importIpv4RouteTargets: "{{ importIpv4RouteTargets }}"
              importIpv6RouteTargets: "{{ importIpv6RouteTargets }}"
              exportIpv4RouteTargets: "{{ exportIpv4RouteTargets }}"
              exportIpv6RouteTargets: "{{ exportIpv6RouteTargets }}"
          optionAProperties:
            primaryIpv4Prefix: "{{ primaryIpv4Prefix }}"
            primaryIpv6Prefix: "{{ primaryIpv6Prefix }}"
            secondaryIpv4Prefix: "{{ secondaryIpv4Prefix }}"
            secondaryIpv6Prefix: "{{ secondaryIpv6Prefix }}"
            mtu: {{ mtu }}
            vlanId: {{ vlanId }}
            peerASN: {{ peerASN }}
            bfdConfiguration:
              administrativeState: "{{ administrativeState }}"
              intervalInMilliSeconds: {{ intervalInMilliSeconds }}
              multiplier: {{ multiplier }}
        workloadVpnConfiguration:
          networkToNetworkInterconnectId: "{{ networkToNetworkInterconnectId }}"
          administrativeState: "{{ administrativeState }}"
          peeringOption: "{{ peeringOption }}"
          optionBProperties:
            importRouteTargets:
              - "{{ importRouteTargets }}"
            exportRouteTargets:
              - "{{ exportRouteTargets }}"
            routeTargets:
              importIpv4RouteTargets: "{{ importIpv4RouteTargets }}"
              importIpv6RouteTargets: "{{ importIpv6RouteTargets }}"
              exportIpv4RouteTargets: "{{ exportIpv4RouteTargets }}"
              exportIpv6RouteTargets: "{{ exportIpv6RouteTargets }}"
          optionAProperties:
            primaryIpv4Prefix: "{{ primaryIpv4Prefix }}"
            primaryIpv6Prefix: "{{ primaryIpv6Prefix }}"
            secondaryIpv4Prefix: "{{ secondaryIpv4Prefix }}"
            secondaryIpv6Prefix: "{{ secondaryIpv6Prefix }}"
            mtu: {{ mtu }}
            vlanId: {{ vlanId }}
            peerASN: {{ peerASN }}
            bfdConfiguration:
              administrativeState: "{{ administrativeState }}"
              intervalInMilliSeconds: {{ intervalInMilliSeconds }}
              multiplier: {{ multiplier }}
      racks:
        - "{{ racks }}"
      l2IsolationDomains:
        - "{{ l2IsolationDomains }}"
      l3IsolationDomains:
        - "{{ l3IsolationDomains }}"
      hardwareAlertThreshold: {{ hardwareAlertThreshold }}
      controlPlaneAcls:
        - "{{ controlPlaneAcls }}"
      featureFlags:
        - featureFlagName: "{{ featureFlagName }}"
          featureFlagValue: "{{ featureFlagValue }}"
      trustedIpPrefixes:
        - "{{ trustedIpPrefixes }}"
      uniqueRdConfiguration:
        uniqueRdConfigurationState: "{{ uniqueRdConfigurationState }}"
        uniqueRds:
          - "{{ uniqueRds }}"
        nniDerivedUniqueRdConfigurationState: "{{ nniDerivedUniqueRdConfigurationState }}"
      storageArrayCount: {{ storageArrayCount }}
      activeCommitBatches:
        - "{{ activeCommitBatches }}"
      secretRotationSummary:
        activePasswordSetCount: {{ activePasswordSetCount }}
      lastOperation:
        details: "{{ details }}"
      authorizedTransceiver:
        vendor: "{{ vendor }}"
        key: "{{ key }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"
      qosConfiguration:
        qosConfigurationState: "{{ qosConfigurationState }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update certain properties of the Network Fabric resource.

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

DELETE examples

delete

Delete Network Fabric resource.

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

Lifecycle Methods

get_topology

Gets Topology of the underlying resources in the given Network Fabric instance.

EXEC azure_extras.managed_network_fabric.network_fabrics.get_topology 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

provision

Provisions the underlying resources in the given Network Fabric instance.

EXEC azure_extras.managed_network_fabric.network_fabrics.provision 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

deprovision

Deprovisions the underlying resources in the given Network Fabric instance.

EXEC azure_extras.managed_network_fabric.network_fabrics.deprovision 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

upgrade

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

EXEC azure_extras.managed_network_fabric.network_fabrics.upgrade 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"version": "{{ version }}", 
"action": "{{ action }}"
}'
;

refresh_configuration

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

EXEC azure_extras.managed_network_fabric.network_fabrics.refresh_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_workload_management_bfd_configuration

Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.

EXEC azure_extras.managed_network_fabric.network_fabrics.update_workload_management_bfd_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

update_infra_management_bfd_configuration

Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.

EXEC azure_extras.managed_network_fabric.network_fabrics.update_infra_management_bfd_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

validate_configuration

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

EXEC azure_extras.managed_network_fabric.network_fabrics.validate_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"validateAction": "{{ validateAction }}"
}'
;

commit_configuration

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

EXEC azure_extras.managed_network_fabric.network_fabrics.commit_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"commitStage": "{{ commitStage }}", 
"commitPolicy": "{{ commitPolicy }}", 
"devices": "{{ devices }}"
}'
;

commit_batch_status

Post action: Returns a status of commit batch operation.

EXEC azure_extras.managed_network_fabric.network_fabrics.commit_batch_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"commitBatchId": "{{ commitBatchId }}"
}'
;

discard_commit_batch

Post action: Discards a Batch operation in progress.

EXEC azure_extras.managed_network_fabric.network_fabrics.discard_commit_batch 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"commitBatchId": "{{ commitBatchId }}"
}'
;

lock_fabric

Post action: Triggers network fabric lock operation.

EXEC azure_extras.managed_network_fabric.network_fabrics.lock_fabric 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"lockType": "{{ lockType }}", 
"action": "{{ action }}"
}'
;

view_device_configuration

Post action: Triggers view of network fabric configuration.

EXEC azure_extras.managed_network_fabric.network_fabrics.view_device_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

arm_configuration_diff

Post action: Triggers diff of NetworkFabric ARM Configuration.

EXEC azure_extras.managed_network_fabric.network_fabrics.arm_configuration_diff 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

rotate_passwords

Rotate all passwords on the Terminal Server and Network Devices. Creates new passwords, then updates the Terminal Server and Network Devices to use the new passwords. Note that disabled devices cannot be updated and must be resynchronized with the new passwords once they are enabled. Fails if any of the devices could not be updated with the new password. Failed devices should be resynchronized with the new passwords once possible.

EXEC azure_extras.managed_network_fabric.network_fabrics.rotate_passwords 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resync_passwords

Resync the latest passwords to the Terminal Server and Network Devices. Updates the Terminal Server and all Network Devices to use the latest passwords. Does not generate new passwords. Allows devices to be brought back in sync after a partially successful password rotation.

EXEC azure_extras.managed_network_fabric.network_fabrics.resync_passwords 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

rotate_certificates

Rotate all certificates on Network Devices. Creates new certificates, then updates the Network Devices to use the new certificates. Note that disabled devices cannot be updated and must be resynchronized with the new certificates once they are enabled.

EXEC azure_extras.managed_network_fabric.network_fabrics.rotate_certificates 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resync_certificates

Re-sync all certificates on Network Devices. Updates all Network Devices to use the latest certificates. Does not generate new certificates. Allows network devices missed during a previous certificate rotation to be brought back into sync.

EXEC azure_extras.managed_network_fabric.network_fabrics.resync_certificates 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_fabric_name='{{ network_fabric_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;