你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

App Service Environments - List Worker Pools

参考

Service:: App Service

API Version:: 2023-12-01

获取应用服务环境的所有辅助角色池的说明。

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

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用服务环境的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure 订阅 ID。这是一个 GUID 格式的字符串， (例如 00000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	WorkerPoolCollection	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Get all worker pools of an App Service Environment.

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool1",
      "name": "workerPool1",
      "type": "Microsoft.Web/hostingEnvironments/workerPools",
      "kind": "ASEV1",
      "properties": {
        "workerSizeId": 0,
        "workerSize": "Small",
        "workerCount": 2,
        "instanceNames": []
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool2",
      "name": "workerPool2",
      "type": "Microsoft.Web/hostingEnvironments/workerPools",
      "kind": "ASEV1",
      "properties": {
        "workerSizeId": 1,
        "workerSize": "Small",
        "workerCount": 0,
        "instanceNames": []
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/workerPool3",
      "name": "workerPool3",
      "type": "Microsoft.Web/hostingEnvironments/workerPools",
      "kind": "ASEV1",
      "properties": {
        "workerSizeId": 2,
        "workerSize": "Small",
        "workerCount": 0,
        "instanceNames": []
      }
    }
  ],
  "nextLink": null
}

定义

名称	说明
Capability	描述特定 SKU 允许的功能/功能。
ComputeModeOptions	共享/专用辅助角色。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
SkuCapacity	App 服务计划缩放选项的说明。
SkuDescription	可缩放资源的 SKU 说明。
WorkerPoolCollection	辅助角色池的集合。
WorkerPoolResource	应用服务环境 ARM 资源的辅助角色池。

Capability

描述特定 SKU 允许的功能/功能。

名称	类型	说明
name	string	SKU 功能的名称。
reason	string	SKU 功能的原因。
value	string	SKU 功能的值。

ComputeModeOptions

共享/专用辅助角色。

名称	类型	说明
Dedicated	string
Dynamic	string
Shared	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

SkuCapacity

App 服务计划缩放选项的说明。

名称	类型	说明
default	integer	此App 服务计划 SKU 的默认辅助角色数。
elasticMaximum	integer	此App 服务计划 SKU 的最大弹性辅助角色数。
maximum	integer	此App 服务计划 SKU 的最大辅助角色数。
minimum	integer	此App 服务计划 SKU 的最小辅助角色数。
scaleType	string	App 服务计划的可用缩放配置。

SkuDescription

可缩放资源的 SKU 说明。

名称	类型	说明
capabilities	Capability[]	SKU 的功能，例如是否启用了流量管理器？
capacity	integer	分配给资源的当前实例数。
family	string	资源 SKU 的系列代码。
locations	string[]	SKU 的位置。
name	string	资源 SKU 的名称。
size	string	资源 SKU 的大小说明符。
skuCapacity	SkuCapacity	SKU 的最小、最大和默认缩放值。
tier	string	资源 SKU 的服务层。

WorkerPoolCollection

辅助角色池的集合。

名称	类型	说明
nextLink	string	链接到下一页资源。
value	WorkerPoolResource[]	资源集合。

WorkerPoolResource

应用服务环境 ARM 资源的辅助角色池。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.computeMode	ComputeModeOptions	共享或专用应用托管。
properties.instanceNames	string[]	辅助角色池中所有实例的名称 (只读) 。
properties.workerCount	integer	辅助角色池中的实例数。
properties.workerSize	string	辅助角色池实例的 VM 大小。
properties.workerSizeId	integer	用于引用此辅助角色池的辅助角色大小 ID。
sku	SkuDescription	可缩放资源的 SKU 说明。
type	string	资源类型。