App Service Environments - List Multi Role Pool Skus

Reference

Service:: App Service

API Version:: 2023-12-01

Description for Get available SKUs for scaling a multi-role pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus?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

Responses

Name	Type	Description
200 OK	SkuInfoCollection	OK
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

Get available SKUs for scaling a multi-role pool.

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "S2",
        "tier": "Standard"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "S3",
        "tier": "Standard"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "S4",
        "tier": "Standard"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "O2",
        "tier": "Optimized"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "O3",
        "tier": "Optimized"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "O4",
        "tier": "Optimized"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "Q1",
        "tier": "Quantum"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "Q2",
        "tier": "Quantum"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "Q3",
        "tier": "Quantum"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    },
    {
      "resourceType": "Microsoft.Web/hostingEnvironments/multiRolePools",
      "sku": {
        "name": "Q4",
        "tier": "Quantum"
      },
      "capacity": {
        "minimum": 2,
        "maximum": 247,
        "default": 2,
        "scaleType": "automatic",
        "elasticMaximum": null
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
Capability	Describes the capabilities/features allowed for a specific SKU.
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.
SkuInfo	SKU discovery information.
SkuInfoCollection	Collection of SKU information.

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.

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.

SkuInfo

SKU discovery information.

Name	Type	Description
capacity	SkuCapacity	Min, max, and default scale values of the SKU.
resourceType	string	Resource type that this SKU applies to.
sku	SkuDescription	Name and tier of the SKU.

SkuInfoCollection

Collection of SKU information.

Name	Type	Description
nextLink	string	Link to next page of resources.
value	SkuInfo[]	Collection of resources.

Share via