Database Accounts - List Metric Definitions

Pobiera definicje metryk dla danego konta bazy danych.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions?api-version=2021-04-01-preview

Parametry identyfikatora URI

Name In Required Type Description
accountName
path True
  • string

Cosmos nazwa konta bazy danych bazy danych.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia na potrzeby tej operacji.

Odpowiedzi

Name Type Description
200 OK

Definicje metryk dla konta bazy danych zostały pomyślnie pobrane.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

CosmosDBDatabaseAccountGetMetricDefinitions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/metricDefinitions?api-version=2021-04-01-preview

Sample Response

{
  "value": [
    {
      "metricAvailabilities": [
        {
          "timeGrain": "PT5M",
          "retention": "P2D"
        },
        {
          "timeGrain": "PT1H",
          "retention": "P14D"
        },
        {
          "timeGrain": "P1D",
          "retention": "P60D"
        }
      ],
      "primaryAggregationType": "Total",
      "unit": "Count",
      "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
      "name": {
        "value": "Total Requests",
        "localizedValue": "Total Requests"
      }
    }
  ]
}

Definicje

MetricAvailability

Dostępność metryki.

MetricDefinition

Definicja metryki.

MetricDefinitionsListResult

Odpowiedź na żądanie definicji metryk listy.

MetricName

Nazwa metryki.

PrimaryAggregationType

Podstawowy typ agregacji metryki.

UnitType

Jednostka metryki.

MetricAvailability

Dostępność metryki.

Name Type Description
retention
  • string

Przechowywanie wartości metryk.

timeGrain
  • string

Ziarno czasu używane do podsumowywania wartości metryk.

MetricDefinition

Definicja metryki.

Name Type Description
metricAvailabilities

Lista dostępności metryk dla konta.

name

Informacje o nazwie metryki.

primaryAggregationType

Podstawowy typ agregacji metryki.

resourceUri
  • string

Identyfikator URI zasobu bazy danych.

unit

Jednostka metryki.

MetricDefinitionsListResult

Odpowiedź na żądanie definicji metryk listy.

Name Type Description
value

Lista definicji metryk dla konta.

MetricName

Nazwa metryki.

Name Type Description
localizedValue
  • string

Przyjazna nazwa metryki.

value
  • string

Nazwa metryki.

PrimaryAggregationType

Podstawowy typ agregacji metryki.

Name Type Description
Average
  • string
Last
  • string
Maximum
  • string
Minimum
  • string
None
  • string
Total
  • string

UnitType

Jednostka metryki.

Name Type Description
Bytes
  • string
BytesPerSecond
  • string
Count
  • string
CountPerSecond
  • string
Milliseconds
  • string
Percent
  • string
Seconds
  • string