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

App Service Environments - List Web Worker Metric Definitions

参考

Service:: App Service

API Version:: 2023-12-01

获取应用服务环境辅助角色池的指标定义的说明。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions?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) 。
workerPoolName	path	True	string	辅助角色池的名称。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	ResourceMetricDefinitionCollection	确定
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 metric definitions for a worker pool 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/0/metricdefinitions?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "CpuPercentage",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/CpuPercentage",
      "properties": null
    },
    {
      "name": "MemoryPercentage",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/MemoryPercentage",
      "properties": null
    },
    {
      "name": "DiskQueueLength",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/DiskQueueLength",
      "properties": null
    },
    {
      "name": "HttpQueueLength",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/workerPools/0/metricDefinitions/HttpQueueLength",
      "properties": null
    }
  ]
}

定义

名称	说明
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
ResourceMetricAvailability	指标可用性和保留期。
ResourceMetricDefinition	指标的元数据。
ResourceMetricDefinitionCollection	指标定义的集合。

DefaultErrorResponse

App 服务错误响应。

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

Details

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

Error

错误模型。

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

ResourceMetricAvailability

指标可用性和保留期。

名称	类型	说明
retention	string	当前时间粒度的保留期。
timeGrain	string	时间粒度。

ResourceMetricDefinition

指标的元数据。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.metricAvailabilities	ResourceMetricAvailability[]	指标支持的时间粒度列表以及保持期。
properties.primaryAggregationType	string	主要聚合类型。
properties.properties	object	资源指标定义属性。
properties.resourceUri	string	资源 URI。
properties.unit	string	指标的单位。
type	string	资源类型。

ResourceMetricDefinitionCollection

指标定义的集合。

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