Sdílet prostřednictvím


CosmosDBAccountResource.GetUsagesCollectionPartitionsAsync Method

Definition

Retrieves the usages (most recent storage data) for the given collection, split by partition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages
  • Operation Id: CollectionPartition_ListUsages
  • Default Api Version: 2024-05-15-preview
public virtual Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionUsage> GetUsagesCollectionPartitionsAsync (string databaseRid, string collectionRid, string filter = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetUsagesCollectionPartitionsAsync : string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionUsage>
override this.GetUsagesCollectionPartitionsAsync : string * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.Models.PartitionUsage>
Public Overridable Function GetUsagesCollectionPartitionsAsync (databaseRid As String, collectionRid As String, Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PartitionUsage)

Parameters

databaseRid
String

Cosmos DB database rid.

collectionRid
String

Cosmos DB collection rid.

filter
String

An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of PartitionUsage that may take multiple service requests to iterate over.

Exceptions

databaseRid or collectionRid is an empty string, and was expected to be non-empty.

databaseRid or collectionRid is null.

Applies to