CosmosDBAccountResource.GetMetricsDatabaseAccountRegions 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 database account and region.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics
- Operation Id: DatabaseAccountRegion_ListMetrics
- Default Api Version: 2024-09-01-preview
public virtual Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric> GetMetricsDatabaseAccountRegions (string region, string filter, System.Threading.CancellationToken cancellationToken = default);abstract member GetMetricsDatabaseAccountRegions : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric>
override this.GetMetricsDatabaseAccountRegions : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.Models.CosmosDBBaseMetric>Public Overridable Function GetMetricsDatabaseAccountRegions (region As String, filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of CosmosDBBaseMetric)Parameters
- region
- String
Cosmos DB region, with spaces between words and each word capitalized.
- 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 CosmosDBBaseMetric that may take multiple service requests to iterate over.
Exceptions
region is an empty string, and was expected to be non-empty.
region or filter is null.
