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=2023-11-15
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
account
|
path | True |
string |
Nombre de la cuenta de base de datos de Cosmos DB. Regex pattern: |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
subscription
|
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
Nombre | Tipo | Description |
---|---|---|
200 OK |
Las definiciones de métricas de la cuenta de base de datos se recuperaron correctamente. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | 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=2023-11-15
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
Nombre | Description |
---|---|
Metric |
Disponibilidad de la métrica. |
Metric |
Definición de una métrica. |
Metric |
Respuesta a una solicitud de definiciones de métricas de lista. |
Metric |
Un nombre para la métrica. |
Primary |
Tipo de agregación principal de la métrica. |
Unit |
Unidad de la métrica. |
MetricAvailability
Disponibilidad de la métrica.
Nombre | Tipo | 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 métrica. |
MetricDefinition
Definición de una métrica.
Nombre | Tipo | 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.
Nombre | Tipo | Description |
---|---|---|
value |
Lista de definiciones de métricas de la cuenta. |
MetricName
Un nombre para la métrica.
Nombre | Tipo | 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.
Nombre | Tipo | Description |
---|---|---|
Average |
string |
|
Last |
string |
|
Maximum |
string |
|
Minimum |
string |
|
None |
string |
|
Total |
string |
UnitType
Unidad de la métrica.
Nombre | Tipo | Description |
---|---|---|
Bytes |
string |
|
BytesPerSecond |
string |
|
Count |
string |
|
CountPerSecond |
string |
|
Milliseconds |
string |
|
Percent |
string |
|
Seconds |
string |