CollectionOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a Collection operations.

Properties

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

Property Details

listMetricDefinitions

Retrieves metric definitions for the given collection.

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

Property Value

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

listMetrics

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

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

Property Value

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

listUsages

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

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

Property Value

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