Microsoft.Web hostingEnvironments/workerPools 2018-02-01

Template format

To create a Microsoft.Web/hostingEnvironments/workerPools resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Web/hostingEnvironments/workerPools",
  "apiVersion": "2018-02-01",
  "kind": "string",
  "properties": {
    "workerSizeId": "integer",
    "computeMode": "string",
    "workerSize": "string",
    "workerCount": "integer"
  },
  "sku": {
    "name": "string",
    "tier": "string",
    "size": "string",
    "family": "string",
    "capacity": "integer",
    "skuCapacity": {
      "minimum": "integer",
      "maximum": "integer",
      "default": "integer",
      "scaleType": "string"
    },
    "locations": [
      "string"
    ],
    "capabilities": [
      {
        "name": "string",
        "value": "string",
        "reason": "string"
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Web/hostingEnvironments/workerPools object

Name Type Required Value
name string Yes Name of the worker pool.
type enum Yes workerPools
-or-
Microsoft.Web/hostingEnvironments/workerPools

See Set name and type for child resources.
apiVersion enum Yes 2018-02-01
kind string No Kind of resource.
properties object Yes Core resource properties - WorkerPool object
sku object No SkuDescription object

WorkerPool object

Name Type Required Value
workerSizeId integer No Worker size ID for referencing this worker pool.
computeMode enum No Shared or dedicated app hosting. - Shared, Dedicated, Dynamic
workerSize string No VM size of the worker pool instances.
workerCount integer No Number of instances in the worker pool.

SkuDescription object

Name Type Required Value
name string No Name of the resource SKU.
tier string No Service tier of the resource SKU.
size string No Size specifier of the resource SKU.
family string No Family code of the resource SKU.
capacity integer No Current number of instances assigned to the resource.
skuCapacity object No Min, max, and default scale values of the SKU. - SkuCapacity object
locations array No Locations of the SKU. - string
capabilities array No Capabilities of the SKU, e.g., is traffic manager enabled? - Capability object

SkuCapacity object

Name Type Required Value
minimum integer No Minimum number of workers for this App Service plan SKU.
maximum integer No Maximum number of workers for this App Service plan SKU.
default integer No Default number of workers for this App Service plan SKU.
scaleType string No Available scale configurations for an App Service plan.

Capability object

Name Type Required Value
name string No Name of the SKU capability.
value string No Value of the SKU capability.
reason string No Reason of the SKU capability.