Database Accounts - List Metric Definitions

Recupera le definizioni delle metriche per l'account del database specificato.

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

Parametri dell'URI

Name In Required Type Description
accountName
path True
  • string

Cosmos nome dell'account del database db.

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

resourceGroupName
path True
  • string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True
  • string

ID della sottoscrizione di destinazione.

api-version
query True
  • string

Versione dell'API da usare per questa operazione.

Risposte

Name Type Description
200 OK

Le definizioni delle metriche per l'account del database sono state recuperate correttamente.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Rappresentare l'account utente

Esempio

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

Definizioni

MetricAvailability

Disponibilità della metrica.

MetricDefinition

Definizione di una metrica.

MetricDefinitionsListResult

Risposta a una richiesta di definizioni delle metriche elenco.

MetricName

Un nome della metrica.

PrimaryAggregationType

Tipo di aggregazione primario della metrica.

UnitType

Unità della metrica.

MetricAvailability

Disponibilità della metrica.

Name Type Description
retention
  • string

Conservazione per i valori delle metriche.

timeGrain
  • string

Granularità temporale da usare per riepilogare i valori delle metriche.

MetricDefinition

Definizione di una metrica.

Name Type Description
metricAvailabilities

Elenco delle disponibilità delle metriche per l'account.

name

Informazioni sul nome per la metrica.

primaryAggregationType

Tipo di aggregazione primario della metrica.

resourceUri
  • string

URI della risorsa del database.

unit

Unità della metrica.

MetricDefinitionsListResult

Risposta a una richiesta di definizioni delle metriche elenco.

Name Type Description
value

Elenco delle definizioni delle metriche per l'account.

MetricName

Un nome della metrica.

Name Type Description
localizedValue
  • string

Nome descrittivo della metrica.

value
  • string

Nome della metrica.

PrimaryAggregationType

Tipo di aggregazione primario della metrica.

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

UnitType

Unità della metrica.

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