Metrics - List

Elenca i valori delle metriche per una risorsa.

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}

Parametri dell'URI

Name In Required Type Description
resourceUri
path True
  • string

Identificatore della risorsa.

api-version
query True
  • string

Versione dell'API da usare per questa operazione.

$filter
query
  • string

Il $filter viene usato per ridurre il set di dati delle metriche restituiti. Esempio: la metrica contiene i metadati A, B e C. - Restituisce tutte le serie tempore di C in cui A = a1 e B = b1 o b2 $filter=A eq 'a1' e B eq 'b1' o B eq 'b2' e C eq '*' - Variante non valida: $filter=A eq 'a1' e B eq 'b1' e C eq '*' o B = 'b2' Non valido perché l'operatore logico o non può separare due nomi di metadati diversi. - Restituisce tutte le serie tempore in cui A = a1, B = b1 e C = c1: $filter=A eq 'a1' e B eq 'b1' e C eq 'c1' - Restituire tutte le serie tempore in cui A = a1 $filter=A eq 'a1' e B eq 'e C eq ''. Caso speciale: quando il nome della dimensione o il valore della dimensione usa parentesi quadre. Ad esempio: quando il nome della dimensione è dim (test) 1 Invece di usare $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' " Quando** il nome della dimensione è dim (test) 3 e il valore della dimensione è dimm3 (test) val Invece di usare $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' "

aggregation
query
  • string

Elenco di tipi di aggregazione (delimitati da virgole) da recuperare.

interval
query
  • string
duration

Intervallo (ad esempio timegrain) della query.

metricnames
query
  • string

Nomi delle metriche (delimitati da virgole) da recuperare. Caso speciale: se un nome di metrica contiene una virgola, usare %2 per indicarlo. Ad esempio: 'Metric,Name1' deve essere 'Metric%2Name1'

metricnamespace
query
  • string

Spazio dei nomi delle metriche per cui eseguire query nelle definizioni delle metriche.

orderby
query
  • string

Aggregazione da utilizzare per l'ordinamento dei risultati e la direzione dell'ordinamento. È possibile specificare un solo ordine. Esempi: sum asc.

resultType
query

Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione.

timespan
query
  • string

Intervallo di tempo della query. Si tratta di una stringa con il formato "startDateTime_ISO/endDateTime_ISO".

top
query
  • integer
int32

Numero massimo di record da recuperare. Valido solo se $filter specificato. Il valore predefinito è 10.

Risposte

Name Type Description
200 OK

Richiesta riuscita per ottenere l'elenco dei valori delle metriche.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

Get Metric for data
Get Metric for metadata
Get Metric with error

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",
      "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
      "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"
      },
      "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
      "unit": "Bytes",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "BlockBlob"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "blobtype",
                "localizedValue": "blobtype"
              },
              "value": "PageBlob"
            }
          ]
        }
      ]
    }
  ]
}

Get Metric with error

Sample Request

GET https://management.azure.com/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics?timespan=2021-06-07T21:51:00Z/2021-06-08T01:51:00Z&interval=FULL&metricnames=MongoRequestsCount,MongoRequests&aggregation=average&api-version=2018-01-01&metricnamespace=microsoft.documentdb/databaseaccounts

Sample Response

{
  "cost": 239,
  "timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z",
  "interval": "PT4H",
  "value": [
    {
      "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequestsCount",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "MongoRequestsCount",
        "localizedValue": "(deprecated) Mongo Request Rate"
      },
      "unit": "CountPerSecond",
      "timeseries": [],
      "errorMessage": "Sampling type is not found. Metric:CosmosDBCustomer,AzureMonitor,MongoRequests, SamplingType:NullableAverage.",
      "errorCode": "InvalidSamplingType"
    },
    {
      "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequests",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "MongoRequests",
        "localizedValue": "Mongo Requests"
      },
      "displayDescription": "Number of Mongo Requests Made",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [],
          "data": [
            {
              "timeStamp": "2021-06-07T21:51:00Z",
              "average": 0
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.documentdb/databaseaccounts",
  "resourceregion": "westus2"
}

Definizioni

ErrorResponse

Descrive il formato della risposta di errore.

LocalizableString

Classe stringa localizzabile.

MetadataValue

Rappresenta un valore dei metadati della metrica.

Metric

Dati dei risultati di una query.

MetricUnit

Unità della metrica.

MetricValue

Rappresenta un valore della metrica.

Response

Risposta a una query sulle metriche.

ResultType

Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione.

TimeSeriesElement

Tipo di risultato della serie temporale. Il valore discriminante è sempre TimeSeries in questo caso.

ErrorResponse

Descrive il formato della risposta di errore.

Name Type Description
code
  • string

Codice di errore

message
  • string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

LocalizableString

Classe stringa localizzabile.

Name Type Description
localizedValue
  • string

valore specifico delle impostazioni locali.

value
  • string

valore invariante.

MetadataValue

Rappresenta un valore dei metadati della metrica.

Name Type Description
name

nome dei metadati.

value
  • string

valore dei metadati.

Metric

Dati dei risultati di una query.

Name Type Description
displayDescription
  • string

Descrizione dettagliata di questa metrica.

errorCode
  • string

'Success' o i dettagli dell'errore sugli errori di query per questa metrica.

errorMessage
  • string

Messaggio di errore durante l'esecuzione di query su questa metrica specifica.

id
  • string

ID della metrica.

name

il nome e il nome visualizzato della metrica, ad esempio è una stringa localizzabile.

timeseries

serie temporale restituita quando viene eseguita una query sui dati.

type
  • string

tipo di risorsa della risorsa metrica.

unit

Unità della metrica.

MetricUnit

Unità della metrica.

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

MetricValue

Rappresenta un valore della metrica.

Name Type Description
average
  • number

valore medio nell'intervallo di tempo.

count
  • number

numero di campioni nell'intervallo di tempo. Può essere usato per determinare il numero di valori che hanno contribuito al valore medio.

maximum
  • number

il valore più grande nell'intervallo di tempo.

minimum
  • number

il valore minimo nell'intervallo di tempo.

timeStamp
  • string

timestamp per il valore della metrica in formato ISO 8601.

total
  • number

somma di tutti i valori nell'intervallo di tempo.

Response

Risposta a una query sulle metriche.

Name Type Description
cost
  • number

Valore intero che rappresenta il costo relativo della query.

interval
  • string

Intervallo (dimensioni della finestra) in cui sono stati restituiti i dati della metrica. Questa impostazione può essere modificata in futuro e restituita da quanto richiesto in origine. Non è presente se è stata effettuata una richiesta di metadati.

namespace
  • string

Spazio dei nomi delle metriche su cui viene eseguita la query

resourceregion
  • string

Area della risorsa su cui viene eseguita la query per le metriche.

timespan
  • string

Intervallo di tempo per il quale sono stati recuperati i dati. Il valore è costituito da due datetime concatenati, separati da '/'. Questa impostazione può essere modificata in futuro e restituita da quanto richiesto in origine.

value

valore dell'insieme.

ResultType

Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione.

Name Type Description
Data
  • string
Metadata
  • string

TimeSeriesElement

Tipo di risultato della serie temporale. Il valore discriminante è sempre TimeSeries in questo caso.

Name Type Description
data

Matrice di punti dati che rappresentano i valori della metrica. Viene restituito solo se viene specificato un tipo di risultato di dati.

metadatavalues

i valori dei metadati restituiti $filter specificato nella chiamata.