Azure 监视 REST API 演练

项目
2025/03/24

使用 Azure Monitor API 检索指标定义、维度值和指标值，并在你的应用程序中使用这些数据或存储在数据库中进行分析。还可以使用 Azure Monitor API 列出警报规则并查看活动日志。

对 Azure Monitor 请求进行身份验证

使用 Azure Monitor API 提交的请求使用 Azure 资源管理器身份验证模型。所有请求都使用 Microsoft Entra ID 进行身份验证。要对客户端应用程序进行身份验证，一种方法是创建 Microsoft Entra 服务主体，并检索身份验证令牌。可以使用 Azure 门户、CLI 或 PowerShell 创建 Microsoft Entra 服务主体。有关详细信息，请参阅注册应用以请求授权令牌并使用 API。

获取令牌

创建服务主体后，请获取访问令牌。请在令牌请求中指定 resource=https://management.chinacloudapi.cn。

使用以下任一方法获取身份验证令牌：

CLI
REST API
SDK

在请求令牌时，必须提供 resource 参数。 resource 参数是你要访问的资源的 URL。

资源包括：

https://management.chinacloudapi.cn
https://api.loganalytics.io
https://monitoring.azure.cn

使用 REST 请求获取令牌

使用以下 REST API 调用来获取令牌。此请求使用客户端 ID 和客户端密码对请求进行身份验证。客户端 ID 和客户端密码是在你向 Microsoft Entra ID 注册应用程序时获取的。有关详细信息，请参阅注册应用以请求授权令牌并使用 API

curl -X POST 'https://login.partner.microsoftonline.cn/<tennant ID>/oauth2/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=<your apps client ID>' \
--data-urlencode 'client_secret=<your apps client secret' \
--data-urlencode 'resource=https://monitoring.azure.cn'

响应正文格式如下：

{
    "token_type": "Bearer",
    "expires_in": "86399",
    "ext_expires_in": "86399",
    "expires_on": "1672826207",
    "not_before": "1672739507",
    "resource": "https://monitoring.azure.cn",
    "access_token": "eyJ0eXAiOiJKV1Qi....gpHWoRzeDdVQd2OE3dNsLIvUIxQ"
}

使用 Azure CLI 获取令牌

若要使用 CLI 获取令牌，可以使用以下命令

az account get-access-token

有关详细信息，请参阅 az account get-access-token

使用 SDK 获取令牌

以下代码示例演示了如何使用以下语言获取令牌：

C#
NodeJS
Python

C#

以下代码示例演示了如何使用 Azure 获取令牌。标识库它需要使用客户端 ID 和客户端密码对请求进行身份验证。

var context = new AuthenticationContext("https://login.partner.microsoftonline.cn/<tennant ID>");
var clientCredential = new ClientCredential("<your apps client ID>", "<your apps client secret>");
var result = context.AcquireTokenAsync("https://monitoring.azure.cn", clientCredential).Result;

另外，你也可以使用 DefaultAzureCredential 类来获取令牌。此方法使用默认 Azure 凭据对请求进行身份验证，不需要客户端 ID 或客户端密码。

var credential = new DefaultAzureCredential();
var token = credential.GetToken(new TokenRequestContext(new[] { "https://management.chinacloudapi.cn/.default" }));

还可以如下所示指定托管标识或服务主体凭据：

string userAssignedClientId = "<your managed identity client ID>";
var credential = new DefaultAzureCredential(
    new DefaultAzureCredentialOptions
    {
        ManagedIdentityClientId = userAssignedClientId
    });

var token = credential.GetToken(new TokenRequestContext(new[] { "https://management.chinacloudapi.cn/.default" }));

有关详细信息，请参阅 DefaultAzureCredential 类

Node.js

有关使用 JavaScript 和 NodeJS 进行身份验证的信息，请参阅如何使用 Azure SDK for JavaScript 向 Azure 服务证明 JavaScript 应用的身份

以下示例演示了如何使用 DefaultAzureCredential 类获取令牌。此方法使用默认 Azure 凭据对请求进行身份验证，不需要客户端 ID 或客户端密码。

const { DefaultAzureCredential } = require("@azure/identity");

const credential = new DefaultAzureCredential();
const accessToken = await credential.getToken("https://management.chinacloudapi.cn/.default");

你还可以使用 InteractiveBrowserCredential 类来获取凭据。此方法提供了基于浏览器的身份验证体验供用户用来向 Azure 服务进行身份验证。

有关详细信息，请参阅 DefaultAzureCredential 类和 InteractiveBrowserCredential 类

另外，你也可以使用 ClientSecretCredential 类来获取令牌。此方法需要使用客户端 ID 和客户端密码对请求进行身份验证。

const { ClientSecretCredential } = require("@azure/identity");
credential = ClientSecretCredential(
    client_id="<client_id>",
    username="<username>",
    password="<password>"
   )
const accessToken = await credential.getToken("https://management.chinacloudapi.cn/.default");

有关详细信息，请参阅 ClientSecretCredential 类

Python

以下示例演示了如何使用 DefaultAzureCredential 类获取令牌。此方法使用默认 Azure 凭据对请求进行身份验证，不需要客户端 ID 或客户端密码。

from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
token = credential.get_token('https://management.chinacloudapi.cn/.default')
print(token.token)

你还可以使用 InteractiveBrowserCredential 类来获取凭据。此方法提供了基于浏览器的身份验证体验供用户用来向 Azure 服务进行身份验证。

有关详细信息，请参阅 DefaultAzureCredential 类和 InteractiveBrowserCredential 类

另外，你也可以使用 ClientSecretCredential 类来获取令牌。此方法需要使用客户端 ID 和客户端密码对请求进行身份验证。

from azure.identity import ClientSecretCredential

credential = ClientSecretCredential (
     tenant_id="<tenant id>",
     client_id="<Client id>",
     client_secret="client secret"
    )
token =  credential.get_token("https://management.chinacloudapi.cn/.default")
print(token.token)

有关详细信息，请参阅 ClientSecretCredential 类

验证和检索令牌后，在 Azure Monitor API 请求中使用该访问令牌，方法是包括标头 'Authorization: Bearer <access token>'

备注

有关使用 Azure REST API 的详细信息，请参阅 Azure REST API 参考。

检索资源 ID

使用 REST API 需要目标 Azure 资源的资源 ID。资源 ID 遵循以下模式：

/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/<provider>/<resource name>/

例如

Azure IoT 中心: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Devices/IotHubs/<iot-hub-name>
弹性 SQL pool: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Sql/servers/<pool-db>/elasticpools/<sql-pool-name>
Azure SQL 数据库(v12): /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Sql/servers/<server-name>/databases/<database-name>
Azure 服务总线: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.ServiceBus/<namespace>/<servicebus-name>
Azure 虚拟机规模集: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Compute/virtualMachineScaleSets/<vm-name>
Azure 虚拟机: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Compute/virtualMachines/<vm-name>
Azure 事件中心: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.EventHub/namespaces/<eventhub-namespace>

使用 Azure 门户、PowerShell 或 Azure CLI 查找资源 ID。

要在门户中查找 resourceID，请从资源的概述页面中选择“JSON 视图”

随即将显示“资源 JSON”页。可以使用该 ID 右侧的图标复制资源 ID。

也可以使用 Azure PowerShell cmdlet 检索资源 ID。例如，若要获取某个 Azure 逻辑应用的资源 ID，请执行 Get-AzureLogicApp cmdlet，如以下示例中所示：

Get-AzLogicApp -ResourceGroupName azmon-rest-api-walkthrough -Name contosotweets

结果应类似于以下示例：

Id             : /subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Logic/workflows/ContosoTweets
Name           : ContosoTweets
Type           : Microsoft.Logic/workflows
Location       : chinaeast2
ChangedTime    : 8/21/2017 6:58:57 PM
CreatedTime    : 8/18/2017 7:54:21 PM
AccessEndpoint : https://prod-08.centralus.logic.azure.com:443/workflows/f3a91b352fcc47e6bff989b85446c5db
State          : Enabled
Definition     : {$schema, contentVersion, parameters, triggers...}
Parameters     : {[$connections, Microsoft.Azure.Management.Logic.Models.WorkflowParameter]}
SkuName        :
AppServicePlan :
PlanType       :
PlanId         :
Version        : 08586982649483762729

若要使用 Azure CLI 检索某个 Azure 存储帐户的资源 ID，请执行 az storage account show 命令，如以下示例中所示：

az storage account show -g azmon-rest-api-walkthrough -n azmonstorage001

结果应类似于以下示例：

{
  "accessTier": null,
  "creationTime": "2023-08-18T19:58:41.840552+00:00",
  "customDomain": null,
  "enableHttpsTrafficOnly": false,
  "encryption": null,
  "id": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/azmonstorage001",
  "identity": null,
  "kind": "Storage",
  "lastGeoFailoverTime": null,
  "location": "chinaeast2",
  "name": "azmonstorage001",
  "networkAcls": null,
  "primaryEndpoints": {
    "blob": "https://azmonstorage001.blob.core.chinacloudapi.cn/",
    "file": "https://azmonstorage001.file.core.chinacloudapi.cn/",
    "queue": "https://azmonstorage001.queue.core.chinacloudapi.cn/",
    "table": "https://azmonstorage001.table.core.chinacloudapi.cn/"
  },
  "primaryLocation": "chinaeast2",
  "provisioningState": "Succeeded",
  "resourceGroup": "azmon-rest-api-walkthrough",
  "secondaryEndpoints": null,
  "secondaryLocation": "chinanorth2",
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "statusOfPrimary": "available",
  "statusOfSecondary": "available",
  "tags": {},
  "type": "Microsoft.Storage/storageAccounts"
}

备注

目前无法通过 Azure CLI 使用 Azure 逻辑应用。因此，前面的示例显示了 Azure 存储帐户。

API 端点

API 终结点将使用以下模式：
/<resource URI>/providers/microsoft.insights/<metrics|metricDefinitions>?api-version=<apiVersion>
resource URI 由以下部分组成：
/subscriptions/<subscription id>/resourcegroups/<resourceGroupName>/providers/<resourceProviderNamespace>/<resourceType>/<resourceName>/

重要

进行 API 调用以检索指标或指标定义时，请确保在资源 URI 后面添加 /providers/microsoft.insights/。

检索指标定义

使用 Azure Monitor 指标定义 REST API 访问服务可用的指标列表。使用以下请求格式检索指标定义。

GET /subscriptions/<subscription id>/resourcegroups/<resourceGroupName>/providers/<resourceProviderNamespace>/<resourceType>/<resourceName>/providers/microsoft.insights/metricDefinitions?api-version=<apiVersion>
Host: management.chinacloudapi.cn
Content-Type: application/json
Authorization: Bearer <access token>

例如，以下请求检索 Azure 存储帐户的指标定义。

curl --location --request GET 'https://management.chinacloudapi.cn/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage/providers/microsoft.insights/metricDefinitions?api-version=2018-01-01'
--header 'Authorization: Bearer eyJ0eXAiOi...xYz

以下 JSON 显示了一个响应正文示例。在此示例中，只有第二个指标具有维度。

{
    "value": [
        {
            "id": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage/providers/microsoft.insights/metricdefinitions/UsedCapacity",
            "resourceId": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage",
            "namespace": "Microsoft.Storage/storageAccounts",
            "category": "Capacity",
            "name": {
                "value": "UsedCapacity",
                "localizedValue": "Used capacity"
            },
            "isDimensionRequired": false,
            "unit": "Bytes",
            "primaryAggregationType": "Average",
            "supportedAggregationTypes": [
                "Total",
                "Average",
                "Minimum",
                "Maximum"
            ],
            "metricAvailabilities": [
                {
                    "timeGrain": "PT1H",
                    "retention": "P93D"
                },
                 ...
                {
                    "timeGrain": "PT12H",
                    "retention": "P93D"
                },
                {
                    "timeGrain": "P1D",
                    "retention": "P93D"
                }
            ]
        },
        {
            "id": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage/providers/microsoft.insights/metricdefinitions/Transactions",
            "resourceId": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage",
            "namespace": "Microsoft.Storage/storageAccounts",
            "category": "Transaction",
            "name": {
                "value": "Transactions",
                "localizedValue": "Transactions"
            },
            "isDimensionRequired": false,
            "unit": "Count",
            "primaryAggregationType": "Total",
            "supportedAggregationTypes": [
                "Total"
            ],
            "metricAvailabilities": [
                {
                    "timeGrain": "PT1M",
                    "retention": "P93D"
                },
                {
                    "timeGrain": "PT5M",
                    "retention": "P93D"
                },
                ...
                {
                    "timeGrain": "PT30M",
                    "retention": "P93D"
                },
                {
                    "timeGrain": "PT1H",
                    "retention": "P93D"
                },
                ...
                {
                    "timeGrain": "P1D",
                    "retention": "P93D"
                }
            ],
            "dimensions": [
                {
                    "value": "ResponseType",
                    "localizedValue": "Response type"
                },
                {
                    "value": "GeoType",
                    "localizedValue": "Geo type"
                },
                {
                    "value": "ApiName",
                    "localizedValue": "API name"
                }
            ]
        },
        ...
    ]
}

备注

建议使用 API 版本“2018-01-01”或更高版本。较旧版本的指标定义 API 不支持维度。

检索维度值

检索可用的指标定义后，检索指标维度的值范围。使用维度值筛选或细分查询中的指标。使用 Azure Monitor 指标 REST API 查找给定指标维度的所有值。

在筛选器定义中使用指标的 name.value 元素。如果未指定筛选器，则返回默认指标。此 API 仅允许一个维度具有通配符筛选器。使用 "resultType=metadata" 查询参数指定维度值请求。对于指标值请求，省略 resultType。

备注

若要使用 Azure Monitor REST API 检索维度值，请使用 API 版本“2019-07-01”或更高。

使用以下请求格式检索维度值。

GET /subscriptions/<subscription-id>/resourceGroups/  
<resource-group-name>/providers/<resource-provider-namespace>/  
<resource-type>/<resource-name>/providers/microsoft.insights/  
metrics?metricnames=<metric>  
&timespan=<starttime/endtime>  
&$filter=<filter>  
&resultType=metadata  
&api-version=<apiVersion>   HTTP/1.1
Host: management.chinacloudapi.cn
Content-Type: application/json
Authorization: Bearer <access token>

以下示例检索为 API Name 指标的 Transactions 维度发出的维度值列表，其中在指定时间范围内 GeoType 维度的值为 Primary。

curl --location --request GET 'https://management.chinacloudapi.cn/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage/providers/microsoft.insights/metrics  \
?metricnames=Transactions \
&timespan=2023-03-01T00:00:00Z/2023-03-02T00:00:00Z \
&resultType=metadata \
&$filter=GeoType eq \'Primary\' and ApiName eq \'*\' \
&api-version=2019-07-01'
-header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0e..meG1lWm9Y'

以下 JSON 显示了一个响应正文示例。

{
  "timespan": "2023-03-01T00:00:00Z/2023-03-02T00:00:00Z",
  "value": [
    {
      "id": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage/providers/Microsoft.Insights/metrics/Transactions",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Transactions",
        "localizedValue": "Transactions"
      },
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "apiname",
                "localizedValue": "apiname"
              },
              "value": "DeleteBlob"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "apiname",
                "localizedValue": "apiname"
              },
              "value": "SetBlobProperties"
            }
          ]
        },
        ...
      ]
    }
  ],
  "namespace": "Microsoft.Storage/storageAccounts",
  "resourceregion": "chinanorth"
}

检索指标值

检索完指标定义和维度值后，再检索指标值。使用 Azure Monitor 指标 REST API 检索指标值。

在筛选器定义中使用指标的 name.value 元素。如果未指定维度筛选器，则返回汇总后的聚合指标。

多个时间序列

时序是给定的维度组合按时间排列的一组数据点。维度是度量标准的一个方面，用于描述数据点，例如资源ID、区域或API名称。

若要提取具有特定维度值的多个时序，请指定一个筛选器查询参数，该参数指定两个维度值，例如 "&$filter=ApiName eq 'ListContainers' or ApiName eq 'GetBlobServiceProperties'"。在此示例中，你将得到一个 ApiName 为 ListContainers 的时序，以及 ApiName 为 GetBlobServiceProperties 的另一个时序。
若要返回给定维度的每个值的时序，请使用 * 筛选器，例如 "&$filter=ApiName eq '*'"。使用 Top 和 OrderBy 查询参数来限制返回的时序数并对其排序。在此示例中，结果集将针对每个 ApiName 值返回一个时序。如果没有数据返回，则 API 返回一个空时序 "timeseries": []。

备注

若要使用 Azure Monitor REST API 检索多维指标值，请使用 API 版本“2019-07-01”或更高。

使用以下请求格式检索指标值。

GET /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/<resource-provider-namespace>/<resource-type>/<resource-name>/providers/microsoft.insights/metrics?metricnames=<metric>&timespan=<starttime/endtime>&$filter=<filter>&interval=<timeGrain>&aggregation=<aggreation>&api-version=<apiVersion>
Host: management.chinacloudapi.cn
Content-Type: application/json
Authorization: Bearer <access token>

以下示例按 5 分钟范围内的 Transactions 数（降序）检索前三个 API，其中 GeoType 维度的值为 Primary。

curl --location --request GET 'https://management.chinacloudapi.cn/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage/providers/microsoft.insights/metrics \
?metricnames=Transactions \
&timespan=2023-03-01T02:00:00Z/2023-03-01T02:05:00Z \
& $filter=apiname eq '\''GetBlobProperties'\'
&interval=PT1M \
&aggregation=Total  \
&top=3 \
&orderby=Total desc \
&api-version=2019-07-01"' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer yJ0eXAiOi...g1dCI6Ii1LS'

以下 JSON 显示了一个响应正文示例。

{
  "cost": 0,
  "timespan": "2023-03-01T02:00:00Z/2023-03-01T02:05:00Z",
  "interval": "PT1M",
  "value": [
    {
      "id": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/azmon-rest-api-walkthrough/providers/Microsoft.Storage/storageAccounts/ContosoStorage/providers/Microsoft.Insights/metrics/Transactions",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Transactions",
        "localizedValue": "Transactions"
      },
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "apiname",
                "localizedValue": "apiname"
              },
              "value": "GetBlobProperties"
            }
          ],
          "data": [
            {
              "timeStamp": "2023-09-19T02:00:00Z",
              "total": 2
            },
            {
              "timeStamp": "2023-09-19T02:01:00Z",
              "total": 1
            },
            {
              "timeStamp": "2023-09-19T02:02:00Z",
              "total": 3
            },
            {
              "timeStamp": "2023-09-19T02:03:00Z",
              "total": 7
            },
            {
              "timeStamp": "2023-09-19T02:04:00Z",
              "total": 2
            }
          ]
        },
        ...
      ]
    }
  ],
  "namespace": "Microsoft.Storage/storageAccounts",
  "resourceregion": "chinanorth"
}

一次性查询多个资源的指标。

除了查询单个资源的指标外，某些资源类型还支持在单个请求中查询多个资源。这些 API 为 Azure 指标资源管理器中的多资源体验提供了支持。可以通过上下文边栏选项卡上范围选择器中的资源类型下拉列表在 Azure Monitor 的“指标”边栏选项卡中查看支持查询多个指标的资源类型集。有关详细信息，请参阅多资源 UX 文档。

查询多个资源和单个资源的指标之间存在一些重要差异。

指标多资源 API 在订阅级别而不是资源 ID 级别运行。此限制意味着查询这些 API 的用户必须对订阅本身具有监控查看者权限。
指标多资源 API 仅支持每个查询一个资源类型，这必须通过指标命名空间查询参数来指定。
支持多个资源的指标 API 在每个查询中仅支持单个 Azure 区域，这必须通过区域查询参数来指定。

针对多个资源的查询指标示例

以下示例显示了各个指标定义请求：

GET https://management.chinacloudapi.cn/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/EASTUS-TESTING/providers/Microsoft.Compute/virtualMachines/TestVM1/providers/microsoft.insights/metricdefinitions?api-version=2021-05-01

以下请求显示了多个资源的等效指标定义请求。唯一的更改是订阅路径而不是资源 ID 路径，以及添加了 region 和 metricNamespace 查询参数。

GET https://management.chinacloudapi.cn/subscriptions/12345678-abcd-98765432-abcdef012345/providers/microsoft.insights/metricdefinitions?api-version=2021-05-01&region=chinanorth&metricNamespace=microsoft.compute/virtualmachines

以下示例显示了单个指标请求。

GET https://management.chinacloudapi.cn/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/EASTUS-TESTING/providers/Microsoft.Compute/virtualMachines/TestVM1/providers/microsoft.Insights/metrics?timespan=2023-06-25T22:20:00.000Z/2023-06-26T22:25:00.000Z&interval=PT5M&metricnames=Percentage CPU&aggregation=average&api-version=2021-05-01

下面是面向多个资源的等效指标请求：

GET https://management.chinacloudapi.cn/subscriptions/12345678-abcd-98765432-abcdef012345/providers/microsoft.Insights/metrics?timespan=2023-06-25T22:20:00.000Z/2023-06-26T22:25:00.000Z&interval=PT5M&metricnames=Percentage CPU&aggregation=average&api-version=2021-05-01&region=chinanorth&metricNamespace=microsoft.compute/virtualmachines&$filter=Microsoft.ResourceId eq '*'

备注

在多资源指标请求示例中添加了 Microsoft.ResourceId eq '*' 筛选器。 * 筛选器指示 API 为在订阅和区域中有数据的每个虚拟机资源返回一个单独的时序。如果没有筛选器，API 将会返回聚合了所有 VM 的平均 CPU 的单个时序。每个资源的时序由每个时序条目的 Microsoft.ResourceId 元数据值进行区分，如以下示例返回值所示。如果此查询未检索 resourceId，则返回空时序"timeseries": []。

{
    "timespan": "2023-06-25T22:35:00Z/2023-06-26T22:40:00Z",
    "interval": "PT6H",
    "value": [
        {
            "id": "subscriptions/12345678-abcd-98765432-abcdef012345/providers/Microsoft.Insights/metrics/Percentage CPU",
            "type": "Microsoft.Insights/metrics",
            "name": {
                "value": "Percentage CPU",
                "localizedValue": "Percentage CPU"
            },
            "displayDescription": "The percentage of allocated compute units that are currently in use by the Virtual Machine(s)",
            "unit": "Percent",
            "timeseries": [
                {
                    "metadatavalues": [
                        {
                            "name": {
                                "value": "Microsoft.ResourceId",
                                "localizedValue": "Microsoft.ResourceId"
                            },
                            "value": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/EASTUS-TESTING/providers/Microsoft.Compute/virtualMachines/TestVM1"
                        }
                    ],
                    "data": [
                        {
                            "timeStamp": "2023-06-25T22:35:00Z",
                            "average": 3.2618888888888886
                        },
                        {
                            "timeStamp": "2023-06-26T04:35:00Z",
                            "average": 4.696944444444445
                        },
                        {
                            "timeStamp": "2023-06-26T10:35:00Z",
                            "average": 6.19701388888889
                        },
                        {
                            "timeStamp": "2023-06-26T16:35:00Z",
                            "average": 2.630347222222222
                        },
                        {
                            "timeStamp": "2023-06-26T22:35:00Z",
                            "average": 21.288999999999998
                        }
                    ]
                },
                {
                    "metadatavalues": [
                        {
                            "name": {
                                "value": "Microsoft.ResourceId",
                                "localizedValue": "Microsoft.ResourceId"
                            },
                            "value": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/EASTUS-TESTING/providers/Microsoft.Compute/virtualMachines/TestVM2"
                        }
                    ],
                    "data": [
                        {
                            "timeStamp": "2023-06-25T22:35:00Z",
                            "average": 7.567069444444444
                        },
                        {
                            "timeStamp": "2023-06-26T04:35:00Z",
                            "average": 5.111835883171071
                        },
                        {
                            "timeStamp": "2023-06-26T10:35:00Z",
                            "average": 10.078277777777778
                        },
                        {
                            "timeStamp": "2023-06-26T16:35:00Z",
                            "average": 8.399097222222222
                        },
                        {
                            "timeStamp": "2023-06-26T22:35:00Z",
                            "average": 2.647
                        }
                    ]
                },
                {
                    "metadatavalues": [
                        {
                            "name": {
                                "value": "Microsoft.ResourceId",
                                "localizedValue": "Microsoft.ResourceId"
                            },
                            "value": "/subscriptions/12345678-abcd-98765432-abcdef012345/resourceGroups/Common-TESTING/providers/Microsoft.Compute/virtualMachines/CommonVM1"
                        }
                    ],
                    "data": [
                        {
                            "timeStamp": "2023-06-25T22:35:00Z",
                            "average": 6.892319444444444
                        },
                        {
                            "timeStamp": "2023-06-26T04:35:00Z",
                            "average": 3.5054305555555554
                        },
                        {
                            "timeStamp": "2023-06-26T10:35:00Z",
                            "average": 8.398817802503476
                        },
                        {
                            "timeStamp": "2023-06-26T16:35:00Z",
                            "average": 6.841666666666667
                        },
                        {
                            "timeStamp": "2023-06-26T22:35:00Z",
                            "average": 3.3850000000000002
                        }
                    ]
                }
            ],
            "errorCode": "Success"
        }
    ],
    "namespace": "microsoft.compute/virtualmachines",
    "resourceregion": "chinanorth"
}

排除查询多个资源的指标时的故障

返回了空的时间序列 "timeseries": []
- 当没有可用于指定时间范围和筛选器的数据时，将返回空时序。最常见的原因是指定的时间范围不包含任何数据。例如，如果时间范围设置为将来的日期。
- 另一个常见原因是指定的筛选器与任何资源不匹配。例如，如果筛选器指定订阅和区域组合中的任何资源上不存在的维度值，则返回 "timeseries": []。
通配符筛选器
使用通配符筛选器（例如 Microsoft.ResourceId eq '*'）会导致 API 返回订阅和区域中每个 resourceId 的时序。如果订阅和区域组合不包含任何资源，则返回空时序。没有通配符筛选器的相同查询将返回单个时序，将请求的指标聚合到请求的维度上，例如订阅和区域。
401 授权错误：
单个资源指标 API 要求用户对要查询的资源具有监控读取者权限。由于多资源指标 API 是订阅级 API，因此用户必须对所查询订阅具有监视读者权限才能使用多资源指标 API。即使用户对订阅中的所有资源具有监控读取者权限，如果对该订阅本身没有该权限，请求也会失败。
529 限制错误 529 错误代码表示指标后端当前正在限制请求。建议的操作是实施指数退避算法的重试方案。有关限制的详细信息，请参阅了解 Azure 资源管理器如何限制请求。

未来属于你

通过

对 Azure Monitor 请求进行身份验证

获取令牌

使用 REST 请求获取令牌

使用 Azure CLI 获取令牌

使用 SDK 获取令牌

C#

Node.js

Python

检索资源 ID

API 端点

检索指标定义

检索维度值

检索指标值

多个时间序列

一次性查询多个资源的指标。

针对多个资源的查询指标示例

排除查询多个资源的指标时的故障

后续步骤

通过

Azure 监视 REST API 演练

对 Azure Monitor 请求进行身份验证

获取令牌

使用 REST 请求获取令牌

检索资源 ID

API 端点

检索指标定义

检索维度值

检索指标值

多个时间序列

一次性查询多个资源的指标。

针对多个资源的查询指标示例

排除查询多个资源的指标时的故障

后续步骤

其他资源