CosmosDBAccountResource.GetMetricDefinitionsCollectionsAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: CosmosDBAccountResource.cs

Source:: CosmosDBAccountResource.cs

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

AsyncPageable<CosmosDBMetricDefinition>

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

Applies to

Share via