Delen via


Metrics - List At Subscription Scope Post

Lijsten de metrische gegevens voor een abonnement. Parameters kunnen worden opgegeven op queryparameters of de hoofdtekst.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region={region}
POST 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}

URI-parameters

Name In Vereist Type Description
subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

region
query True

string

De regio waar de gewenste metrische gegevens zich bevinden.

$filter
query

string

De $filter wordt gebruikt om de set geretourneerde metrische gegevens te verminderen.
Voorbeeld:
Metrische gegevens bevatten metagegevens A, B en C.
- Alle tijdreeksen van C retourneren waarbij A = a1 en B = b1 of b2
$filter=A eq 'a1' en B eq 'b1' of B eq 'b2' en C eq '*'
- Ongeldige variant:
$filter=A eq 'a1' en B eq 'b1' en C eq '*' of B = 'b2'
Dit is ongeldig omdat de logische of operator twee verschillende metagegevensnamen niet kan scheiden.
- Retourneer alle tijdreeksen waarbij A = a1, B = b1 en C = c1:
$filter=A eq 'a1' en B eq 'b1' en C eq 'c1'
- Alle tijdreeksen retourneren waarbij A = a1
$filter=A eq 'a1' en B eq '' en C eq ''.

aggregation
query

string

De lijst met op te halen aggregatietypen (door komma's gescheiden). Voorbeelden: gemiddelde, minimum, maximum

AutoAdjustTimegrain
query

boolean

Als deze optie is ingesteld op true en de doorgegeven tijdsperiode niet wordt ondersteund door deze metrische waarde, retourneert de API het resultaat met behulp van de dichtstbijzijnde ondersteunde periode. Als deze optie is ingesteld op onwaar, wordt er een fout geretourneerd voor ongeldige tijdsperiodeparameters. De standaardinstelling is false.

interval
query

string

Het interval (bijvoorbeeld timegrain) van de query in iso 8601-duurnotatie. De standaardwaarde is PT1M. Speciaal geval voor de waarde 'FULL' die één gegevenspunt retourneert voor de hele aangevraagde periode. Voorbeelden: PT15M, PT1H, P1D, FULL

metricnames
query

string

De namen van de metrische gegevens (gescheiden door komma's) die moeten worden opgehaald.

metricnamespace
query

string

Metrische naamruimte waar de gewenste metrische gegevens zich bevinden.

orderby
query

string

De aggregatie die moet worden gebruikt voor het sorteren van resultaten en de sorteerrichting. Er kan slechts één bestelling worden opgegeven. Voorbeelden: som asc

resultType
query

MetricResultType

Vermindert de verzameling gegevens die worden verzameld. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie.

rollupby
query

string

Dimensienamen om resultaten op samen te rollenen. Als u bijvoorbeeld alleen metrische waarden wilt zien met een filter zoals 'City eq Seattle of City eq Tacoma' maar geen afzonderlijke waarden voor elke stad wilt zien, kunt u RollUpBy=City opgeven om de resultaten voor Seattle en Tacoma samen te koppen in één tijdserie.

timespan
query

string

De periode van de query. Het is een tekenreeks met de volgende indeling 'startDateTime_ISO/endDateTime_ISO'.

top
query

integer

int32

Het maximum aantal records dat per resource-id in de aanvraag moet worden opgehaald. Alleen geldig als filter is opgegeven. De standaardwaarde is 10.

ValidateDimensions
query

boolean

Als deze instelling is ingesteld op false, worden ongeldige filterparameterwaarden genegeerd. Als deze optie is ingesteld op true, wordt er een fout geretourneerd voor ongeldige filterparameters. De standaardwaarde is waar.

Aanvraagbody

Name Type Description
aggregation

string

De lijst met op te halen aggregatietypen (door komma's gescheiden).

autoAdjustTimegrain

boolean

Als deze optie is ingesteld op true en de doorgegeven tijdsperiode niet wordt ondersteund door deze metrische waarde, retourneert de API het resultaat met behulp van de dichtstbijzijnde ondersteunde periode. Als deze optie is ingesteld op onwaar, wordt er een fout geretourneerd voor ongeldige tijdsperiodeparameters. De standaardinstelling is false.

filter

string

De $filter wordt gebruikt om de set geretourneerde metrische gegevens te verminderen.
Voorbeeld:
Metrische gegevens bevatten metagegevens A, B en C.
- Alle tijdreeksen van C retourneren waarbij A = a1 en B = b1 of b2
$filter=A eq 'a1' en B eq 'b1' of B eq 'b2' en C eq '*'
- Ongeldige variant:
$filter=A eq 'a1' en B eq 'b1' en C eq '*' of B = 'b2'
Dit is ongeldig omdat de logische of operator twee verschillende metagegevensnamen niet kan scheiden.
- Retourneer alle tijdreeksen waarbij A = a1, B = b1 en C = c1:
$filter=A eq 'a1' en B eq 'b1' en C eq 'c1'
- Alle tijdreeksen retourneren waarbij A = a1
$filter=A eq 'a1' en B eq '' en C eq ''.

interval

string

Het interval (bijvoorbeeld timegrain) van de query in iso 8601-duurnotatie. De standaardwaarde is PT1M. Speciaal geval voor de waarde 'FULL' die één gegevenspunt retourneert voor de hele aangevraagde periode. Voorbeelden: PT15M, PT1H, P1D, FULL

metricNames

string

De namen van de metrische gegevens (gescheiden door komma's) die moeten worden opgehaald.

metricNamespace

string

Metrische naamruimte waar de gewenste metrische gegevens zich bevinden.

orderBy

string

De aggregatie die moet worden gebruikt voor het sorteren van resultaten en de sorteerrichting. Er kan slechts één bestelling worden opgegeven. Voorbeelden: som asc.

resultType

MetricResultType

Vermindert de verzameling gegevens die worden verzameld. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie.

rollUpBy

string

Dimensienamen om resultaten op samen te rollenen. Als u bijvoorbeeld alleen metrische waarden wilt zien met een filter zoals 'City eq Seattle of City eq Tacoma' maar geen afzonderlijke waarden voor elke stad wilt zien, kunt u RollUpBy=City opgeven om de resultaten voor Seattle en Tacoma samen te koppen in één tijdserie.

timespan

string

De periode van de query. Het is een tekenreeks met de volgende indeling 'startDateTime_ISO/endDateTime_ISO'.

top

integer

Het maximum aantal records dat moet worden opgehaald. Alleen geldig als $filter is opgegeven. De standaardwaarde is 10.

validateDimensions

boolean

Als deze instelling is ingesteld op false, worden ongeldige filterparameterwaarden genegeerd. Als deze optie is ingesteld op true, wordt er een fout geretourneerd voor ongeldige filterparameters. De standaardwaarde is waar.

Antwoorden

Name Type Description
200 OK

Response

Geslaagde aanvraag om de lijst met metrische waarden op te halen.

Other Status Codes

ErrorContract

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

Post request for subscription level metric data
Post request for subscription level metric data using body params
Post request for subscription level metric metadata

Post request for subscription level metric data

Voorbeeldaanvraag

POST 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

Voorbeeldrespons

{
  "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"
}
{
  "error": {
    "code": "BadRequest",
    "message": "Missing required region params"
  }
}

Post request for subscription level metric data using body params

Voorbeeldaanvraag

POST 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",
  "metricNames": "Data Disk Max Burst IOPS",
  "metricNamespace": "microsoft.compute/virtualmachines",
  "filter": "LUN eq '0' and Microsoft.ResourceId eq '*'",
  "rollUpBy": "LUN",
  "top": 10,
  "orderBy": "count desc",
  "aggregation": "count",
  "interval": "PT6H",
  "autoAdjustTimegrain": true,
  "validateDimensions": false
}

Voorbeeldrespons

{
  "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"
}
{
  "error": {
    "code": "BadRequest",
    "message": "Missing required region params"
  }
}

Post request for subscription level metric metadata

Voorbeeldaanvraag

POST 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

Voorbeeldrespons

{
  "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"
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorContract

Foutreactie

ErrorResponse

Foutreactie

LocalizableString

De lokaliseerbare tekenreeksklasse.

MetadataValue

Vertegenwoordigt een waarde voor metrische metagegevens.

Metric

De resultaatgegevens van een query.

MetricResultType

Vermindert de verzameling gegevens die worden verzameld. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie.

MetricUnit

De eenheid van de metrische waarde.

MetricValue

Vertegenwoordigt een metrische waarde.

Response

Het antwoord op een query voor metrische gegevens.

SubscriptionScopeMetricsRequestBodyParameters

Queryparameters kunnen ook worden opgegeven in de hoofdtekst. Als u dezelfde parameter opgeeft in zowel de hoofdtekst als de queryparameters, resulteert dit in een fout.

TimeSeriesElement

Een tijdreeksresultaattype. De discriminatorwaarde is in dit geval altijd TimeSeries.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorContract

Foutreactie

Name Type Description
error

ErrorResponse

Foutreactie
Het foutobject.

ErrorResponse

Foutreactie

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorResponse[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

LocalizableString

De lokaliseerbare tekenreeksklasse.

Name Type Description
localizedValue

string

De weergavenaam.

value

string

De invariante waarde.

MetadataValue

Vertegenwoordigt een waarde voor metrische metagegevens.

Name Type Description
name

LocalizableString

De naam van de metagegevens.

value

string

De waarde van de metagegevens.

Metric

De resultaatgegevens van een query.

Name Type Description
displayDescription

string

Gedetailleerde beschrijving van deze metrische waarde.

errorCode

string

'Geslaagd' of de foutdetails over queryfouten voor dit metrische gegeven.

errorMessage

string

Er is een foutbericht opgetreden bij het uitvoeren van query's op deze specifieke metrische waarde.

id

string

De metrische id.

name

LocalizableString

De naam en de weergavenaam van de metrische waarde, d.w.w.w. het is een lokaliseerbare tekenreeks.

timeseries

TimeSeriesElement[]

De tijdreeks die wordt geretourneerd wanneer een gegevensquery wordt uitgevoerd.

type

string

Het resourcetype van de metrische resource.

unit

MetricUnit

De eenheid van de metrische waarde.

MetricResultType

Vermindert de verzameling gegevens die worden verzameld. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie.

Name Type Description
Data

string

Metadata

string

MetricUnit

De eenheid van de metrische waarde.

Name Type Description
BitsPerSecond

string

Tariefeenheid van binaire cijfers per seconde.

ByteSeconds

string

Eenheid voor gegevensoverdracht of -opslag. Dit is de grootte van de gegevens in bytes vermenigvuldigd met de tijd die nodig is om de gegevens in seconden over te dragen of op te slaan.

Bytes

string

Geheugeneenheid in bytes.

BytesPerSecond

string

Snelheidseenheid van geheugen in bytes per seconde.

Cores

string

Verwerkingskrachteenheid.

Count

string

Eenheid van onbewerkte hoeveelheid.

CountPerSecond

string

Tariefeenheid van onbewerkte hoeveelheid per seconde.

MilliCores

string

Verwerkingskrachteenheid in 1/1000e van een CPU-kern.

MilliSeconds

string

Tijdseenheid in 1/1000e van een seconde.

NanoCores

string

Eenheid van verwerkingskracht in één miljardste van een CPU-kern.

Percent

string

Percentageeenheid.

Seconds

string

Tijdseenheid in seconden.

Unspecified

string

Geen opgegeven eenheid.

MetricValue

Vertegenwoordigt een metrische waarde.

Name Type Description
average

number

De gemiddelde waarde in het tijdsbereik.

count

number

Het aantal steekproeven in het tijdsbereik. Kan worden gebruikt om het aantal waarden te bepalen dat heeft bijgedragen aan de gemiddelde waarde.

maximum

number

De grootste waarde in het tijdsbereik.

minimum

number

De laagste waarde in het tijdsbereik.

timeStamp

string

De tijdstempel voor de metrische waarde in ISO 8601-indeling.

total

number

De som van alle waarden in het tijdsbereik.

Response

Het antwoord op een query voor metrische gegevens.

Name Type Description
cost

number

De gehele waarde die de relatieve kosten van de query aangeeft.

interval

string

Het interval (venstergrootte) waarvoor de metrische gegevens zijn geretourneerd in iso 8601-duurnotatie met een speciaal geval voor de waarde 'FULL' die één gegevenspunt retourneert voor de gehele aangevraagde periode (voorbeelden: PT15M, PT1H, P1D, FULL). Dit kan worden aangepast en afwijken van wat oorspronkelijk is aangevraagd als AutoAdjustTimegrain=true is opgegeven. Dit is niet aanwezig als er een metagegevensaanvraag is gedaan.

namespace

string

De naamruimte van de metrische gegevens die worden opgevraagd

resourceregion

string

De regio van de resource die wordt opgevraagd voor metrische gegevens.

timespan

string

De periode waarvoor de gegevens zijn opgehaald. De waarde ervan bestaat uit twee samengevoegde datum-en-tijdswaarden, gescheiden door '/'. Dit kan in de toekomst worden aangepast en worden geretourneerd van wat oorspronkelijk is aangevraagd.

value

Metric[]

De waarde van de verzameling.

SubscriptionScopeMetricsRequestBodyParameters

Queryparameters kunnen ook worden opgegeven in de hoofdtekst. Als u dezelfde parameter opgeeft in zowel de hoofdtekst als de queryparameters, resulteert dit in een fout.

Name Type Description
aggregation

string

De lijst met op te halen aggregatietypen (door komma's gescheiden).

autoAdjustTimegrain

boolean

Als deze optie is ingesteld op true en de doorgegeven tijdsperiode niet wordt ondersteund door deze metrische waarde, retourneert de API het resultaat met behulp van de dichtstbijzijnde ondersteunde periode. Als deze optie is ingesteld op onwaar, wordt er een fout geretourneerd voor ongeldige tijdsperiodeparameters. De standaardinstelling is false.

filter

string

De $filter wordt gebruikt om de set geretourneerde metrische gegevens te verminderen.
Voorbeeld:
Metrische gegevens bevatten metagegevens A, B en C.
- Alle tijdreeksen van C retourneren waarbij A = a1 en B = b1 of b2
$filter=A eq 'a1' en B eq 'b1' of B eq 'b2' en C eq '*'
- Ongeldige variant:
$filter=A eq 'a1' en B eq 'b1' en C eq '*' of B = 'b2'
Dit is ongeldig omdat de logische of operator twee verschillende metagegevensnamen niet kan scheiden.
- Retourneer alle tijdreeksen waarbij A = a1, B = b1 en C = c1:
$filter=A eq 'a1' en B eq 'b1' en C eq 'c1'
- Alle tijdreeksen retourneren waarbij A = a1
$filter=A eq 'a1' en B eq '' en C eq ''.

interval

string

Het interval (bijvoorbeeld timegrain) van de query in iso 8601-duurnotatie. De standaardwaarde is PT1M. Speciaal geval voor de waarde 'FULL' die één gegevenspunt retourneert voor de hele aangevraagde periode. Voorbeelden: PT15M, PT1H, P1D, FULL

metricNames

string

De namen van de metrische gegevens (gescheiden door komma's) die moeten worden opgehaald.

metricNamespace

string

Metrische naamruimte waar de gewenste metrische gegevens zich bevinden.

orderBy

string

De aggregatie die moet worden gebruikt voor het sorteren van resultaten en de sorteerrichting. Er kan slechts één bestelling worden opgegeven. Voorbeelden: som asc.

resultType

MetricResultType

Vermindert de verzameling gegevens die worden verzameld. De toegestane syntaxis is afhankelijk van de bewerking. Zie de beschrijving van de bewerking voor meer informatie.

rollUpBy

string

Dimensienamen om resultaten op samen te rollenen. Als u bijvoorbeeld alleen metrische waarden wilt zien met een filter zoals 'City eq Seattle of City eq Tacoma' maar geen afzonderlijke waarden voor elke stad wilt zien, kunt u RollUpBy=City opgeven om de resultaten voor Seattle en Tacoma samen te koppen in één tijdserie.

timespan

string

De periode van de query. Het is een tekenreeks met de volgende indeling 'startDateTime_ISO/endDateTime_ISO'.

top

integer

Het maximum aantal records dat moet worden opgehaald. Alleen geldig als $filter is opgegeven. De standaardwaarde is 10.

validateDimensions

boolean

Als deze instelling is ingesteld op false, worden ongeldige filterparameterwaarden genegeerd. Als deze optie is ingesteld op true, wordt er een fout geretourneerd voor ongeldige filterparameters. De standaardwaarde is waar.

TimeSeriesElement

Een tijdreeksresultaattype. De discriminatorwaarde is in dit geval altijd TimeSeries.

Name Type Description
data

MetricValue[]

Een matrix van gegevenspunten die de metrische waarden vertegenwoordigen. Dit wordt alleen geretourneerd als er een resultaattype gegevens is opgegeven.

metadatavalues

MetadataValue[]

De metagegevenswaarden die worden geretourneerd als $filter is opgegeven in de aanroep.