Microsoft.Network virtualRouters 2023-05-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 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/virtualRouters@2023-05-01' = {
location: 'string'
name: 'string'
properties: {
hostedGateway: {
id: 'string'
}
hostedSubnet: {
id: 'string'
}
virtualRouterAsn: int
virtualRouterIps: [
'string'
]
}
tags: {
{customized property}: 'string'
}
}
Property values
Microsoft.Network/virtualRouters
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Properties of the Virtual Router. | VirtualRouterPropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VirtualRouterPropertiesFormat
| Name | Description | Value |
|---|---|---|
| hostedGateway | The Gateway on which VirtualRouter is hosted. | SubResource |
| hostedSubnet | The Subnet on which VirtualRouter is hosted. | SubResource |
| virtualRouterAsn | VirtualRouter ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| virtualRouterIps | VirtualRouter IPs. | string[] |
ARM template resource definition
The virtualRouters 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 resource, add the following JSON to your template.
{
"type": "Microsoft.Network/virtualRouters",
"apiVersion": "2023-05-01",
"name": "string",
"location": "string",
"properties": {
"hostedGateway": {
"id": "string"
},
"hostedSubnet": {
"id": "string"
},
"virtualRouterAsn": "int",
"virtualRouterIps": [ "string" ]
},
"tags": {
"{customized property}": "string"
}
}
Property values
Microsoft.Network/virtualRouters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-05-01' |
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Properties of the Virtual Router. | VirtualRouterPropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Network/virtualRouters' |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VirtualRouterPropertiesFormat
| Name | Description | Value |
|---|---|---|
| hostedGateway | The Gateway on which VirtualRouter is hosted. | SubResource |
| hostedSubnet | The Subnet on which VirtualRouter is hosted. | SubResource |
| virtualRouterAsn | VirtualRouter ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| virtualRouterIps | VirtualRouter IPs. | string[] |
Terraform (AzAPI provider) resource definition
The virtualRouters 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/virtualRouters@2023-05-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
hostedGateway = {
id = "string"
}
hostedSubnet = {
id = "string"
}
virtualRouterAsn = int
virtualRouterIps = [
"string"
]
}
})
tags = {
{customized property} = "string"
}
}
Property values
Microsoft.Network/virtualRouters
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | Properties of the Virtual Router. | VirtualRouterPropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Network/virtualRouters@2023-05-01" |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
VirtualRouterPropertiesFormat
| Name | Description | Value |
|---|---|---|
| hostedGateway | The Gateway on which VirtualRouter is hosted. | SubResource |
| hostedSubnet | The Subnet on which VirtualRouter is hosted. | SubResource |
| virtualRouterAsn | VirtualRouter ASN. | int Constraints: Min value = 0 Max value = 4294967295 |
| virtualRouterIps | VirtualRouter IPs. | string[] |