/
PercentileTarget.yml
62 lines (61 loc) · 2.35 KB
/
PercentileTarget.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
### YamlMime:TSType
name: PercentileTarget
uid: '@azure/arm-cosmosdb.PercentileTarget'
package: '@azure/arm-cosmosdb'
summary: Interface representing a PercentileTarget.
fullName: PercentileTarget
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
listMetrics(string, string, string, string,
PercentileTargetListMetricsOptionalParams)
uid: '@azure/arm-cosmosdb.PercentileTarget.listMetrics'
package: '@azure/arm-cosmosdb'
summary: >-
Retrieves the metrics determined by the given filter for the given account
target region. This url
is only for PBS and Replication Latency data
remarks: ''
isDeprecated: false
syntax:
content: >-
function listMetrics(resourceGroupName: string, accountName: string,
targetRegion: string, filter: string, options?:
PercentileTargetListMetricsOptionalParams):
PagedAsyncIterableIterator<PercentileMetric, PercentileMetric[],
PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: accountName
type: string
description: Cosmos DB database account name.
- id: targetRegion
type: string
description: >-
Target region to which data is written. Cosmos DB region, with
spaces between
words and each word capitalized.
- id: filter
type: string
description: >-
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.
- id: options
type: >-
<xref
uid="@azure/arm-cosmosdb.PercentileTargetListMetricsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-cosmosdb.PercentileMetric" />, <xref
uid="@azure/arm-cosmosdb.PercentileMetric" />[], <xref
uid="@azure/core-paging.PageSettings" />>