Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PartitionKeyRangeIdRegion

Package version

Interface representing a PartitionKeyRangeIdRegion.

Hierarchy

  • PartitionKeyRangeIdRegion

Implemented by

Index

Methods

Methods

listMetrics

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

    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.

    • Optional options: PartitionKeyRangeIdRegionListMetricsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<PartitionMetric>

Generated using TypeDoc