CollectionRegion interface
Interface representing a CollectionRegion.
Methods
| list |
Retrieves the metrics determined by the given filter for the given database account, collection and region. |
Method Details
listMetrics(string, string, string, string, string, string, CollectionRegionListMetricsOptionalParams)
Retrieves the metrics determined by the given filter for the given database account, collection and region.
function listMetrics(resourceGroupName: string, accountName: string, region: string, databaseRid: string, collectionRid: string, filter: string, options?: CollectionRegionListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>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.
The options parameters.