App Service Environments - Update Multi Role Pool

Reference

Service:: App Service

API Version:: 2023-12-01

Description for Create or update a multi-role pool.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the App Service Environment.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Type	Description
kind	string	Kind of resource.
properties.computeMode	ComputeModeOptions	Shared or dedicated app hosting.
properties.workerCount	integer	Number of instances in the worker pool.
properties.workerSize	string	VM size of the worker pool instances.
properties.workerSizeId	integer	Worker size ID for referencing this worker pool.
sku	SkuDescription	Description of a SKU for a scalable resource.

Responses

Name	Type	Description
200 OK	WorkerPoolResource	OK.
202 Accepted	WorkerPoolResource	Operation is in progress.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or update a multi-role pool.

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/multiRolePools/default?api-version=2023-12-01

{
  "properties": {
    "workerSize": "Medium",
    "workerCount": 3
  }
}

Sample Response

Status code:: 202

{}

Status code:: 200

{}

Definitions

Name	Description
Capability	Describes the capabilities/features allowed for a specific SKU.
ComputeModeOptions	Shared/dedicated workers.
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
SkuCapacity	Description of the App Service plan scale options.
SkuDescription	Description of a SKU for a scalable resource.
WorkerPoolResource	Worker pool of an App Service Environment ARM resource.

Capability

Describes the capabilities/features allowed for a specific SKU.

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

ComputeModeOptions

Shared/dedicated workers.

Name	Type	Description
Dedicated	string
Dynamic	string
Shared	string

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

SkuCapacity

Description of the App Service plan scale options.

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

SkuDescription

Description of a SKU for a scalable resource.

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

WorkerPoolResource

Worker pool of an App Service Environment ARM resource.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.computeMode	ComputeModeOptions	Shared or dedicated app hosting.
properties.instanceNames	string[]	Names of all instances in the worker pool (read only).
properties.workerCount	integer	Number of instances in the worker pool.
properties.workerSize	string	VM size of the worker pool instances.
properties.workerSizeId	integer	Worker size ID for referencing this worker pool.
sku	SkuDescription	Description of a SKU for a scalable resource.
type	string	Resource type.

Share via