Metrics - List

Lista os valores métricos de um recurso.

GET https://management.azure.com/{resourceUri}/providers/microsoft.insights/metrics?api-version=2018-01-01
GET https://management.azure.com/{resourceUri}/providers/microsoft.insights/metrics?timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&api-version=2018-01-01&metricnamespace={metricnamespace}

Parâmetros do URI

Name In Required Type Description
resourceUri
path True
  • string

O identificador do recurso.

api-version
query True
  • string

A versão API a ser utilizada para esta operação.

$filter
query
  • string

O $filter é usado para reduzir o conjunto de dados métricos devolvidos.
Exemplo:
A métrica contém metadados A, B e C.
- Devolva todas as séries temporítem 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'
Isto é inválido porque o operador lógico ou operador não pode separar dois nomes de metadados diferentes.
- Devolva todas as séries de tempo em que A = a1, B = b1 e C = c1:
$filter=A eq 'a1' e B eq 'b1' e C eq 'c1'
- Devolva todas as séries de tempo onde A = a1
$filter=A eq 'a1' e B eq ' e C eq '.

aggregation
query
  • string

A lista de tipos de agregação (vírgula separada) para recuperar.

interval
query
  • string
duration

O intervalo (isto é, timegrain) da consulta.

metricnames
query
  • string

Os nomes das métricas (vírgula separada) para recuperar.

metricnamespace
query
  • string

Espaço de nome métrico para consulta definições métricas para.

orderby
query
  • string

A agregação a utilizar para classificar resultados e a direção do tipo. Apenas uma encomenda pode ser especificada. Exemplos: soma asc.

resultType
query

Reduz o conjunto de dados recolhidos. A sintaxe permitida depende da operação. Consulte a descrição da operação para mais detalhes.

timespan
query
  • string

O tempo da consulta. Trata-se de uma cadeia com o seguinte formato 'startDateTime_ISO/endDateTime_ISO'.

top
query
  • integer
int32

O número máximo de registos para recuperar. Válido apenas se $filter for especificado. Incumprimentos para 10.

Respostas

Name Type Description
200 OK

Pedido bem sucedido para obter a lista de valores métricos.

Other Status Codes

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Get Metric for data
Get Metric for metadata

Get Metric for data

Sample Request

GET https://management.azure.com/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/microsoft.insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&interval=PT1M&aggregation=Average,count&top=3&orderby=Average asc&$filter=BlobType eq '*'&api-version=2018-01-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices

Sample Response

{
  "cost": 0,
  "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
  "interval": "PT1M",
  "namespace": "Microsoft.Storage/storageAccounts/blobServices",
  "resourceregion": "eastus2",
  "value": [
    {
      "id": "/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCapacity",
        "localizedValue": "Blob Capacity"
      },
      "unit": "Bytes",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "PageBlob"
            }
          ],
          "data": [
            {
              "timeStamp": "2017-04-14T02:20:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:21:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:22:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:23:00Z",
              "count": 1,
              "average": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "BlockBlob"
            }
          ],
          "data": [
            {
              "timeStamp": "2017-04-14T02:20:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:21:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:22:00Z",
              "count": 0
            },
            {
              "timeStamp": "2017-04-14T02:23:00Z",
              "count": 1,
              "average": 245
            }
          ]
        }
      ]
    }
  ]
}

Get Metric for metadata

Sample Request

GET https://management.azure.com/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/microsoft.insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&interval=PT1M&aggregation=Average,count&top=3&orderby=Average asc&$filter=BlobType eq '*'&api-version=2018-01-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices

Sample Response

{
  "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
  "namespace": "Microsoft.Storage/storageAccounts/blobServices",
  "resourceregion": "eastus2",
  "value": [
    {
      "id": "/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCapacity",
        "localizedValue": "Blob Capacity"
      },
      "unit": "Bytes",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "BlockBlob"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "PageBlob"
            }
          ]
        }
      ]
    }
  ]
}

Definições

ErrorResponse

Descreve o formato de resposta de Erro.

LocalizableString

A classe de cordas ómis.

MetadataValue

Representa um valor métrico de metadados.

Metric

Os dados do resultado de uma consulta.

MetricValue

Representa um valor métrico.

Response

A resposta a uma consulta de métricas.

ResultType

Reduz o conjunto de dados recolhidos. A sintaxe permitida depende da operação. Consulte a descrição da operação para mais detalhes.

TimeSeriesElement

Um tipo de resultado de série de tempo. O valor discriminatório é sempre TimeSeries neste caso.

Unit

a unidade da métrica.

ErrorResponse

Descreve o formato de resposta de Erro.

Name Type Description
code
  • string

Código de erro

message
  • string

Mensagem de erro indicando por que a operação falhou.

LocalizableString

A classe de cordas ómis.

Name Type Description
localizedValue
  • string

o valor específico local.

value
  • string

o valor invariante.

MetadataValue

Representa um valor métrico de metadados.

Name Type Description
name

o nome dos metadados.

value
  • string

o valor dos metadados.

Metric

Os dados do resultado de uma consulta.

Name Type Description
id
  • string

o ID métrico.

name

o nome e o nome de exibição da métrica, ou seja, é uma corda óperável.

timeseries

a série de tempos devolvida quando uma consulta de dados é realizada.

type
  • string

o tipo de recurso do recurso métrico.

unit

a unidade da métrica.

MetricValue

Representa um valor métrico.

Name Type Description
average
  • number

o valor médio no intervalo de tempo.

count
  • number

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

o maior valor na faixa de tempo.

minimum
  • number

o menor valor no intervalo de tempo.

timeStamp
  • string

o tempotampito para o valor métrico no formato ISO 8601.

total
  • number

a soma de todos os valores no intervalo de tempo.

Response

A resposta a uma consulta de métricas.

Name Type Description
cost
  • number

O valor inteiro que representa o custo da consulta, para o caso dos dados.

interval
  • string

O intervalo (tamanho da janela) para o qual os dados métricos foram devolvidos. Isto pode ser ajustado no futuro e devolvido do que foi originalmente solicitado. Isto não está presente se um pedido de metadados foi feito.

namespace
  • string

O espaço de nome das métricas foi questionado

resourceregion
  • string

A região do recurso foi questionada sobre métricas.

timespan
  • string

O tempo para o qual os dados foram recuperados. O seu valor consiste em duas datas concatenadas, separadas por '/'. Isto pode ser ajustado no futuro e devolvido do que foi originalmente solicitado.

value

o valor da coleção.

ResultType

Reduz o conjunto de dados recolhidos. A sintaxe permitida depende da operação. Consulte a descrição da operação para mais detalhes.

Name Type Description
Data
  • string
Metadata
  • string

TimeSeriesElement

Um tipo de resultado de série de tempo. O valor discriminatório é sempre TimeSeries neste caso.

Name Type Description
data

Um conjunto de pontos de dados que representam os valores métricos. Isto só é devolvido se for especificado um tipo de resultado de dados.

metadatavalues

os valores dos metadados devolvidos se $filter foi especificado na chamada.

Unit

a unidade da métrica.

Name Type Description
BitsPerSecond
  • string
ByteSeconds
  • string
Bytes
  • string
BytesPerSecond
  • string
Cores
  • string
Count
  • string
CountPerSecond
  • string
MilliCores
  • string
MilliSeconds
  • string
NanoCores
  • string
Percent
  • string
Seconds
  • string
Unspecified
  • string