Interface CollectionPartition

Package version

Interface representing a CollectionPartition.

Hierarchy

CollectionPartition

Implemented by

CollectionPartitionImpl

Index

Methods

Methods

listMetrics

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

- Defined in operationsInterfaces/collectionPartition.ts:31
Retrieves the metrics determined by the given filter for the given collection, split by partition.

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: CollectionPartitionListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PartitionMetric>

listUsages

listUsages(resourceGroupName: string, accountName: string, databaseRid: string, collectionRid: string, options?: CollectionPartitionListUsagesOptionalParams): PagedAsyncIterableIterator<PartitionUsage>

- Defined in operationsInterfaces/collectionPartition.ts:47
Retrieves the usages (most recent storage data) for the given collection, split by partition.

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: CollectionPartitionListUsagesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PartitionUsage>

Generated using TypeDoc