Share via


CosmosDBAccountResource.GetMetricDefinitionsDatabasesAsync Method

Definition

Retrieves metric definitions for the given database.

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

Parameters

databaseRid
String

Cosmos DB database rid.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of CosmosDBMetricDefinition 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