Class CollectionPartitionRegionImpl

listMetrics

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

• Retrieves the metrics determined by the given filter for the given collection and region, split by partition.

  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.

  • 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: CollectionPartitionRegionListMetricsOptionalParams

    The options parameters.

  Returns PagedAsyncIterableIterator<PartitionMetric>