-
Notifications
You must be signed in to change notification settings - Fork 181
/
MetricTrigger.yml
166 lines (166 loc) · 5.32 KB
/
MetricTrigger.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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
### YamlMime:TSType
name: MetricTrigger
uid: '@azure/arm-monitor.MetricTrigger'
package: '@azure/arm-monitor'
summary: The trigger that results in a scaling action.
fullName: MetricTrigger
remarks: ''
isDeprecated: false
type: interface
properties:
- name: dimensions
uid: '@azure/arm-monitor.MetricTrigger.dimensions'
package: '@azure/arm-monitor'
summary: >-
List of dimension conditions. For example:
[{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}].
fullName: dimensions
remarks: ''
isDeprecated: false
syntax:
content: 'dimensions?: ScaleRuleMetricDimension[]'
return:
description: ''
type: <xref uid="@azure/arm-monitor.ScaleRuleMetricDimension" />[]
- name: dividePerInstance
uid: '@azure/arm-monitor.MetricTrigger.dividePerInstance'
package: '@azure/arm-monitor'
summary: a value indicating whether metric should divide per instance.
fullName: dividePerInstance
remarks: ''
isDeprecated: false
syntax:
content: 'dividePerInstance?: boolean'
return:
description: ''
type: boolean
- name: metricName
uid: '@azure/arm-monitor.MetricTrigger.metricName'
package: '@azure/arm-monitor'
summary: the name of the metric that defines what the rule monitors.
fullName: metricName
remarks: ''
isDeprecated: false
syntax:
content: 'metricName: string'
return:
description: ''
type: string
- name: metricNamespace
uid: '@azure/arm-monitor.MetricTrigger.metricNamespace'
package: '@azure/arm-monitor'
summary: the namespace of the metric that defines what the rule monitors.
fullName: metricNamespace
remarks: ''
isDeprecated: false
syntax:
content: 'metricNamespace?: string'
return:
description: ''
type: string
- name: metricResourceLocation
uid: '@azure/arm-monitor.MetricTrigger.metricResourceLocation'
package: '@azure/arm-monitor'
summary: the location of the resource the rule monitors.
fullName: metricResourceLocation
remarks: ''
isDeprecated: false
syntax:
content: 'metricResourceLocation?: string'
return:
description: ''
type: string
- name: metricResourceUri
uid: '@azure/arm-monitor.MetricTrigger.metricResourceUri'
package: '@azure/arm-monitor'
summary: the resource identifier of the resource the rule monitors.
fullName: metricResourceUri
remarks: ''
isDeprecated: false
syntax:
content: 'metricResourceUri: string'
return:
description: ''
type: string
- name: operator
uid: '@azure/arm-monitor.MetricTrigger.operator'
package: '@azure/arm-monitor'
summary: the operator that is used to compare the metric data and the threshold.
fullName: operator
remarks: ''
isDeprecated: false
syntax:
content: 'operator: ComparisonOperationType'
return:
description: ''
type: <xref uid="@azure/arm-monitor.ComparisonOperationType" />
- name: statistic
uid: '@azure/arm-monitor.MetricTrigger.statistic'
package: '@azure/arm-monitor'
summary: >-
the metric statistic type. How the metrics from multiple instances are
combined.
fullName: statistic
remarks: ''
isDeprecated: false
syntax:
content: 'statistic: MetricStatisticType'
return:
description: ''
type: <xref uid="@azure/arm-monitor.MetricStatisticType" />
- name: threshold
uid: '@azure/arm-monitor.MetricTrigger.threshold'
package: '@azure/arm-monitor'
summary: the threshold of the metric that triggers the scale action.
fullName: threshold
remarks: ''
isDeprecated: false
syntax:
content: 'threshold: number'
return:
description: ''
type: number
- name: timeAggregation
uid: '@azure/arm-monitor.MetricTrigger.timeAggregation'
package: '@azure/arm-monitor'
summary: >-
time aggregation type. How the data that is collected should be combined
over time. The default value is Average.
fullName: timeAggregation
remarks: ''
isDeprecated: false
syntax:
content: 'timeAggregation: TimeAggregationType'
return:
description: ''
type: <xref uid="@azure/arm-monitor.TimeAggregationType" />
- name: timeGrain
uid: '@azure/arm-monitor.MetricTrigger.timeGrain'
package: '@azure/arm-monitor'
summary: >-
the granularity of metrics the rule monitors. Must be one of the
predefined values returned from metric definitions for the metric. Must be
between 12 hours and 1 minute.
fullName: timeGrain
remarks: ''
isDeprecated: false
syntax:
content: 'timeGrain: string'
return:
description: ''
type: string
- name: timeWindow
uid: '@azure/arm-monitor.MetricTrigger.timeWindow'
package: '@azure/arm-monitor'
summary: >-
the range of time in which instance data is collected. This value must be
greater than the delay in metric collection, which can vary from
resource-to-resource. Must be between 12 hours and 5 minutes.
fullName: timeWindow
remarks: ''
isDeprecated: false
syntax:
content: 'timeWindow: string'
return:
description: ''
type: string