Microsoft.Network virtualRouters/peerings 2022-09-01
- Latest
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
Bicep resource definition
The virtualRouters/peerings 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/virtualRouters/peerings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/virtualRouters/peerings@2022-09-01' = {
name: 'string'
properties: {
peerAsn: int
peerIp: 'string'
}
}
Property values
Microsoft.Network/virtualRouters/peerings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 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: virtualRouters |
| properties | The properties of the Virtual Router Peering. | VirtualRouterPeeringProperties |
VirtualRouterPeeringProperties
| Name | Description | Value |
|---|---|---|
| peerAsn | Peer ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| peerIp | Peer IP. | string |
ARM template resource definition
The virtualRouters/peerings 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/virtualRouters/peerings resource, add the following JSON to your template.
{
"type": "Microsoft.Network/virtualRouters/peerings",
"apiVersion": "2022-09-01",
"name": "string",
"properties": {
"peerAsn": "int",
"peerIp": "string"
}
}
Property values
Microsoft.Network/virtualRouters/peerings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-09-01' |
| name | The resource name | string (required) |
| properties | The properties of the Virtual Router Peering. | VirtualRouterPeeringProperties |
| type | The resource type | 'Microsoft.Network/virtualRouters/peerings' |
VirtualRouterPeeringProperties
| Name | Description | Value |
|---|---|---|
| peerAsn | Peer ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| peerIp | Peer IP. | string |
Terraform (AzAPI provider) resource definition
The virtualRouters/peerings 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/virtualRouters/peerings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/virtualRouters/peerings@2022-09-01"
name = "string"
body = jsonencode({
properties = {
peerAsn = int
peerIp = "string"
}
})
}
Property values
Microsoft.Network/virtualRouters/peerings
| Name | Description | Value |
|---|---|---|
| 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: virtualRouters |
| properties | The properties of the Virtual Router Peering. | VirtualRouterPeeringProperties |
| type | The resource type | "Microsoft.Network/virtualRouters/peerings@2022-09-01" |
VirtualRouterPeeringProperties
| Name | Description | Value |
|---|---|---|
| peerAsn | Peer ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| peerIp | Peer IP. | string |