Class PartitionKeyRangeIdImpl

Package version

Class containing PartitionKeyRangeId operations.

Hierarchy

PartitionKeyRangeIdImpl

Implements

PartitionKeyRangeId

Index

Constructors

constructor

Methods

listMetrics

Constructors

constructor

new PartitionKeyRangeIdImpl(client: CosmosDBManagementClient): PartitionKeyRangeIdImpl

- Defined in operations/partitionKeyRangeId.ts:24
Initialize a new instance of the class PartitionKeyRangeId class.

Parameters
- client: CosmosDBManagementClient
  
  Reference to the service client
Returns PartitionKeyRangeIdImpl

Methods

listMetrics

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

Implementation of PartitionKeyRangeId.listMetrics
- Defined in operations/partitionKeyRangeId.ts:46
Retrieves the metrics determined by the given filter for the given partition key range id.

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.
- partitionKeyRangeId: string
  
  Partition Key Range Id for which to get data.
- 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: PartitionKeyRangeIdListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PartitionMetric>

Generated using TypeDoc