Microsoft.Network networkManagers/routingConfigurations/ruleCollections 2023-03-01-preview

  • Article

Bicep resource definition

The networkManagers/routingConfigurations/ruleCollections resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Network/networkManagers/routingConfigurations/ruleCollections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appliesTo: [
      {
        networkGroupId: 'string'
      }
    ]
    description: 'string'
    disableBgpRoutePropagation: bool
    localRouteSetting: 'string'
  }
}

Property values

networkManagers/routingConfigurations/ruleCollection...

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: routingConfigurations
properties Indicates the properties for the network manager routing rule collection. RoutingRuleCollectionPropertiesFormat

RoutingRuleCollectionPropertiesFormat

Name Description Value
appliesTo Groups for configuration NetworkManagerRoutingGroupItem[] (required)
description A description of the routing rule collection. string
disableBgpRoutePropagation Determines whether BGP route propagation is enabled. Defaults to true. bool
localRouteSetting Indicates local route setting for this particular rule collection. 'DirectRoutingWithinSubnet'
'DirectRoutingWithinVNet'
'NotSpecified' (required)

NetworkManagerRoutingGroupItem

Name Description Value
networkGroupId Network manager group Id. string (required)

ARM template resource definition

The networkManagers/routingConfigurations/ruleCollections resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Network/networkManagers/routingConfigurations/ruleCollections resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "appliesTo": [
      {
        "networkGroupId": "string"
      }
    ],
    "description": "string",
    "disableBgpRoutePropagation": "bool",
    "localRouteSetting": "string"
  }
}

Property values

networkManagers/routingConfigurations/ruleCollection...

Name Description Value
type The resource type 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections'
apiVersion The resource api version '2023-03-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Indicates the properties for the network manager routing rule collection. RoutingRuleCollectionPropertiesFormat

RoutingRuleCollectionPropertiesFormat

Name Description Value
appliesTo Groups for configuration NetworkManagerRoutingGroupItem[] (required)
description A description of the routing rule collection. string
disableBgpRoutePropagation Determines whether BGP route propagation is enabled. Defaults to true. bool
localRouteSetting Indicates local route setting for this particular rule collection. 'DirectRoutingWithinSubnet'
'DirectRoutingWithinVNet'
'NotSpecified' (required)

NetworkManagerRoutingGroupItem

Name Description Value
networkGroupId Network manager group Id. string (required)

Terraform (AzAPI provider) resource definition

The networkManagers/routingConfigurations/ruleCollections 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.Network/networkManagers/routingConfigurations/ruleCollections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appliesTo = [
        {
          networkGroupId = "string"
        }
      ]
      description = "string"
      disableBgpRoutePropagation = bool
      localRouteSetting = "string"
    }
  })
}

Property values

networkManagers/routingConfigurations/ruleCollection...

Name Description Value
type The resource type "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections@2023-03-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: routingConfigurations
properties Indicates the properties for the network manager routing rule collection. RoutingRuleCollectionPropertiesFormat

RoutingRuleCollectionPropertiesFormat

Name Description Value
appliesTo Groups for configuration NetworkManagerRoutingGroupItem[] (required)
description A description of the routing rule collection. string
disableBgpRoutePropagation Determines whether BGP route propagation is enabled. Defaults to true. bool
localRouteSetting Indicates local route setting for this particular rule collection. "DirectRoutingWithinSubnet"
"DirectRoutingWithinVNet"
"NotSpecified" (required)

NetworkManagerRoutingGroupItem

Name Description Value
networkGroupId Network manager group Id. string (required)