Partilhar via


Metrics Batch - Batch

Lista os valores de métrica para vários recursos.

POST {endpoint}/subscriptions/{subscriptionId}/metrics:getBatch?metricnamespace={metricnamespace}&metricnames={metricnames}&api-version=2023-10-01
POST {endpoint}/subscriptions/{subscriptionId}/metrics:getBatch?starttime={starttime}&endtime={endtime}&interval={interval}&metricnamespace={metricnamespace}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&filter={filter}&rollupby={rollupby}&api-version=2023-10-01

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string (url)

O ponto de extremidade regional a ser usado, por exemplo, https://eastus.metrics.monitor.azure.com. A região deve corresponder à região dos recursos solicitados. No que respeita aos recursos globais, a região deve ser «global».

subscriptionId
path True

string (uuid)

O identificador de assinatura para os recursos neste lote.

api-version
query True

string

Versão da API do cliente.

metricnames
query True

string[]

Os nomes das métricas (separadas por vírgula) a serem recuperadas.

metricnamespace
query True

string

Namespace de métrica que contém os nomes de métricas solicitados.

aggregation
query

string

A lista de tipos de agregação (separados por vírgula) a serem recuperados. Exemplos: média, mínima, máxima

endtime
query

string

A hora de término da consulta. É uma string no formato 'yyyy-MM-ddTHH:mm:ss.fffZ'.

filter
query

string

O filtro é usado para reduzir o conjunto de dados métricos retornados.
Exemplo:
A métrica contém metadados A, B e C.
- Retornar todas as séries temporais de C onde A = a1 e B = b1 ou b2
filter=A eq 'a1' e B eq 'b1' ou B eq 'b2' e C eq '*'
- Variante inválida:
filter=A eq 'a1' e B eq 'b1' e C eq '*' ou B = 'b2'
Isso é inválido porque o operador lógico ou não pode separar dois nomes de metadados diferentes.
- Retornar todas as séries temporais onde A = a1, B = b1 e C = c1:
filter=A eq 'a1' e B eq 'b1' e C eq 'c1'
- Retornar todas as séries temporais onde A = a1
filter=A eq 'a1' e B eq '' e C eq ''.

interval
query

string

O intervalo (ou seja, timegrain) da consulta no formato de duração ISO 8601. O padrão é PT1M. Caso especial para o valor 'FULL' que retorna um único ponto de dados para todo o período de tempo solicitado. Exemplos: PT15M, PT1H, P1D, FULL

orderby
query

string

A agregação a ser usada para classificar resultados e a direção da classificação. Apenas uma ordem pode ser especificada. Exemplos: sum asc

rollupby
query

string

Nome(s) da(s) dimensão(ões) para acumular resultados. Por exemplo, se você quiser ver apenas valores métricos com um filtro como 'City eq Seattle ou City eq Tacoma', mas não quiser ver valores separados para cada cidade, você pode especificar 'RollUpBy=City' para ver os resultados de Seattle e Tacoma agrupados em uma série temporal.

starttime
query

string

A hora de início da consulta. É uma string no formato 'yyyy-MM-ddTHH:mm:ss.fffZ'. Se você tiver especificado o parâmetro endtime, esse parâmetro será necessário. Se apenas starttime for especificado, o endtime será padronizado para a hora atual. Se nenhum intervalo de tempo for especificado, o padrão será 1 hora.

top
query

integer (int32)

O número máximo de registros a serem recuperados por ID de recurso na solicitação. Válido somente se o filtro for especificado. O padrão é 10.

Corpo do Pedido

Name Tipo Description
resourceids

string[] (arm-id)

A lista de IDs de recursos para as quais consultar métricas.

Respostas

Name Tipo Description
200 OK

MetricResultsResponse

A resposta a uma consulta de métricas.

Other Status Codes

ErrorResponse

Descreve o formato de Resposta de erro.

Cabeçalhos

x-ms-error-code: string

Segurança

AADToken

Autenticação OAuth2 do Azure Ative Directory

Tipo: oauth2
Fluxo: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Âmbitos

Name Description
https://metrics.monitor.azure.com/.default https://metrics.monitor.azure.com/.default

Exemplos

Query Redis Metrics summary
Query Storage Metrics

Query Redis Metrics summary

Pedido de amostra

POST {endpoint}/subscriptions/12345678-abcd-1234-abcd-123456789abc/metrics:getBatch?starttime=2023-11-07T14:00:00.000Z&endtime=2023-11-07T18:00:00.000Z&interval=FULL&metricnamespace=Microsoft.Cache/Redis&metricnames=cacheWrite&aggregation=average&top=10&orderby=average desc&filter=ShardId eq '0'&rollupby=ShardId&api-version=2023-10-01

{
  "resourceids": [
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2"
  ]
}

Resposta da amostra

{
  "values": [
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 35513.760416666664
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5"
    },
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 7135.0625
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3"
    },
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 6723.489583333333
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2"
    }
  ]
}
x-ms-error-code: BadRequest
{
  "error": {
    "additionalInfo": [
      {
        "type": "string",
        "info": "TraceId=dd033ebf1e260d815f4bccad149bbc15"
      },
      {
        "type": "string",
        "info": "ExceptionType=Microsoft.Online.Metrics.MetricsMP.Utilities.RPRequestFormatException"
      }
    ],
    "code": "BadRequest",
    "message": "Detected invalid time range parameters for API version 2023-10-01. Please use only starttime and endtime to specify a time range."
  }
}

Query Storage Metrics

Pedido de amostra

POST {endpoint}/subscriptions/12345678-abcd-1234-abcd-123456789abc/metrics:getBatch?starttime=2023-02-01T20:00:00.123Z&endtime=2023-02-01T23:00:00.345Z&interval=PT15M&metricnamespace=Microsoft.Storage/storageAccounts&metricnames=Ingress,Egress&aggregation=average,minimum,maximum&top=10&orderby=average desc&filter=ApiName eq 'GetBlob' or ApiName eq 'GetBlobServiceProperties' and Authentication eq '*'&api-version=2023-10-01

{
  "resourceids": [
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2"
  ]
}

Resposta da amostra

{
  "values": [
    {
      "starttime": "2023-02-01T20:00:00.123Z",
      "endtime": "2023-02-01T23:00:00.345Z",
      "interval": "PT15M",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Ingress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Ingress",
            "localizedValue": "Ingress"
          },
          "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlob"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "SAS"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z",
                  "average": 437.54477611940297,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z",
                  "average": 437.54477611940297,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z",
                  "average": 437.542750929368,
                  "minimum": 437,
                  "maximum": 583
                }
              ]
            },
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 342,
                  "minimum": 342,
                  "maximum": 342
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        },
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Egress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Egress",
            "localizedValue": "Egress"
          },
          "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 796,
                  "minimum": 796,
                  "maximum": 796
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            },
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlob"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "SAS"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z",
                  "average": 363.4514925373134,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z",
                  "average": 363.4514925373134,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z",
                  "average": 363.4423791821561,
                  "minimum": 361,
                  "maximum": 1018
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.storage/storageaccounts",
      "resourceregion": "eastus",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1"
    },
    {
      "starttime": "2023-02-01T20:00:00.123Z",
      "endtime": "2023-02-01T23:00:00.345Z",
      "interval": "PT15M",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Ingress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Ingress",
            "localizedValue": "Ingress"
          },
          "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 330,
                  "minimum": 330,
                  "maximum": 330
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        },
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Egress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Egress",
            "localizedValue": "Egress"
          },
          "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 880,
                  "minimum": 880,
                  "maximum": 880
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.storage/storageaccounts",
      "resourceregion": "eastus",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2"
    }
  ]
}
x-ms-error-code: BadRequest
{
  "error": {
    "additionalInfo": [
      {
        "type": "string",
        "info": "TraceId={00000000-0000-0000-0000-000000000000}"
      },
      {
        "type": "string",
        "info": "ExceptionType=Microsoft.Online.Metrics.MetricsMP.Utilities.RPRequestFormatException"
      }
    ],
    "code": "BadRequest",
    "message": "Query endTime: 06/06/2021 00:00:00 is out of the Max metrics retention period: 93.00:00:00, traceId: {00000000-0000-0000-0000-000000000000}"
  }
}

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

LocalizableString

A classe de cadeia de caracteres localizável.

MetadataValue

Representa um valor de metadados métricos.

Metric

Os dados de resultado de uma consulta.

MetricResultsResponse

O resultado das métricas para um recurso.

MetricUnit

A unidade da métrica.

MetricValue

Representa um valor métrico.

ResourceIdList

A lista separada por vírgulas de IDs de recursos para consultar métricas.

TimeSeriesElement

Um tipo de resultado de série temporal. Neste caso, o valor discriminador é sempre TimeSeries.

Values

A coleta de respostas de dados métricos por recurso, por métrica.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

LocalizableString

A classe de cadeia de caracteres localizável.

Name Tipo Description
localizedValue

string

O nome para exibição.

value

string

O valor invariante.

MetadataValue

Representa um valor de metadados métricos.

Name Tipo Description
name

LocalizableString

O nome dos metadados.

value

string

O valor dos metadados.

Metric

Os dados de resultado de uma consulta.

Name Tipo Description
displayDescription

string

Descrição detalhada desta métrica.

errorCode

string

'Sucesso' ou os detalhes do erro em falhas de consulta para esta métrica.

errorMessage

string

Mensagem de erro encontrada consultando essa métrica específica.

id

string

A métrica Id.

name

LocalizableString

O nome e o nome de exibição da métrica, ou seja, é uma cadeia de caracteres localizável.

timeseries

TimeSeriesElement[]

A série temporal retornada quando uma consulta de dados é executada.

type

string

O tipo de recurso do recurso métrico.

unit

MetricUnit

A unidade da métrica.

MetricResultsResponse

O resultado das métricas para um recurso.

Name Tipo Description
values

Values[]

A coleta de respostas de dados métricos por recurso, por métrica.

MetricUnit

A unidade da métrica.

Valor Description
Count

Unidade de quantidade bruta.

Bytes

Unidade de memória em bytes.

Seconds

Unidade de tempo em segundos.

CountPerSecond

Unidade de taxa de quantidade bruta por segundo.

BytesPerSecond

Taxa unidade de memória em bytes por segundo.

Percent

Unidade percentual.

MilliSeconds

Unidade de tempo em 1/1000 de segundo.

ByteSeconds

Unidade de transferência ou armazenamento de dados. É o tamanho dos dados em bytes multiplicado pelo tempo necessário para transferir ou armazenar os dados em segundos.

Unspecified

Nenhuma unidade especificada.

Cores

Unidade de poder de processamento.

MilliCores

Unidade de poder de processamento em 1/1000 de um núcleo de CPU.

NanoCores

Unidade de poder de processamento em um bilionésimo de um núcleo de CPU.

BitsPerSecond

Unidade de taxa de dígitos binários por segundo.

MetricValue

Representa um valor métrico.

Name Tipo Description
average

number (double)

O valor médio no intervalo de tempo.

count

number (double)

O número de amostras no intervalo de tempo. Pode ser usado para determinar o número de valores que contribuíram para o valor médio.

maximum

number (double)

O maior valor no intervalo de tempo.

minimum

number (double)

O menor valor no intervalo de tempo.

timeStamp

string (date-time)

O carimbo de data/hora para o valor da métrica no formato ISO 8601.

total

number (double)

A soma de todos os valores no intervalo de tempo.

ResourceIdList

A lista separada por vírgulas de IDs de recursos para consultar métricas.

Name Tipo Description
resourceids

string[] (arm-id)

A lista de IDs de recursos para as quais consultar métricas.

TimeSeriesElement

Um tipo de resultado de série temporal. Neste caso, o valor discriminador é sempre TimeSeries.

Name Tipo Description
data

MetricValue[]

Uma matriz de pontos de dados que representam os valores métricos. Isso só será retornado se um tipo de resultado de dados for especificado.

metadatavalues

MetadataValue[]

Os valores de metadados retornados se $filter foi especificado na chamada.

Values

A coleta de respostas de dados métricos por recurso, por métrica.

Name Tipo Description
endtime

string

A hora de término, no formato datetime, para a qual os dados foram recuperados.

interval

string

O intervalo (tamanho da janela) para o qual os dados métricos foram retornados no formato de duração ISO 8601 com um caso especial para o valor 'FULL' que retorna um único ponto de dados para todo o período de tempo solicitado (Exemplos: PT15M, PT1H, P1D, FULL). Isso pode ser ajustado e diferente do que foi originalmente solicitado se AutoAdjustTimegrain=true for especificado.

namespace

string

O namespace das métricas foi consultado

resourceid

string

O recurso que foi consultado para métricas.

resourceregion

string

A região do recurso foi consultada para obter métricas.

starttime

string

A hora de início, no formato datetime, para a qual os dados foram recuperados.

value

Metric[]

O valor da coleção.