IPartitionKeyRangeIdOperations.ListMetricsWithHttpMessagesAsync 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.
public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<System.Collections.Generic.IEnumerable<Microsoft.Azure.Management.CosmosDB.Fluent.Models.PartitionMetric>>> ListMetricsWithHttpMessagesAsync (string resourceGroupName, string accountName, string databaseRid, string collectionRid, string partitionKeyRangeId, string filter, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListMetricsWithHttpMessagesAsync : string * string * string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<seq<Microsoft.Azure.Management.CosmosDB.Fluent.Models.PartitionMetric>>>
Public Function ListMetricsWithHttpMessagesAsync (resourceGroupName As String, accountName As String, databaseRid As String, collectionRid As String, partitionKeyRangeId As String, filter As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IEnumerable(Of PartitionMetric)))
Parameters
- resourceGroupName
- String
Name of an Azure resource group.
- 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.
- customHeaders
- Dictionary<String,List<String>>
The headers that will be added to request.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Exceptions
Thrown when the operation returned an invalid status code
Thrown when unable to deserialize the response
Thrown when a required parameter is null