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 serverfarms/virtualNetworkConnections/routes 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.Web/serverfarms/virtualNetworkConnections/routes resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-03-01' = {
parent: resourceSymbolicName
kind: 'string'
name: 'string'
properties: {
endAddress: 'string'
routeType: 'string'
startAddress: 'string'
}
}
Property Values
Microsoft.Web/serverfarms/virtualNetworkConnections/routes
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| 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: serverfarms/virtualNetworkConnections |
| properties | VnetRoute resource specific properties | VnetRouteProperties |
VnetRouteProperties
| Name | Description | Value |
|---|---|---|
| endAddress | The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. | string |
| routeType | The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. |
'DEFAULT' 'INHERITED' 'STATIC' |
| startAddress | The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. | string |
ARM template resource definition
The serverfarms/virtualNetworkConnections/routes 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.Web/serverfarms/virtualNetworkConnections/routes resource, add the following JSON to your template.
{
"type": "Microsoft.Web/serverfarms/virtualNetworkConnections/routes",
"apiVersion": "2021-03-01",
"name": "string",
"kind": "string",
"properties": {
"endAddress": "string",
"routeType": "string",
"startAddress": "string"
}
}
Property Values
Microsoft.Web/serverfarms/virtualNetworkConnections/routes
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-03-01' |
| kind | Kind of resource. | string |
| name | The resource name | string (required) |
| properties | VnetRoute resource specific properties | VnetRouteProperties |
| type | The resource type | 'Microsoft.Web/serverfarms/virtualNetworkConnections/routes' |
VnetRouteProperties
| Name | Description | Value |
|---|---|---|
| endAddress | The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. | string |
| routeType | The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. |
'DEFAULT' 'INHERITED' 'STATIC' |
| startAddress | The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The serverfarms/virtualNetworkConnections/routes 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.Web/serverfarms/virtualNetworkConnections/routes resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-03-01"
name = "string"
parent_id = "string"
body = {
kind = "string"
properties = {
endAddress = "string"
routeType = "string"
startAddress = "string"
}
}
}
Property Values
Microsoft.Web/serverfarms/virtualNetworkConnections/routes
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| 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: serverfarms/virtualNetworkConnections |
| properties | VnetRoute resource specific properties | VnetRouteProperties |
| type | The resource type | "Microsoft.Web/serverfarms/virtualNetworkConnections/routes@2021-03-01" |
VnetRouteProperties
| Name | Description | Value |
|---|---|---|
| endAddress | The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. | string |
| routeType | The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. |
'DEFAULT' 'INHERITED' 'STATIC' |
| startAddress | The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. | string |