Collection interface

Package:

@azure/arm-cosmosdb

Interface representing a Collection.

Methods

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)	Retrieves metric definitions for the given collection.
listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)	Retrieves the metrics determined by the given filter for the given database account and collection.
listUsages(string, string, string, string, CollectionListUsagesOptionalParams)	Retrieves the usages (most recent storage data) for the given collection.

Method Details

listMetricDefinitions(string, string, string, string, CollectionListMetricDefinitionsOptionalParams)

Retrieves metric definitions for the given collection.

function listMetricDefinitions(resourceGroupName: string, accountName: string, databaseRid: string, collectionRid: string, options?: CollectionListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseRid

string

Cosmos DB database rid.

collectionRid

string

Cosmos DB collection rid.

options

CollectionListMetricDefinitionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>

listMetrics(string, string, string, string, string, CollectionListMetricsOptionalParams)

Retrieves the metrics determined by the given filter for the given database account and collection.

function listMetrics(resourceGroupName: string, accountName: string, databaseRid: string, collectionRid: string, filter: string, options?: CollectionListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseRid

string

Cosmos DB database rid.

collectionRid

string

Cosmos DB collection rid.

filter

string

An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

options

CollectionListMetricsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Metric, Metric[], PageSettings>

listUsages(string, string, string, string, CollectionListUsagesOptionalParams)

Retrieves the usages (most recent storage data) for the given collection.

function listUsages(resourceGroupName: string, accountName: string, databaseRid: string, collectionRid: string, options?: CollectionListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseRid

string

Cosmos DB database rid.

collectionRid

string

Cosmos DB collection rid.

options

CollectionListUsagesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>