Sdílet prostřednictvím


CosmosDBAccountResource.GetMetricDefinitionsCollectionsAsync Method

Definition

Retrieves metric definitions for the given collection.

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

Parameters

databaseRid
String

Cosmos DB database rid.

collectionRid
String

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

databaseRid or collectionRid is null.

Applies to