CosmosDBAccountResource.GetUsagesCollectionPartitions Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBAccountResource.cs

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-09-01-preview

public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionUsage> GetUsagesCollectionPartitions (string databaseRid, string collectionRid, string filter = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetUsagesCollectionPartitions : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionUsage>
override this.GetUsagesCollectionPartitions : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionUsage>

Public Overridable Function GetUsagesCollectionPartitions (databaseRid As String, collectionRid As String, Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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

Pageable<PartitionUsage>

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

Exceptions

ArgumentException

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

ArgumentNullException

databaseRid or collectionRid is null.