Sdílet prostřednictvím


CosmosDBAccountResource.GetUsagesDatabases Method

Definition

Retrieves the usages (most recent data) for the given database.

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

Parameters

databaseRid
String

Cosmos DB database 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 is an empty string, and was expected to be non-empty.

databaseRid is null.

Applies to