次の方法で共有


CosmosDBAccountResource.GetMetricsPartitionKeyRangeIdsAsync メソッド

定義

指定されたパーティション キー範囲 ID の指定されたフィルターによって決定されたメトリックを取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
  • 操作IdPartitionKeyRangeId_ListMetrics
public virtual Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric> GetMetricsPartitionKeyRangeIdsAsync (string databaseRid, string collectionRid, string partitionKeyRangeId, string filter, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMetricsPartitionKeyRangeIdsAsync : string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
override this.GetMetricsPartitionKeyRangeIdsAsync : string * string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
Public Overridable Function GetMetricsPartitionKeyRangeIdsAsync (databaseRid As String, collectionRid As String, partitionKeyRangeId As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PartitionMetric)

パラメーター

databaseRid
String

Cosmos DB データベースの削除。

collectionRid
String

Cosmos DB コレクションの削除。

partitionKeyRangeId
String

データを取得するパーティション キー範囲 ID。

filter
String

返すメトリックのサブセットを記述する OData フィルター式。 フィルター処理できるパラメーターは、name.value (メトリックの名前、または複数の名前を持つことができます)、startTime、endTime、timeGrain です。 サポートされている演算子は eq です。

cancellationToken
CancellationToken

使用する取り消しトークン。

戻り値

反復処理するために複数の PartitionMetric サービス要求を受け取る可能性がある の非同期コレクション。

例外

databaseRidcollectionRidまたは partitionKeyRangeId が空の文字列であり、空でないと想定されていました。

databaseRidcollectionRidpartitionKeyRangeId、または filter が null です。

適用対象