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

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    destination: {
      destinationAddress: 'string'
      type: 'string'
    }
    nextHop: {
      nextHopAddress: 'string'
      nextHopType: '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: ruleCollections
properties Indicates the properties of the routing rule RoutingRulePropertiesFormat

RoutingRulePropertiesFormat

Name Description Value
description A description for this rule. string
destination Indicates the destination for this particular rule. RoutingRuleRouteDestination (required)
nextHop Indicates the next hop for this particular rule. RoutingRuleNextHop (required)

RoutingRuleRouteDestination

Name Description Value
destinationAddress Destination address. string (required)
type Destination type. 'AddressPrefix'
'ServiceTag' (required)

RoutingRuleNextHop

Name Description Value
nextHopAddress Next hop address. Only relevant if the next hop type is VirtualAppliance. string
nextHopType Next hop type. 'Internet'
'NoNextNop'
'VirtualAppliance'
'VirtualNetworkGateway'
'VnetLocal' (required)

ARM template resource definition

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

{
  "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "destination": {
      "destinationAddress": "string",
      "type": "string"
    },
    "nextHop": {
      "nextHopAddress": "string",
      "nextHopType": "string"
    }
  }
}

Property values

networkManagers/routingConfigurations/ruleCollection...

Name Description Value
type The resource type 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules'
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 of the routing rule RoutingRulePropertiesFormat

RoutingRulePropertiesFormat

Name Description Value
description A description for this rule. string
destination Indicates the destination for this particular rule. RoutingRuleRouteDestination (required)
nextHop Indicates the next hop for this particular rule. RoutingRuleNextHop (required)

RoutingRuleRouteDestination

Name Description Value
destinationAddress Destination address. string (required)
type Destination type. 'AddressPrefix'
'ServiceTag' (required)

RoutingRuleNextHop

Name Description Value
nextHopAddress Next hop address. Only relevant if the next hop type is VirtualAppliance. string
nextHopType Next hop type. 'Internet'
'NoNextNop'
'VirtualAppliance'
'VirtualNetworkGateway'
'VnetLocal' (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      destination = {
        destinationAddress = "string"
        type = "string"
      }
      nextHop = {
        nextHopAddress = "string"
        nextHopType = "string"
      }
    }
  })
}

Property values

networkManagers/routingConfigurations/ruleCollection...

Name Description Value
type The resource type "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules@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: ruleCollections
properties Indicates the properties of the routing rule RoutingRulePropertiesFormat

RoutingRulePropertiesFormat

Name Description Value
description A description for this rule. string
destination Indicates the destination for this particular rule. RoutingRuleRouteDestination (required)
nextHop Indicates the next hop for this particular rule. RoutingRuleNextHop (required)

RoutingRuleRouteDestination

Name Description Value
destinationAddress Destination address. string (required)
type Destination type. "AddressPrefix"
"ServiceTag" (required)

RoutingRuleNextHop

Name Description Value
nextHopAddress Next hop address. Only relevant if the next hop type is VirtualAppliance. string
nextHopType Next hop type. "Internet"
"NoNextNop"
"VirtualAppliance"
"VirtualNetworkGateway"
"VnetLocal" (required)