-
Notifications
You must be signed in to change notification settings - Fork 256
/
SubscriptionResourceGetMonitorMetricsOptions.xml
307 lines (307 loc) · 18.7 KB
/
SubscriptionResourceGetMonitorMetricsOptions.xml
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<Type Name="SubscriptionResourceGetMonitorMetricsOptions" FullName="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions">
<TypeSignature Language="C#" Value="public class SubscriptionResourceGetMonitorMetricsOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SubscriptionResourceGetMonitorMetricsOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions" />
<TypeSignature Language="VB.NET" Value="Public Class SubscriptionResourceGetMonitorMetricsOptions" />
<TypeSignature Language="F#" Value="type SubscriptionResourceGetMonitorMetricsOptions = class" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The SubscriptionResourceGetMonitorMetricsOptions. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SubscriptionResourceGetMonitorMetricsOptions (string region);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string region) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (region As String)" />
<MemberSignature Language="F#" Value="new Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions : string -> Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions" Usage="new Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions region" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="region" Type="System.String" />
</Parameters>
<Docs>
<param name="region"> The region where the metrics you want reside. </param>
<summary> Initializes a new instance of <see cref="T:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="region" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="Aggregation">
<MemberSignature Language="C#" Value="public string Aggregation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Aggregation" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Aggregation" />
<MemberSignature Language="VB.NET" Value="Public Property Aggregation As String" />
<MemberSignature Language="F#" Value="member this.Aggregation : string with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Aggregation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The list of aggregation types (comma separated) to retrieve. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutoAdjustTimegrain">
<MemberSignature Language="C#" Value="public bool? AutoAdjustTimegrain { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> AutoAdjustTimegrain" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.AutoAdjustTimegrain" />
<MemberSignature Language="VB.NET" Value="Public Property AutoAdjustTimegrain As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.AutoAdjustTimegrain : Nullable<bool> with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.AutoAdjustTimegrain" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="public string Filter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Filter" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Filter" />
<MemberSignature Language="VB.NET" Value="Public Property Filter As String" />
<MemberSignature Language="F#" Value="member this.Filter : string with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Filter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The **$filter** is used to reduce the set of metric data returned.<br>Example:<br>Metric contains metadata A, B and C.<br>- Return all time series of C where A = a1 and B = b1 or b2<br>**$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**<br>- Invalid variant:<br>**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**<br>This is invalid because the logical or operator cannot separate two different metadata names.<br>- Return all time series where A = a1, B = b1 and C = c1:<br>**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**<br>- Return all time series where A = a1<br>**$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Interval">
<MemberSignature Language="C#" Value="public TimeSpan? Interval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> Interval" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Interval" />
<MemberSignature Language="VB.NET" Value="Public Property Interval As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.Interval : Nullable<TimeSpan> with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Interval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary> The interval (i.e. timegrain) of the query. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Metricnames">
<MemberSignature Language="C#" Value="public string Metricnames { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Metricnames" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Metricnames" />
<MemberSignature Language="VB.NET" Value="Public Property Metricnames As String" />
<MemberSignature Language="F#" Value="member this.Metricnames : string with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Metricnames" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The names of the metrics (comma separated) to retrieve. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Metricnamespace">
<MemberSignature Language="C#" Value="public string Metricnamespace { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Metricnamespace" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Metricnamespace" />
<MemberSignature Language="VB.NET" Value="Public Property Metricnamespace As String" />
<MemberSignature Language="F#" Value="member this.Metricnamespace : string with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Metricnamespace" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Metric namespace where the metrics you want reside. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Orderby">
<MemberSignature Language="C#" Value="public string Orderby { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Orderby" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Orderby" />
<MemberSignature Language="VB.NET" Value="Public Property Orderby As String" />
<MemberSignature Language="F#" Value="member this.Orderby : string with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Orderby" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The aggregation to use for sorting results and the direction of the sort.
Only one order can be specified.
Examples: sum asc.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Region">
<MemberSignature Language="C#" Value="public string Region { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Region" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Region" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Region As String" />
<MemberSignature Language="F#" Value="member this.Region : string" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Region" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The region where the metrics you want reside. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResultType">
<MemberSignature Language="C#" Value="public Azure.ResourceManager.Monitor.Models.MonitorMetricResultType? ResultType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.ResourceManager.Monitor.Models.MonitorMetricResultType> ResultType" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.ResultType" />
<MemberSignature Language="VB.NET" Value="Public Property ResultType As Nullable(Of MonitorMetricResultType)" />
<MemberSignature Language="F#" Value="member this.ResultType : Nullable<Azure.ResourceManager.Monitor.Models.MonitorMetricResultType> with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.ResultType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.ResourceManager.Monitor.Models.MonitorMetricResultType></ReturnType>
</ReturnValue>
<Docs>
<summary> Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timespan">
<MemberSignature Language="C#" Value="public string Timespan { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Timespan" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Timespan" />
<MemberSignature Language="VB.NET" Value="Public Property Timespan As String" />
<MemberSignature Language="F#" Value="member this.Timespan : string with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Timespan" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Top">
<MemberSignature Language="C#" Value="public int? Top { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Top" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Top" />
<MemberSignature Language="VB.NET" Value="Public Property Top As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Top : Nullable<int> with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.Top" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum number of records to retrieve.
Valid only if $filter is specified.
Defaults to 10.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValidateDimensions">
<MemberSignature Language="C#" Value="public bool? ValidateDimensions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> ValidateDimensions" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.ValidateDimensions" />
<MemberSignature Language="VB.NET" Value="Public Property ValidateDimensions As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.ValidateDimensions : Nullable<bool> with get, set" Usage="Azure.ResourceManager.Monitor.Models.SubscriptionResourceGetMonitorMetricsOptions.ValidateDimensions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Monitor</AssemblyName>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.3.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>