Delen via


Metrics Batch - Batch

Lijsten de metrische waarden voor meerdere resources.

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

URI-parameters

Name In Vereist Type Description
endpoint
path True

string

url

Het regionale eindpunt dat moet worden gebruikt, bijvoorbeeld https://eastus.metrics.monitor.azure.com. De regio moet overeenkomen met de regio van de aangevraagde resources. Voor globale resources moet de regio 'globaal' zijn.

subscriptionId
path True

string

uuid

De abonnements-id voor de resources in deze batch.

api-version
query True

string

Client-API-versie.

metricnames
query True

string[]

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

metricnamespace
query True

string

Metrische naamruimte die de aangevraagde metrische namen bevat.

aggregation
query

string

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

endtime
query

string

De eindtijd van de query. Het is een tekenreeks in de notatie 'jjjj-MM-ddTHH:mm:ss.fffZ'.

filter
query

string

Het 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
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

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

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.

starttime
query

string

De begintijd van de query. Het is een tekenreeks in de notatie 'jjjj-MM-ddTHH:mm:ss.fffZ'. Als u de parameter endtime hebt opgegeven, is deze parameter vereist. Als alleen de begintijd is opgegeven, wordt de eindtijd standaard ingesteld op de huidige tijd. Als er geen tijdsinterval is opgegeven, is de standaardwaarde 1 uur.

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.

Aanvraagbody

Name Type Description
resourceids

string[]

De lijst met resource-id's waarvoor metrische gegevens moeten worden opgevraagd.

Antwoorden

Name Type Description
200 OK

MetricResultsResponse

Het antwoord op een query voor metrische gegevens.

Other Status Codes

ErrorResponse

Beschrijft de indeling van foutantwoord.

Headers

x-ms-error-code: string

Beveiliging

AADToken

Azure Active Directory OAuth2-verificatie

Type: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

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

Voorbeelden

Query Redis Metrics summary
Query Storage Metrics

Query Redis Metrics summary

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

LocalizableString

De lokaliseerbare tekenreeksklasse.

MetadataValue

Vertegenwoordigt een waarde voor metrische metagegevens.

Metric

De resultaatgegevens van een query.

MetricResultsResponse

Het resultaat van de metrische gegevens voor een resource.

MetricUnit

De eenheid van de metrische waarde.

MetricValue

Vertegenwoordigt een metrische waarde.

ResourceIdList

De door komma's gescheiden lijst met resource-id's waarvoor metrische gegevens moeten worden opgevraagd.

TimeSeriesElement

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

Values

Het verzamelen van antwoorden op metrische gegevens per resource, per metrische waarde.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

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.

MetricResultsResponse

Het resultaat van de metrische gegevens voor een resource.

Name Type Description
values

Values[]

Het verzamelen van antwoorden op metrische gegevens per resource, per metrische waarde.

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.

ResourceIdList

De door komma's gescheiden lijst met resource-id's waarvoor metrische gegevens moeten worden opgevraagd.

Name Type Description
resourceids

string[]

De lijst met resource-id's waarvoor metrische gegevens moeten worden opgevraagd.

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.

Values

Het verzamelen van antwoorden op metrische gegevens per resource, per metrische waarde.

Name Type Description
endtime

string

De eindtijd, in datum/tijd-notatie, waarvoor de gegevens zijn opgehaald.

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.

namespace

string

De naamruimte van de metrische gegevens die zijn opgevraagd

resourceid

string

De resource die is opgevraagd voor metrische gegevens.

resourceregion

string

Er is een query uitgevoerd op de regio van de resource voor metrische gegevens.

starttime

string

De begintijd, in datum/tijd-notatie, waarvoor de gegevens zijn opgehaald.

value

Metric[]

De waarde van de verzameling.