PartitionKeyRangeIdRegion interface

  • Reference
Package:
@azure/arm-cosmosdb

Interface representing a PartitionKeyRangeIdRegion.

Methods

listMetrics(string, string, string, string, string, string, string, PartitionKeyRangeIdRegionListMetricsOptionalParams)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

Method Details

listMetrics(string, string, string, string, string, string, string, PartitionKeyRangeIdRegionListMetricsOptionalParams)

Retrieves the metrics determined by the given filter for the given partition key range id and region.

function listMetrics(resourceGroupName: string, accountName: string, region: string, databaseRid: string, collectionRid: string, partitionKeyRangeId: string, filter: string, options?: PartitionKeyRangeIdRegionListMetricsOptionalParams): PagedAsyncIterableIterator<PartitionMetric, PartitionMetric[], PageSettings>

Parameters

resourceGroupName

string

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

accountName

string

Cosmos DB database account name.

region

string

Cosmos DB region, with spaces between words and each word capitalized.

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.

options
PartitionKeyRangeIdRegionListMetricsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartitionMetric, PartitionMetric[], PageSettings>