Database Accounts - List Metric Definitions

Lekéri az adott adatbázisfiók metrikadefinícióit.

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

URI-paraméterek

Name In Required Type Description
accountName
path True
  • string

Cosmos DB-adatbázisfiók neve.

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

resourceGroupName
path True
  • string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

subscriptionId
path True
  • string

A cél-előfizetés azonosítója.

api-version
query True
  • string

A művelethez használandó API-verzió.

Válaszok

Name Type Description
200 OK

Az adatbázisfiók metrikadefinícióinak lekérése sikerült.

Biztonság

azure_auth

OAuth2 Flow Azure Active Directory

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

Scopes

Name Description
user_impersonation Felhasználói fiók megszemélyesítése

Példák

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

Definíciók

MetricAvailability

A metrika rendelkezésre állása.

MetricDefinition

Egy metrika definíciója.

MetricDefinitionsListResult

A listametrika-definíciókra vonatkozó kérésre adott válasz.

MetricName

Egy metrika neve.

PrimaryAggregationType

A metrika elsődleges összesítési típusa.

UnitType

A metrika egysége.

MetricAvailability

A metrika rendelkezésre állása.

Name Type Description
retention
  • string

A metrikaértékek megőrzése.

timeGrain
  • string

A metrikaértékek összegzéséhez használandó időfelbontási szint.

MetricDefinition

Egy metrika definíciója.

Name Type Description
metricAvailabilities

A fiókhoz tartozó metrika-elérhetőségek listája.

name

A metrika névadatai.

primaryAggregationType

A metrika elsődleges összesítési típusa.

resourceUri
  • string

Az adatbázis erőforrás-URI-ja.

unit

A metrika egysége.

MetricDefinitionsListResult

A listametrika-definíciókra vonatkozó kérésre adott válasz.

Name Type Description
value

A fiók metrikadefinícióinak listája.

MetricName

Egy metrika neve.

Name Type Description
localizedValue
  • string

A metrika rövid neve.

value
  • string

A metrika neve.

PrimaryAggregationType

A metrika elsődleges összesítési típusa.

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

UnitType

A metrika egysége.

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