CosmosDBAccountResource.GetMetricsPartitionKeyRangeIdRegions Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves the metrics determined by the given filter for the given partition key range id and region.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics
- Operation Id: PartitionKeyRangeIdRegion_ListMetrics
- Default Api Version: 2024-05-15-preview
public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric> GetMetricsPartitionKeyRangeIdRegions (string region, string databaseRid, string collectionRid, string partitionKeyRangeId, string filter, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMetricsPartitionKeyRangeIdRegions : string * string * string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
override this.GetMetricsPartitionKeyRangeIdRegions : string * string * string * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.PartitionMetric>
Public Overridable Function GetMetricsPartitionKeyRangeIdRegions (region As String, databaseRid As String, collectionRid As String, partitionKeyRangeId As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PartitionMetric)
Parameters
- 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.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
A collection of PartitionMetric that may take multiple service requests to iterate over.
Exceptions
region
, databaseRid
, collectionRid
or partitionKeyRangeId
is an empty string, and was expected to be non-empty.
region
, databaseRid
, collectionRid
, partitionKeyRangeId
or filter
is null.
Applies to
Azure SDK for .NET