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 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections@2024-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
appliesTo: [
{
networkGroupId: 'string'
}
]
description: 'string'
disableBgpRoutePropagation: 'string'
}
}
Property Values
Microsoft.Network/networkManagers/routingConfigurations/ruleCollections
| 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 |
| properties | Indicates the properties for the network manager routing rule collection. | RoutingRuleCollectionPropertiesFormat |
NetworkManagerRoutingGroupItem
| Name | Description | Value |
|---|---|---|
| networkGroupId | Network manager group Id. | string (required) |
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. | 'False' 'True' |
ARM template resource definition
The networkManagers/routingConfigurations/ruleCollections 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 resource, add the following JSON to your template.
{
"type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections",
"apiVersion": "2024-03-01",
"name": "string",
"properties": {
"appliesTo": [
{
"networkGroupId": "string"
}
],
"description": "string",
"disableBgpRoutePropagation": "string"
}
}
Property Values
Microsoft.Network/networkManagers/routingConfigurations/ruleCollections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-03-01' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9_.-]*$ (required) |
| properties | Indicates the properties for the network manager routing rule collection. | RoutingRuleCollectionPropertiesFormat |
| type | The resource type | 'Microsoft.Network/networkManagers/routingConfigurations/ruleCollections' |
NetworkManagerRoutingGroupItem
| Name | Description | Value |
|---|---|---|
| networkGroupId | Network manager group Id. | string (required) |
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. | 'False' 'True' |
Usage Examples
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@2024-03-01"
name = "string"
parent_id = "string"
body = {
properties = {
appliesTo = [
{
networkGroupId = "string"
}
]
description = "string"
disableBgpRoutePropagation = "string"
}
}
}
Property Values
Microsoft.Network/networkManagers/routingConfigurations/ruleCollections
| 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 |
| properties | Indicates the properties for the network manager routing rule collection. | RoutingRuleCollectionPropertiesFormat |
| type | The resource type | "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections@2024-03-01" |
NetworkManagerRoutingGroupItem
| Name | Description | Value |
|---|---|---|
| networkGroupId | Network manager group Id. | string (required) |
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. | 'False' 'True' |