Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The networkManagers/routingConfigurations/ruleCollections/rules 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.Network/networkManagers/routingConfigurations/ruleCollections/rules resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
destination: {
destinationAddress: 'string'
type: 'string'
}
nextHop: {
nextHopAddress: 'string'
nextHopType: 'string'
}
}
}
Property Values
Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9_.-]*$ (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: networkManagers/routingConfigurations/ruleCollections |
| properties | Indicates the properties of the routing rule | RoutingRulePropertiesFormat |
RoutingRuleNextHop
| Name | Description | Value |
|---|---|---|
| nextHopAddress | Next hop address. Only required if the next hop type is VirtualAppliance. | string |
| nextHopType | Next hop type. | 'Internet' 'NoNextHop' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required) |
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) |
ARM template resource definition
The networkManagers/routingConfigurations/ruleCollections/rules 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.Network/networkManagers/routingConfigurations/ruleCollections/rules resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"description": "string",
"destination": {
"destinationAddress": "string",
"type": "string"
},
"nextHop": {
"nextHopAddress": "string",
"nextHopType": "string"
}
}
}
Property Values
Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9_.-]*$ (required) |
| properties | Indicates the properties of the routing rule | RoutingRulePropertiesFormat |
| type | The resource type | 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules' |
RoutingRuleNextHop
| Name | Description | Value |
|---|---|---|
| nextHopAddress | Next hop address. Only required if the next hop type is VirtualAppliance. | string |
| nextHopType | Next hop type. | 'Internet' 'NoNextHop' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required) |
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) |
Usage Examples
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@2024-05-01"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
destination = {
destinationAddress = "string"
type = "string"
}
nextHop = {
nextHopAddress = "string"
nextHopType = "string"
}
}
}
}
Property Values
Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9_.-]*$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: networkManagers/routingConfigurations/ruleCollections |
| properties | Indicates the properties of the routing rule | RoutingRulePropertiesFormat |
| type | The resource type | "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules@2024-05-01" |
RoutingRuleNextHop
| Name | Description | Value |
|---|---|---|
| nextHopAddress | Next hop address. Only required if the next hop type is VirtualAppliance. | string |
| nextHopType | Next hop type. | 'Internet' 'NoNextHop' 'VirtualAppliance' 'VirtualNetworkGateway' 'VnetLocal' (required) |
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) |