Microsoft.ManagedNetworkFabric networkFabrics 2023-06-15

• Latest
• 2025-07-15
• 2024-06-15-preview
• 2024-02-15-preview
• 2023-06-15
• 2023-02-01-preview

Bicep resource definition

The networkFabrics resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ManagedNetworkFabric/networkFabrics resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ManagedNetworkFabric/networkFabrics@2023-06-15' = {
  location: 'string'
  name: 'string'
  properties: {
    annotation: 'string'
    fabricASN: int
    fabricVersion: 'string'
    ipv4Prefix: 'string'
    ipv6Prefix: 'string'
    managementNetworkConfiguration: {
      infrastructureVpnConfiguration: {
        networkToNetworkInterconnectId: 'string'
        optionAProperties: {
          bfdConfiguration: {
            intervalInMilliSeconds: int
            multiplier: int
          }
          mtu: int
          peerASN: int
          primaryIpv4Prefix: 'string'
          primaryIpv6Prefix: 'string'
          secondaryIpv4Prefix: 'string'
          secondaryIpv6Prefix: 'string'
          vlanId: int
        }
        optionBProperties: {
          exportRouteTargets: [
            'string'
          ]
          importRouteTargets: [
            'string'
          ]
          routeTargets: {
            exportIpv4RouteTargets: [
              'string'
            ]
            exportIpv6RouteTargets: [
              'string'
            ]
            importIpv4RouteTargets: [
              'string'
            ]
            importIpv6RouteTargets: [
              'string'
            ]
          }
        }
        peeringOption: 'string'
      }
      workloadVpnConfiguration: {
        networkToNetworkInterconnectId: 'string'
        optionAProperties: {
          bfdConfiguration: {
            intervalInMilliSeconds: int
            multiplier: int
          }
          mtu: int
          peerASN: int
          primaryIpv4Prefix: 'string'
          primaryIpv6Prefix: 'string'
          secondaryIpv4Prefix: 'string'
          secondaryIpv6Prefix: 'string'
          vlanId: int
        }
        optionBProperties: {
          exportRouteTargets: [
            'string'
          ]
          importRouteTargets: [
            'string'
          ]
          routeTargets: {
            exportIpv4RouteTargets: [
              'string'
            ]
            exportIpv6RouteTargets: [
              'string'
            ]
            importIpv4RouteTargets: [
              'string'
            ]
            importIpv6RouteTargets: [
              'string'
            ]
          }
        }
        peeringOption: 'string'
      }
    }
    networkFabricControllerId: 'string'
    networkFabricSku: 'string'
    rackCount: int
    serverCountPerRack: int
    terminalServerConfiguration: {
      password: 'string'
      primaryIpv4Prefix: 'string'
      primaryIpv6Prefix: 'string'
      secondaryIpv4Prefix: 'string'
      secondaryIpv6Prefix: 'string'
      serialNumber: 'string'
      username: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.ManagedNetworkFabric/networkFabrics

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Resource properties.	NetworkFabricProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

BfdConfiguration

Name	Description	Value
intervalInMilliSeconds	Interval in milliseconds. Example: 300.	int
multiplier	Multiplier for the Bfd Configuration. Example: 5.	int

ManagementNetworkConfigurationProperties

Name	Description	Value
infrastructureVpnConfiguration	VPN Configuration properties.	VpnConfigurationProperties (required)
workloadVpnConfiguration	VPN Configuration properties.	VpnConfigurationProperties (required)

NetworkFabricProperties

Name	Description	Value
annotation	Switch configuration description.	string
fabricASN	ASN of CE devices for CE/PE connectivity.	int Constraints: Min value = 1 Max value = 4294967295 (required)
fabricVersion	The version of Network Fabric.	string Constraints: Min length = 1
ipv4Prefix	IPv4Prefix for Management Network. Example: 10.1.0.0/19.	string Constraints: Min length = 1 (required)
ipv6Prefix	IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59	string Constraints: Min length = 1
managementNetworkConfiguration	Configuration to be used to setup the management network.	ManagementNetworkConfigurationProperties (required)
networkFabricControllerId	Azure resource ID for the NetworkFabricController the NetworkFabric belongs.	string (required)
networkFabricSku	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.	string Constraints: Min length = 1 (required)
rackCount	Number of compute racks associated to Network Fabric.	int Constraints: Min value = 1 Max value = 8
serverCountPerRack	Number of servers.Possible values are from 1-16.	int Constraints: Min value = 1 Max value = 16 (required)
terminalServerConfiguration	Network and credentials configuration currently applied to terminal server.	TerminalServerConfiguration (required)

OptionBProperties

Name	Description	Value
exportRouteTargets	Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.	string[]
importRouteTargets	Route Targets to be applied for incoming routes into CE. This is for backward compatibility.	string[]
routeTargets	Route Targets to be applied.	RouteTargetInformation

RouteTargetInformation

Name	Description	Value
exportIpv4RouteTargets	Route Targets to be applied for outgoing routes into CE.	string Constraints: Min length = 1[]
exportIpv6RouteTargets	Route Targets to be applied for outgoing routes from CE.	string Constraints: Min length = 1[]
importIpv4RouteTargets	Route Targets to be applied for incoming routes into CE.	string Constraints: Min length = 1[]
importIpv6RouteTargets	Route Targets to be applied for incoming routes from CE.	string Constraints: Min length = 1[]

TerminalServerConfiguration

Name	Description	Value
password	Password for the terminal server connection.	string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter.
primaryIpv4Prefix	IPv4 Address Prefix.	string
primaryIpv6Prefix	IPv6 Address Prefix.	string
secondaryIpv4Prefix	Secondary IPv4 Address Prefix.	string
secondaryIpv6Prefix	Secondary IPv6 Address Prefix.	string
serialNumber	Serial Number of Terminal server.	string Constraints: Min length = 1
username	Username for the terminal server connection.	string Constraints: Min length = 1

TrackedResourceTags

Name	Description	Value

VpnConfigurationProperties

Name	Description	Value
networkToNetworkInterconnectId	ARM Resource ID of the Network To Network Interconnect.	string
optionAProperties	option A properties	VpnConfigurationPropertiesOptionAProperties
optionBProperties	option B properties	OptionBProperties
peeringOption	Peering option list.	'OptionA' 'OptionB' (required)

VpnConfigurationPropertiesOptionAProperties

Name	Description	Value
bfdConfiguration	BFD Configuration properties.	BfdConfiguration
mtu	MTU to use for option A peering.	int Constraints: Min value = 64 Max value = 9200
peerASN	Peer ASN number.Example : 28	int Constraints: Min value = 1 Max value = 4294967295
primaryIpv4Prefix	IPv4 Address Prefix.	string
primaryIpv6Prefix	IPv6 Address Prefix.	string
secondaryIpv4Prefix	Secondary IPv4 Address Prefix.	string
secondaryIpv6Prefix	Secondary IPv6 Address Prefix.	string
vlanId	Vlan Id.Example : 501	int Constraints: Min value = 501 Max value = 4094

ARM template resource definition

The networkFabrics resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ManagedNetworkFabric/networkFabrics resource, add the following JSON to your template.

{
  "type": "Microsoft.ManagedNetworkFabric/networkFabrics",
  "apiVersion": "2023-06-15",
  "name": "string",
  "location": "string",
  "properties": {
    "annotation": "string",
    "fabricASN": "int",
    "fabricVersion": "string",
    "ipv4Prefix": "string",
    "ipv6Prefix": "string",
    "managementNetworkConfiguration": {
      "infrastructureVpnConfiguration": {
        "networkToNetworkInterconnectId": "string",
        "optionAProperties": {
          "bfdConfiguration": {
            "intervalInMilliSeconds": "int",
            "multiplier": "int"
          },
          "mtu": "int",
          "peerASN": "int",
          "primaryIpv4Prefix": "string",
          "primaryIpv6Prefix": "string",
          "secondaryIpv4Prefix": "string",
          "secondaryIpv6Prefix": "string",
          "vlanId": "int"
        },
        "optionBProperties": {
          "exportRouteTargets": [ "string" ],
          "importRouteTargets": [ "string" ],
          "routeTargets": {
            "exportIpv4RouteTargets": [ "string" ],
            "exportIpv6RouteTargets": [ "string" ],
            "importIpv4RouteTargets": [ "string" ],
            "importIpv6RouteTargets": [ "string" ]
          }
        },
        "peeringOption": "string"
      },
      "workloadVpnConfiguration": {
        "networkToNetworkInterconnectId": "string",
        "optionAProperties": {
          "bfdConfiguration": {
            "intervalInMilliSeconds": "int",
            "multiplier": "int"
          },
          "mtu": "int",
          "peerASN": "int",
          "primaryIpv4Prefix": "string",
          "primaryIpv6Prefix": "string",
          "secondaryIpv4Prefix": "string",
          "secondaryIpv6Prefix": "string",
          "vlanId": "int"
        },
        "optionBProperties": {
          "exportRouteTargets": [ "string" ],
          "importRouteTargets": [ "string" ],
          "routeTargets": {
            "exportIpv4RouteTargets": [ "string" ],
            "exportIpv6RouteTargets": [ "string" ],
            "importIpv4RouteTargets": [ "string" ],
            "importIpv6RouteTargets": [ "string" ]
          }
        },
        "peeringOption": "string"
      }
    },
    "networkFabricControllerId": "string",
    "networkFabricSku": "string",
    "rackCount": "int",
    "serverCountPerRack": "int",
    "terminalServerConfiguration": {
      "password": "string",
      "primaryIpv4Prefix": "string",
      "primaryIpv6Prefix": "string",
      "secondaryIpv4Prefix": "string",
      "secondaryIpv6Prefix": "string",
      "serialNumber": "string",
      "username": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.ManagedNetworkFabric/networkFabrics

Name	Description	Value
apiVersion	The api version	'2023-06-15'
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Resource properties.	NetworkFabricProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.ManagedNetworkFabric/networkFabrics'

BfdConfiguration

Name	Description	Value
intervalInMilliSeconds	Interval in milliseconds. Example: 300.	int
multiplier	Multiplier for the Bfd Configuration. Example: 5.	int

ManagementNetworkConfigurationProperties

Name	Description	Value
infrastructureVpnConfiguration	VPN Configuration properties.	VpnConfigurationProperties (required)
workloadVpnConfiguration	VPN Configuration properties.	VpnConfigurationProperties (required)

NetworkFabricProperties

Name	Description	Value
annotation	Switch configuration description.	string
fabricASN	ASN of CE devices for CE/PE connectivity.	int Constraints: Min value = 1 Max value = 4294967295 (required)
fabricVersion	The version of Network Fabric.	string Constraints: Min length = 1
ipv4Prefix	IPv4Prefix for Management Network. Example: 10.1.0.0/19.	string Constraints: Min length = 1 (required)
ipv6Prefix	IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59	string Constraints: Min length = 1
managementNetworkConfiguration	Configuration to be used to setup the management network.	ManagementNetworkConfigurationProperties (required)
networkFabricControllerId	Azure resource ID for the NetworkFabricController the NetworkFabric belongs.	string (required)
networkFabricSku	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.	string Constraints: Min length = 1 (required)
rackCount	Number of compute racks associated to Network Fabric.	int Constraints: Min value = 1 Max value = 8
serverCountPerRack	Number of servers.Possible values are from 1-16.	int Constraints: Min value = 1 Max value = 16 (required)
terminalServerConfiguration	Network and credentials configuration currently applied to terminal server.	TerminalServerConfiguration (required)

OptionBProperties

Name	Description	Value
exportRouteTargets	Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.	string[]
importRouteTargets	Route Targets to be applied for incoming routes into CE. This is for backward compatibility.	string[]
routeTargets	Route Targets to be applied.	RouteTargetInformation

RouteTargetInformation

Name	Description	Value
exportIpv4RouteTargets	Route Targets to be applied for outgoing routes into CE.	string Constraints: Min length = 1[]
exportIpv6RouteTargets	Route Targets to be applied for outgoing routes from CE.	string Constraints: Min length = 1[]
importIpv4RouteTargets	Route Targets to be applied for incoming routes into CE.	string Constraints: Min length = 1[]
importIpv6RouteTargets	Route Targets to be applied for incoming routes from CE.	string Constraints: Min length = 1[]

TerminalServerConfiguration

Name	Description	Value
password	Password for the terminal server connection.	string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter.
primaryIpv4Prefix	IPv4 Address Prefix.	string
primaryIpv6Prefix	IPv6 Address Prefix.	string
secondaryIpv4Prefix	Secondary IPv4 Address Prefix.	string
secondaryIpv6Prefix	Secondary IPv6 Address Prefix.	string
serialNumber	Serial Number of Terminal server.	string Constraints: Min length = 1
username	Username for the terminal server connection.	string Constraints: Min length = 1

TrackedResourceTags

Name	Description	Value

VpnConfigurationProperties

Name	Description	Value
networkToNetworkInterconnectId	ARM Resource ID of the Network To Network Interconnect.	string
optionAProperties	option A properties	VpnConfigurationPropertiesOptionAProperties
optionBProperties	option B properties	OptionBProperties
peeringOption	Peering option list.	'OptionA' 'OptionB' (required)

VpnConfigurationPropertiesOptionAProperties

Name	Description	Value
bfdConfiguration	BFD Configuration properties.	BfdConfiguration
mtu	MTU to use for option A peering.	int Constraints: Min value = 64 Max value = 9200
peerASN	Peer ASN number.Example : 28	int Constraints: Min value = 1 Max value = 4294967295
primaryIpv4Prefix	IPv4 Address Prefix.	string
primaryIpv6Prefix	IPv6 Address Prefix.	string
secondaryIpv4Prefix	Secondary IPv4 Address Prefix.	string
secondaryIpv6Prefix	Secondary IPv6 Address Prefix.	string
vlanId	Vlan Id.Example : 501	int Constraints: Min value = 501 Max value = 4094

Usage Examples

Terraform (AzAPI provider) resource definition

The networkFabrics resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ManagedNetworkFabric/networkFabrics resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ManagedNetworkFabric/networkFabrics@2023-06-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      annotation = "string"
      fabricASN = int
      fabricVersion = "string"
      ipv4Prefix = "string"
      ipv6Prefix = "string"
      managementNetworkConfiguration = {
        infrastructureVpnConfiguration = {
          networkToNetworkInterconnectId = "string"
          optionAProperties = {
            bfdConfiguration = {
              intervalInMilliSeconds = int
              multiplier = int
            }
            mtu = int
            peerASN = int
            primaryIpv4Prefix = "string"
            primaryIpv6Prefix = "string"
            secondaryIpv4Prefix = "string"
            secondaryIpv6Prefix = "string"
            vlanId = int
          }
          optionBProperties = {
            exportRouteTargets = [
              "string"
            ]
            importRouteTargets = [
              "string"
            ]
            routeTargets = {
              exportIpv4RouteTargets = [
                "string"
              ]
              exportIpv6RouteTargets = [
                "string"
              ]
              importIpv4RouteTargets = [
                "string"
              ]
              importIpv6RouteTargets = [
                "string"
              ]
            }
          }
          peeringOption = "string"
        }
        workloadVpnConfiguration = {
          networkToNetworkInterconnectId = "string"
          optionAProperties = {
            bfdConfiguration = {
              intervalInMilliSeconds = int
              multiplier = int
            }
            mtu = int
            peerASN = int
            primaryIpv4Prefix = "string"
            primaryIpv6Prefix = "string"
            secondaryIpv4Prefix = "string"
            secondaryIpv6Prefix = "string"
            vlanId = int
          }
          optionBProperties = {
            exportRouteTargets = [
              "string"
            ]
            importRouteTargets = [
              "string"
            ]
            routeTargets = {
              exportIpv4RouteTargets = [
                "string"
              ]
              exportIpv6RouteTargets = [
                "string"
              ]
              importIpv4RouteTargets = [
                "string"
              ]
              importIpv6RouteTargets = [
                "string"
              ]
            }
          }
          peeringOption = "string"
        }
      }
      networkFabricControllerId = "string"
      networkFabricSku = "string"
      rackCount = int
      serverCountPerRack = int
      terminalServerConfiguration = {
        password = "string"
        primaryIpv4Prefix = "string"
        primaryIpv6Prefix = "string"
        secondaryIpv4Prefix = "string"
        secondaryIpv6Prefix = "string"
        serialNumber = "string"
        username = "string"
      }
    }
  }
}

Property Values

Microsoft.ManagedNetworkFabric/networkFabrics

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Resource properties.	NetworkFabricProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.ManagedNetworkFabric/networkFabrics@2023-06-15"

BfdConfiguration

Name	Description	Value
intervalInMilliSeconds	Interval in milliseconds. Example: 300.	int
multiplier	Multiplier for the Bfd Configuration. Example: 5.	int

ManagementNetworkConfigurationProperties

Name	Description	Value
infrastructureVpnConfiguration	VPN Configuration properties.	VpnConfigurationProperties (required)
workloadVpnConfiguration	VPN Configuration properties.	VpnConfigurationProperties (required)

NetworkFabricProperties

Name	Description	Value
annotation	Switch configuration description.	string
fabricASN	ASN of CE devices for CE/PE connectivity.	int Constraints: Min value = 1 Max value = 4294967295 (required)
fabricVersion	The version of Network Fabric.	string Constraints: Min length = 1
ipv4Prefix	IPv4Prefix for Management Network. Example: 10.1.0.0/19.	string Constraints: Min length = 1 (required)
ipv6Prefix	IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59	string Constraints: Min length = 1
managementNetworkConfiguration	Configuration to be used to setup the management network.	ManagementNetworkConfigurationProperties (required)
networkFabricControllerId	Azure resource ID for the NetworkFabricController the NetworkFabric belongs.	string (required)
networkFabricSku	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.	string Constraints: Min length = 1 (required)
rackCount	Number of compute racks associated to Network Fabric.	int Constraints: Min value = 1 Max value = 8
serverCountPerRack	Number of servers.Possible values are from 1-16.	int Constraints: Min value = 1 Max value = 16 (required)
terminalServerConfiguration	Network and credentials configuration currently applied to terminal server.	TerminalServerConfiguration (required)

OptionBProperties

Name	Description	Value
exportRouteTargets	Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.	string[]
importRouteTargets	Route Targets to be applied for incoming routes into CE. This is for backward compatibility.	string[]
routeTargets	Route Targets to be applied.	RouteTargetInformation

RouteTargetInformation

Name	Description	Value
exportIpv4RouteTargets	Route Targets to be applied for outgoing routes into CE.	string Constraints: Min length = 1[]
exportIpv6RouteTargets	Route Targets to be applied for outgoing routes from CE.	string Constraints: Min length = 1[]
importIpv4RouteTargets	Route Targets to be applied for incoming routes into CE.	string Constraints: Min length = 1[]
importIpv6RouteTargets	Route Targets to be applied for incoming routes from CE.	string Constraints: Min length = 1[]

TerminalServerConfiguration

Name	Description	Value
password	Password for the terminal server connection.	string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter.
primaryIpv4Prefix	IPv4 Address Prefix.	string
primaryIpv6Prefix	IPv6 Address Prefix.	string
secondaryIpv4Prefix	Secondary IPv4 Address Prefix.	string
secondaryIpv6Prefix	Secondary IPv6 Address Prefix.	string
serialNumber	Serial Number of Terminal server.	string Constraints: Min length = 1
username	Username for the terminal server connection.	string Constraints: Min length = 1

TrackedResourceTags

Name	Description	Value

VpnConfigurationProperties

Name	Description	Value
networkToNetworkInterconnectId	ARM Resource ID of the Network To Network Interconnect.	string
optionAProperties	option A properties	VpnConfigurationPropertiesOptionAProperties
optionBProperties	option B properties	OptionBProperties
peeringOption	Peering option list.	'OptionA' 'OptionB' (required)

VpnConfigurationPropertiesOptionAProperties

Name	Description	Value
bfdConfiguration	BFD Configuration properties.	BfdConfiguration
mtu	MTU to use for option A peering.	int Constraints: Min value = 64 Max value = 9200
peerASN	Peer ASN number.Example : 28	int Constraints: Min value = 1 Max value = 4294967295
primaryIpv4Prefix	IPv4 Address Prefix.	string
primaryIpv6Prefix	IPv6 Address Prefix.	string
secondaryIpv4Prefix	Secondary IPv4 Address Prefix.	string
secondaryIpv6Prefix	Secondary IPv6 Address Prefix.	string
vlanId	Vlan Id.Example : 501	int Constraints: Min value = 501 Max value = 4094