CosmosDBAccountResource.GetUsagesCollections Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the usages (most recent storage data) for the given collection.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages
- Operation Id: Collection_ListUsages
- Default Api Version: 2024-09-01-preview
public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseUsage> GetUsagesCollections (string databaseRid, string collectionRid, string filter = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetUsagesCollections : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseUsage>
override this.GetUsagesCollections : string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseUsage>Public Overridable Function GetUsagesCollections (databaseRid As String, collectionRid As String, Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of CosmosDBBaseUsage)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
A collection of CosmosDBBaseUsage 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.
