Interface Collection

Package version

Interface representing a Collection.

Hierarchy

Collection

Implemented by

CollectionImpl

Index

Methods

Methods

listMetricDefinitions

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

- Defined in operationsInterfaces/collection.ts:64
Retrieves metric definitions for the given collection.

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.
- Optional options: CollectionListMetricDefinitionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MetricDefinition>

listMetrics

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

- Defined in operationsInterfaces/collection.ts:33
Retrieves the metrics determined by the given filter for the given database account and collection.

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.
- Optional options: CollectionListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Metric>

listUsages

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

- Defined in operationsInterfaces/collection.ts:49
Retrieves the usages (most recent storage data) for the given collection.

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.
- Optional options: CollectionListUsagesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Usage>

Generated using TypeDoc