Share via

Microsoft.Web hostingEnvironments/workerPools 2015-08-01

  • Article

Bicep resource definition

The hostingEnvironments/workerPools resource type can be deployed with operations that target:

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@2015-08-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    computeMode: 'string'
    instanceNames: [
      'string'
    ]
    workerCount: int
    workerSize: 'string'
    workerSizeId: int
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.Web/hostingEnvironments/workerPools

Name Description Value
kind Kind of resource string
location Resource Location string (required)
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 WorkerPoolProperties
sku Describes a sku for a scalable resource SkuDescription
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

SkuDescription

Name Description Value
capacity Current number of instances assigned to the resource int
family Family code of the resource sku string
name Name of the resource sku string
size Size specifier of the resource sku string
tier Service Tier of the resource sku string

WorkerPoolProperties

Name Description Value
computeMode Shared or dedicated web app hosting 'Dedicated'
'Dynamic'
'Shared'
instanceNames Names of all instances in the worker pool (read only) string[]
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:

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": "2015-08-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "computeMode": "string",
    "instanceNames": [ "string" ],
    "workerCount": "int",
    "workerSize": "string",
    "workerSizeId": "int"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.Web/hostingEnvironments/workerPools

Name Description Value
apiVersion The api version '2015-08-01'
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
properties WorkerPoolProperties
sku Describes a sku for a scalable resource SkuDescription
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Web/hostingEnvironments/workerPools'

ResourceTags

Name Description Value

SkuDescription

Name Description Value
capacity Current number of instances assigned to the resource int
family Family code of the resource sku string
name Name of the resource sku string
size Size specifier of the resource sku string
tier Service Tier of the resource sku string

WorkerPoolProperties

Name Description Value
computeMode Shared or dedicated web app hosting 'Dedicated'
'Dynamic'
'Shared'
instanceNames Names of all instances in the worker pool (read only) string[]
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

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@2015-08-01"
  name = "string"
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      computeMode = "string"
      instanceNames = [
        "string"
      ]
      workerCount = int
      workerSize = "string"
      workerSizeId = int
    }
  })
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Property values

Microsoft.Web/hostingEnvironments/workerPools

Name Description Value
kind Kind of resource string
location Resource Location string (required)
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 WorkerPoolProperties
sku Describes a sku for a scalable resource SkuDescription
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Web/hostingEnvironments/workerPools@2015-08-01"

ResourceTags

Name Description Value

SkuDescription

Name Description Value
capacity Current number of instances assigned to the resource int
family Family code of the resource sku string
name Name of the resource sku string
size Size specifier of the resource sku string
tier Service Tier of the resource sku string

WorkerPoolProperties

Name Description Value
computeMode Shared or dedicated web app hosting 'Dedicated'
'Dynamic'
'Shared'
instanceNames Names of all instances in the worker pool (read only) string[]
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