Database Accounts - List Metric Definitions

指定されたデータベース アカウントのメトリック定義を取得します。

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

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

DB データベース アカウント名をCosmosします。

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

resourceGroupName
path True
  • string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True
  • string

ターゲット サブスクリプションの ID。

api-version
query True
  • string

この操作に使用する API バージョン。

応答

Name Type Description
200 OK

データベース アカウントのメトリック定義が正常に取得されました。

セキュリティ

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 ユーザー アカウントの借用

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

定義

MetricAvailability

メトリックの可用性。

MetricDefinition

メトリックの定義。

MetricDefinitionsListResult

リスト メトリック定義要求への応答。

MetricName

メトリック名。

PrimaryAggregationType

メトリックの主要な集計の種類。

UnitType

メトリックの単位。

MetricAvailability

メトリックの可用性。

Name Type Description
retention
  • string

メトリック値のリテンション期間。

timeGrain
  • string

メトリック値の集計に使用する時間グレイン。

MetricDefinition

メトリックの定義。

Name Type Description
metricAvailabilities

アカウントのメトリックの可用性の一覧。

name

メトリックの名前情報。

primaryAggregationType

メトリックの主要な集計の種類。

resourceUri
  • string

データベースのリソース URI。

unit

メトリックの単位。

MetricDefinitionsListResult

リスト メトリック定義要求への応答。

Name Type Description
value

アカウントのメトリック定義の一覧。

MetricName

メトリック名。

Name Type Description
localizedValue
  • string

メトリックのフレンドリ名。

value
  • string

メトリックの名前。

PrimaryAggregationType

メトリックの主要な集計の種類。

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

UnitType

メトリックの単位。

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