Metrics - List At Subscription Scope

Service:

Monitor

API Version:

2023-10-01

Elenchi i dati delle metriche per una sottoscrizione.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region={region}

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region={region}&timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
region	query	True	string	Area in cui si trovano le metriche desiderate.
$filter	query		string	Il $filter viene usato per ridurre il set di dati delle metriche restituiti. Esempio: La metrica contiene metadati A, B e C. - Restituisce tutte le serie temporali di C dove A = a1 e B = b1 o b2 $filter=A eq 'a1' e B eq 'b1' o B eq 'b2' 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 temporali in cui A = a1, B = b1 e C = c1: $filter=A eq 'a1' eq 'b1' e C eq 'c1' - Restituisce tutte le serie temporali in cui A = a1 $filter=A eq 'a1' e B eq '' eq '' eq ''.
aggregation	query		string	Elenco di tipi di aggregazione (delimitati da virgole) da recuperare. Esempi: media, minima, massima
AutoAdjustTimegrain	query		boolean	Quando impostato su true, se il timepan passato non è supportato da questa metrica, l'API restituirà il risultato usando il timepan più vicino supportato. Se impostato su false, viene restituito un errore per i parametri timepan non validi. Il valore predefinito è false.
interval	query		string	Intervallo (ad esempio timegrain) della query nel formato di durata ISO 8601. Il valore predefinito è PT1M. Caso speciale per il valore "FULL" che restituisce un singolo punto dati per l'intero intervallo di tempo richiesto. Esempi: PT15M, PT1H, P1D, FULL
metricnames	query		string	Nomi delle metriche (delimitate da virgole) da recuperare.
metricnamespace	query		string	Spazio dei nomi metrica in cui risiedono le metriche desiderate.
orderby	query		string	Aggregazione da utilizzare per l'ordinamento dei risultati e la direzione dell'ordinamento. È possibile specificare un solo ordine. Esempi: somma asc
resultType	query		MetricResultType	Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione.
rollupby	query		string	Nomi delle dimensioni da cui eseguire il rollup dei risultati. Ad esempio, se si desidera visualizzare solo i valori delle metriche con un filtro come "City eq Seattle o City eq Tacoma" ma non si vogliono visualizzare valori separati per ogni città, è possibile specificare "RollUpBy=City" per visualizzare i risultati per Seattle e Tacoma distribuiti in un'unica volta.
timespan	query		string	Intervallo di tempo della query. Si tratta di una stringa con il formato seguente 'startDateTime_ISO/endDateTime_ISO'.
top	query		integer int32	Numero massimo di record da recuperare per ID risorsa nella richiesta. Valido solo se viene specificato il filtro. Il valore predefinito è 10.
ValidateDimensions	query		boolean	Se impostato su false, i valori dei parametri di filtro non validi verranno ignorati. Se impostato su true, viene restituito un errore per i parametri di filtro non validi. Viene impostato come predefinito true.

Risposte

Nome	Tipo	Descrizione
200 OK	Response	Richiesta riuscita per ottenere l'elenco dei valori delle metriche.
Other Status Codes	ErrorContract	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get subscription level metric data

Get subscription level metric metadata

Get subscription level metric data

Sample Request

HTTP

GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region=westus2&timespan=2021-06-08T19:00:00Z/2021-06-12T01:00:00Z&interval=PT6H&metricnames=Data Disk Max Burst IOPS&aggregation=count&top=10&orderby=count desc&$filter=LUN eq '0' and Microsoft.ResourceId eq '*'&metricnamespace=microsoft.compute/virtualmachines&AutoAdjustTimegrain=True&ValidateDimensions=False

Sample Response

Status code:

200

{
  "cost": 4679,
  "timespan": "2021-06-08T19:00:00Z/2021-06-12T01:00:00Z",
  "interval": "PT6H",
  "value": [
    {
      "id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Max Burst IOPS",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Data Disk Max Burst IOPS",
        "localizedValue": "Data Disk Max Burst IOPS"
      },
      "displayDescription": "Maximum IOPS Data Disk can achieve with bursting",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas1/providers/Microsoft.Compute/virtualMachines/sas1-dev"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 413
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas2/providers/Microsoft.Compute/virtualMachines/sas2-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 133
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas3/providers/Microsoft.Compute/virtualMachines/sas3-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 78
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas4/providers/Microsoft.Compute/virtualMachines/sas4-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas5/providers/Microsoft.Compute/virtualMachines/sas5-vm-asc"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.compute/virtualmachines",
  "resourceregion": "westus2"
}

Status code:

default

{
  "error": {
    "code": "BadRequest",
    "message": "Missing required region params"
  }
}

Get subscription level metric metadata

Sample Request

HTTP

GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region=westus2&timespan=2021-06-10T02:23:16.129Z/2021-06-12T02:23:16.129Z&metricnames=Data Disk Max Burst IOPS&$filter=LUN eq '0'&metricnamespace=microsoft.compute/virtualmachines

Sample Response

Status code:

200

{
  "timespan": "2021-06-10T02:23:16Z/2021-06-12T02:23:16Z",
  "interval": "PT1M",
  "value": [
    {
      "id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Read Bytes/sec",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Data Disk Read Bytes/sec",
        "localizedValue": "Data Disk Read Bytes/Sec"
      },
      "displayDescription": "Bytes/Sec read from a single disk during monitoring period",
      "unit": "BytesPerSecond",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "lun",
                "localizedValue": "lun"
              },
              "value": "0"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "lun",
                "localizedValue": "lun"
              },
              "value": "1"
            }
          ]
        }
      ]
    }
  ],
  "namespace": "microsoft.compute/virtualmachines",
  "resourceregion": "westus2"
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorContract	Risposta di errore
ErrorResponse	Risposta di errore
LocalizableString	Classe stringa localizzabile.
MetadataValue	Rappresenta un valore dei metadati della metrica.
Metric	Dati dei risultati di una query.
MetricResultType	Riduce il set di dati raccolti. La sintassi consentita dipende dall'operazione. Per informazioni dettagliate, vedere la descrizione dell'operazione.
MetricUnit	Unità della metrica.
MetricValue	Rappresenta un valore della metrica.
Response	Risposta a una query sulle metriche.
TimeSeriesElement	Tipo di risultato della serie temporale. Il valore discriminatorio è sempre TimeSeries in questo caso.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorContract

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Oggetto error.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

LocalizableString

Classe stringa localizzabile.

Nome	Tipo	Descrizione
localizedValue	string	Nome visualizzato.
value	string	Valore invariante.

MetadataValue

Rappresenta un valore dei metadati della metrica.

Nome	Tipo	Descrizione
name	LocalizableString	Nome dei metadati.
value	string	Valore dei metadati.

Metric

Dati dei risultati di una query.

Nome	Tipo	Descrizione
displayDescription	string	Descrizione dettagliata di questa metrica.
errorCode	string	"Operazione riuscita" o i dettagli dell'errore relativi agli errori di query per questa metrica.
errorMessage	string	Messaggio di errore durante la query su questa metrica specifica.
id	string	ID metrica.
name	LocalizableString	Il nome e il nome visualizzato della metrica, ovvero è una stringa localizzabile.
timeseries	TimeSeriesElement[]	Serie temporale restituita quando viene eseguita una query di dati.
type	string	Tipo di risorsa della risorsa della metrica.
unit	MetricUnit	Unità della metrica.

MetricResultType

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

Nome	Tipo	Descrizione
Data	string
Metadata	string

MetricUnit

Unità della metrica.

Nome	Tipo	Descrizione
BitsPerSecond	string	Unità di frequenza delle cifre binarie al secondo.
ByteSeconds	string	Unità di trasferimento o archiviazione dei dati. Si tratta delle dimensioni dei dati in byte moltiplicate per il tempo necessario per trasferire o archiviare i dati in secondi.
Bytes	string	Unità di memoria in byte.
BytesPerSecond	string	Unità di frequenza della memoria in byte al secondo.
Cores	string	Unità di potenza di elaborazione.
Count	string	Unità di quantità non elaborata.
CountPerSecond	string	Unità di frequenza della quantità non elaborata al secondo.
MilliCores	string	Unità di potenza di elaborazione in 1/1000 di un core CPU.
MilliSeconds	string	Unità di tempo in 1/1000 di secondo.
NanoCores	string	Unità di potenza di elaborazione in un miliardo di core CPU.
Percent	string	Unità percentuale.
Seconds	string	Unità di tempo in secondi.
Unspecified	string	Nessuna unità specificata.

MetricValue

Rappresenta un valore della metrica.

Nome	Tipo	Descrizione
average	number	Valore medio nell'intervallo di tempo.
count	number	Numero di campioni nell'intervallo di tempo. Può essere utilizzato per determinare il numero di valori che hanno contribuito al valore medio.
maximum	number	Valore massimo nell'intervallo di tempo.
minimum	number	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.

Nome	Tipo	Descrizione
cost	number	Valore intero che rappresenta il costo relativo della query.
interval	string	Intervallo (dimensioni finestra) per cui i dati delle metriche sono stati restituiti nel formato di durata ISO 8601 con un caso speciale per il valore "FULL" che restituisce un singolo punto dati per l'intero intervallo di tempo richiesto (esempi: PT15M, PT1H, P1D, FULL). Questa impostazione può essere modificata e diversa da quella richiesta in origine se viene specificato AutoAdjustTimegrain=true. Questa operazione non è presente se è stata effettuata una richiesta di metadati.
namespace	string	Spazio dei nomi delle metriche sottoposte a query
resourceregion	string	Area della risorsa sottoposta a query per le metriche.
timespan	string	Intervallo di tempo per il quale sono stati recuperati i dati. Il valore è costituito da due datetime concatenate, separate da '/'. Questo può essere modificato in futuro e restituito da ciò che è stato originariamente richiesto.
value	Metric[]	Valore dell'insieme.

TimeSeriesElement

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

Nome	Tipo	Descrizione
data	MetricValue[]	Matrice di punti dati che rappresentano i valori delle metriche. Viene restituito solo se viene specificato un tipo di dati di risultato.
metadatavalues	MetadataValue[]	I valori dei metadati restituiti se $filter è stato specificato nella chiamata.