Database Accounts - List Metric Definitions

Recupera las definiciones de métricas de la cuenta de base de datos especificada.

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

Parámetros de identificador URI

Name In Required Type Description
accountName
path True
  • string

Cosmos nombre de la cuenta de base de datos de base de datos.

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

resourceGroupName
path True
  • string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True
  • string

Identificador de la suscripción de destino.

api-version
query True
  • string

Versión de API que se usará para la operación.

Respuestas

Name Type Description
200 OK

Las definiciones de métricas de la cuenta de base de datos se recuperaron correctamente.

Seguridad

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 Suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

MetricAvailability

Disponibilidad de la métrica.

MetricDefinition

Definición de una métrica.

MetricDefinitionsListResult

Respuesta a una solicitud de definiciones de métricas de lista.

MetricName

Un nombre para la métrica.

PrimaryAggregationType

Tipo de agregación principal de la métrica.

UnitType

Unidad de la métrica.

MetricAvailability

Disponibilidad de la métrica.

Name Type Description
retention
  • string

Retención de los valores de métrica.

timeGrain
  • string

Intervalo de tiempo que se va a usar para resumir los valores de las métricas.

MetricDefinition

Definición de una métrica.

Name Type Description
metricAvailabilities

Lista de disponibilidad de métricas para la cuenta.

name

Información de nombre de la métrica.

primaryAggregationType

Tipo de agregación principal de la métrica.

resourceUri
  • string

URI de recurso de la base de datos.

unit

Unidad de la métrica.

MetricDefinitionsListResult

Respuesta a una solicitud de definiciones de métricas de lista.

Name Type Description
value

Lista de definiciones de métricas de la cuenta.

MetricName

Un nombre para la métrica.

Name Type Description
localizedValue
  • string

Nombre descriptivo de la métrica.

value
  • string

El nombre de la métrica.

PrimaryAggregationType

Tipo de agregación principal de la métrica.

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

UnitType

Unidad de la métrica.

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