PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/?api-version=2023-01-01

Description for Create or update a worker pool.

Servers

Path parameters

Name Type Required Description
name String Yes

Name of the App Service Environment.

subscriptionId String Yes

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

workerPoolName String Yes

Name of the worker pool.

resourceGroupName String Yes

Name of the resource group to which the resource belongs.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

Resource Id.

name String No

Resource Name.

sku Object No

Description of a SKU for a scalable resource.

sku.tier String No

Service tier of the resource SKU.

sku.family String No

Family code of the resource SKU.

sku.name String No

Name of the resource SKU.

sku.size String No

Size specifier of the resource SKU.

sku.locations[] Array No

Locations of the SKU.

sku.skuCapacity Object No

Description of the App Service plan scale options.

sku.skuCapacity.minimum Integer No

Minimum number of workers for this App Service plan SKU.

sku.skuCapacity.elasticMaximum Integer No

Maximum number of Elastic workers for this App Service plan SKU.

sku.skuCapacity.default Integer No

Default number of workers for this App Service plan SKU.

sku.skuCapacity.scaleType String No

Available scale configurations for an App Service plan.

sku.skuCapacity.maximum Integer No

Maximum number of workers for this App Service plan SKU.

sku.capacity Integer No

Current number of instances assigned to the resource.

sku.capabilities[] Array No

Capabilities of the SKU, e.g., is traffic manager enabled?

sku.capabilities[].name String No

Name of the SKU capability.

sku.capabilities[].value String No

Value of the SKU capability.

sku.capabilities[].reason String No

Reason of the SKU capability.

properties Object No

Worker pool of an App Service Environment.

properties.computeMode String No

Shared or dedicated app hosting.

Possible values:

  • "Dynamic"
  • "Dedicated"
  • "Shared"
properties.workerSizeId Integer No

Worker size ID for referencing this worker pool.

properties.workerSize String No

VM size of the worker pool instances.

properties.workerCount Integer No

Number of instances in the worker pool.

properties.instanceNames[] Array No

Names of all instances in the worker pool (read only).

type String No

Resource type.

kind String No

Kind of resource.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.