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 hostingEnvironments/workerPools 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/hostingEnvironments/workerPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/hostingEnvironments/workerPools@2023-12-01' = {
parent: resourceSymbolicName
kind: 'string'
name: 'string'
properties: {
computeMode: 'string'
workerCount: int
workerSize: 'string'
workerSizeId: int
}
sku: {
capabilities: [
{
name: 'string'
reason: 'string'
value: 'string'
}
]
capacity: int
family: 'string'
locations: [
'string'
]
name: 'string'
size: 'string'
skuCapacity: {
default: int
elasticMaximum: int
maximum: int
minimum: int
scaleType: 'string'
}
tier: 'string'
}
}
Property Values
Microsoft.Web/hostingEnvironments/workerPools
| 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: hostingEnvironments |
| properties | Core resource properties | WorkerPool |
| sku | Description of a SKU for a scalable resource. | SkuDescription |
Capability
| Name | Description | Value |
|---|---|---|
| name | Name of the SKU capability. | string |
| reason | Reason of the SKU capability. | string |
| value | Value of the SKU capability. | string |
SkuCapacity
| Name | Description | Value |
|---|---|---|
| default | Default number of workers for this App Service plan SKU. | int |
| elasticMaximum | Maximum number of Elastic workers for this App Service plan SKU. | int |
| maximum | Maximum number of workers for this App Service plan SKU. | int |
| minimum | Minimum number of workers for this App Service plan SKU. | int |
| scaleType | Available scale configurations for an App Service plan. | string |
SkuDescription
| Name | Description | Value |
|---|---|---|
| capabilities | Capabilities of the SKU, e.g., is traffic manager enabled? | Capability[] |
| capacity | Current number of instances assigned to the resource. | int |
| family | Family code of the resource SKU. | string |
| locations | Locations of the SKU. | string[] |
| name | Name of the resource SKU. | string |
| size | Size specifier of the resource SKU. | string |
| skuCapacity | Min, max, and default scale values of the SKU. | SkuCapacity |
| tier | Service tier of the resource SKU. | string |
WorkerPool
| Name | Description | Value |
|---|---|---|
| computeMode | Shared or dedicated app hosting. | 'Dedicated' 'Dynamic' 'Shared' |
| workerCount | Number of instances in the worker pool. | int |
| workerSize | VM size of the worker pool instances. | string |
| workerSizeId | Worker size ID for referencing this worker pool. | int |
ARM template resource definition
The hostingEnvironments/workerPools 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/hostingEnvironments/workerPools resource, add the following JSON to your template.
{
"type": "Microsoft.Web/hostingEnvironments/workerPools",
"apiVersion": "2023-12-01",
"name": "string",
"kind": "string",
"properties": {
"computeMode": "string",
"workerCount": "int",
"workerSize": "string",
"workerSizeId": "int"
},
"sku": {
"capabilities": [
{
"name": "string",
"reason": "string",
"value": "string"
}
],
"capacity": "int",
"family": "string",
"locations": [ "string" ],
"name": "string",
"size": "string",
"skuCapacity": {
"default": "int",
"elasticMaximum": "int",
"maximum": "int",
"minimum": "int",
"scaleType": "string"
},
"tier": "string"
}
}
Property Values
Microsoft.Web/hostingEnvironments/workerPools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| kind | Kind of resource. | string |
| name | The resource name | string (required) |
| properties | Core resource properties | WorkerPool |
| sku | Description of a SKU for a scalable resource. | SkuDescription |
| type | The resource type | 'Microsoft.Web/hostingEnvironments/workerPools' |
Capability
| Name | Description | Value |
|---|---|---|
| name | Name of the SKU capability. | string |
| reason | Reason of the SKU capability. | string |
| value | Value of the SKU capability. | string |
SkuCapacity
| Name | Description | Value |
|---|---|---|
| default | Default number of workers for this App Service plan SKU. | int |
| elasticMaximum | Maximum number of Elastic workers for this App Service plan SKU. | int |
| maximum | Maximum number of workers for this App Service plan SKU. | int |
| minimum | Minimum number of workers for this App Service plan SKU. | int |
| scaleType | Available scale configurations for an App Service plan. | string |
SkuDescription
| Name | Description | Value |
|---|---|---|
| capabilities | Capabilities of the SKU, e.g., is traffic manager enabled? | Capability[] |
| capacity | Current number of instances assigned to the resource. | int |
| family | Family code of the resource SKU. | string |
| locations | Locations of the SKU. | string[] |
| name | Name of the resource SKU. | string |
| size | Size specifier of the resource SKU. | string |
| skuCapacity | Min, max, and default scale values of the SKU. | SkuCapacity |
| tier | Service tier of the resource SKU. | string |
WorkerPool
| Name | Description | Value |
|---|---|---|
| computeMode | Shared or dedicated app hosting. | 'Dedicated' 'Dynamic' 'Shared' |
| workerCount | Number of instances in the worker pool. | int |
| workerSize | VM size of the worker pool instances. | string |
| workerSizeId | Worker size ID for referencing this worker pool. | int |
Usage Examples
Terraform (AzAPI provider) resource definition
The hostingEnvironments/workerPools 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/hostingEnvironments/workerPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/hostingEnvironments/workerPools@2023-12-01"
name = "string"
parent_id = "string"
body = {
kind = "string"
properties = {
computeMode = "string"
workerCount = int
workerSize = "string"
workerSizeId = int
}
sku = {
capabilities = [
{
name = "string"
reason = "string"
value = "string"
}
]
capacity = int
family = "string"
locations = [
"string"
]
name = "string"
size = "string"
skuCapacity = {
default = int
elasticMaximum = int
maximum = int
minimum = int
scaleType = "string"
}
tier = "string"
}
}
}
Property Values
Microsoft.Web/hostingEnvironments/workerPools
| 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: hostingEnvironments |
| properties | Core resource properties | WorkerPool |
| sku | Description of a SKU for a scalable resource. | SkuDescription |
| type | The resource type | "Microsoft.Web/hostingEnvironments/workerPools@2023-12-01" |
Capability
| Name | Description | Value |
|---|---|---|
| name | Name of the SKU capability. | string |
| reason | Reason of the SKU capability. | string |
| value | Value of the SKU capability. | string |
SkuCapacity
| Name | Description | Value |
|---|---|---|
| default | Default number of workers for this App Service plan SKU. | int |
| elasticMaximum | Maximum number of Elastic workers for this App Service plan SKU. | int |
| maximum | Maximum number of workers for this App Service plan SKU. | int |
| minimum | Minimum number of workers for this App Service plan SKU. | int |
| scaleType | Available scale configurations for an App Service plan. | string |
SkuDescription
| Name | Description | Value |
|---|---|---|
| capabilities | Capabilities of the SKU, e.g., is traffic manager enabled? | Capability[] |
| capacity | Current number of instances assigned to the resource. | int |
| family | Family code of the resource SKU. | string |
| locations | Locations of the SKU. | string[] |
| name | Name of the resource SKU. | string |
| size | Size specifier of the resource SKU. | string |
| skuCapacity | Min, max, and default scale values of the SKU. | SkuCapacity |
| tier | Service tier of the resource SKU. | string |
WorkerPool
| Name | Description | Value |
|---|---|---|
| computeMode | Shared or dedicated app hosting. | 'Dedicated' 'Dynamic' 'Shared' |
| workerCount | Number of instances in the worker pool. | int |
| workerSize | VM size of the worker pool instances. | string |
| workerSizeId | Worker size ID for referencing this worker pool. | int |