Database Accounts - List Metric Definitions

Ruft Metrikdefinitionen für das angegebene Datenbankkonto ab.

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

URI-Parameter

Name In Required Type Description
accountName
path True
  • string

Cosmos DB-Datenbankkontoname.

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

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Type Description
200 OK

Die Metrikdefinitionen für das Datenbankkonto wurden erfolgreich abgerufen.

Sicherheit

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 Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

MetricAvailability

Die Verfügbarkeit der Metrik.

MetricDefinition

Die Definition einer Metrik.

MetricDefinitionsListResult

Die Antwort auf eine Listendefinitionsdefinitionsanforderung.

MetricName

Metrikname

PrimaryAggregationType

Der primäre Aggregationstyp der Metrik.

UnitType

Die Einheit der Metrik.

MetricAvailability

Die Verfügbarkeit der Metrik.

Name Type Description
retention
  • string

Die Aufbewahrung für die Metrikwerte.

timeGrain
  • string

Das Zeitkorn, das verwendet werden soll, um die Metrikwerte zusammenzufassen.

MetricDefinition

Die Definition einer Metrik.

Name Type Description
metricAvailabilities

Die Liste der Metrik-Verfügbarkeiten für das Konto.

name

Die Nameninformationen für die Metrik.

primaryAggregationType

Der primäre Aggregationstyp der Metrik.

resourceUri
  • string

Der Ressourcenuri der Datenbank.

unit

Die Einheit der Metrik.

MetricDefinitionsListResult

Die Antwort auf eine Listendefinitionsdefinitionsanforderung.

Name Type Description
value

Die Liste der Metrikdefinitionen für das Konto.

MetricName

Metrikname

Name Type Description
localizedValue
  • string

Der Anzeigename der Metrik.

value
  • string

Der Name der Metrik.

PrimaryAggregationType

Der primäre Aggregationstyp der Metrik.

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

UnitType

Die Einheit der Metrik.

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