/
RampUpRule.xml
349 lines (349 loc) · 20.3 KB
/
RampUpRule.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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<Type Name="RampUpRule" FullName="Microsoft.Azure.Management.WebSites.Models.RampUpRule">
<TypeSignature Language="C#" Value="public class RampUpRule" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RampUpRule extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.WebSites.Models.RampUpRule" />
<TypeSignature Language="VB.NET" Value="Public Class RampUpRule" />
<TypeSignature Language="F#" Value="type RampUpRule = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>3.1.1.0</AssemblyVersion>
<AssemblyVersion>3.1.2.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Routing rules for ramp up testing. This rule allows to redirect static
traffic % to a slot or to gradually change routing % based on
performance.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RampUpRule ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.WebSites.Models.RampUpRule.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the RampUpRule class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RampUpRule (string actionHostName = default, double? reroutePercentage = default, double? changeStep = default, int? changeIntervalInMinutes = default, double? minReroutePercentage = default, double? maxReroutePercentage = default, string changeDecisionCallbackUrl = default, string name = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string actionHostName, valuetype System.Nullable`1<float64> reroutePercentage, valuetype System.Nullable`1<float64> changeStep, valuetype System.Nullable`1<int32> changeIntervalInMinutes, valuetype System.Nullable`1<float64> minReroutePercentage, valuetype System.Nullable`1<float64> maxReroutePercentage, string changeDecisionCallbackUrl, string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.WebSites.Models.RampUpRule.#ctor(System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Double},System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional actionHostName As String = Nothing, Optional reroutePercentage As Nullable(Of Double) = Nothing, Optional changeStep As Nullable(Of Double) = Nothing, Optional changeIntervalInMinutes As Nullable(Of Integer) = Nothing, Optional minReroutePercentage As Nullable(Of Double) = Nothing, Optional maxReroutePercentage As Nullable(Of Double) = Nothing, Optional changeDecisionCallbackUrl As String = Nothing, Optional name As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.WebSites.Models.RampUpRule : string * Nullable<double> * Nullable<double> * Nullable<int> * Nullable<double> * Nullable<double> * string * string -> Microsoft.Azure.Management.WebSites.Models.RampUpRule" Usage="new Microsoft.Azure.Management.WebSites.Models.RampUpRule (actionHostName, reroutePercentage, changeStep, changeIntervalInMinutes, minReroutePercentage, maxReroutePercentage, changeDecisionCallbackUrl, name)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="actionHostName" Type="System.String" />
<Parameter Name="reroutePercentage" Type="System.Nullable<System.Double>" />
<Parameter Name="changeStep" Type="System.Nullable<System.Double>" />
<Parameter Name="changeIntervalInMinutes" Type="System.Nullable<System.Int32>" />
<Parameter Name="minReroutePercentage" Type="System.Nullable<System.Double>" />
<Parameter Name="maxReroutePercentage" Type="System.Nullable<System.Double>" />
<Parameter Name="changeDecisionCallbackUrl" Type="System.String" />
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="actionHostName">Hostname of a slot to which the
traffic will be redirected if decided to. E.g.
myapp-stage.azurewebsites.net.</param>
<param name="reroutePercentage">Percentage of the traffic which
will be redirected to
<code>ActionHostName</code>.</param>
<param name="changeStep">In auto ramp up scenario this is the step
to add/remove from <code>ReroutePercentage</code> until
it reaches \n<code>MinReroutePercentage</code> or
<code>MaxReroutePercentage</code>. Site metrics are
checked every N minutes specified in
<code>ChangeIntervalInMinutes</code>.\nCustom decision
algorithm
can be provided in TiPCallback site extension which URL can be
specified in
<code>ChangeDecisionCallbackUrl</code>.</param>
<param name="changeIntervalInMinutes">Specifies interval in minutes
to reevaluate ReroutePercentage.</param>
<param name="minReroutePercentage">Specifies lower boundary above
which ReroutePercentage will stay.</param>
<param name="maxReroutePercentage">Specifies upper boundary below
which ReroutePercentage will stay.</param>
<param name="changeDecisionCallbackUrl">Custom decision algorithm
can be provided in TiPCallback site extension which URL can be
specified. See TiPCallback site extension for the scaffold and
contracts.
https://www.siteextensions.net/packages/TiPCallback/</param>
<param name="name">Name of the routing rule. The recommended name
would be to point to the slot which will receive the traffic in the
experiment.</param>
<summary>
Initializes a new instance of the RampUpRule class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActionHostName">
<MemberSignature Language="C#" Value="public string ActionHostName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ActionHostName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.ActionHostName" />
<MemberSignature Language="VB.NET" Value="Public Property ActionHostName As String" />
<MemberSignature Language="F#" Value="member this.ActionHostName : string with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.ActionHostName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="actionHostName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="actionHostName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets hostname of a slot to which the traffic will be
redirected if decided to. E.g. myapp-stage.azurewebsites.net.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ChangeDecisionCallbackUrl">
<MemberSignature Language="C#" Value="public string ChangeDecisionCallbackUrl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ChangeDecisionCallbackUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.ChangeDecisionCallbackUrl" />
<MemberSignature Language="VB.NET" Value="Public Property ChangeDecisionCallbackUrl As String" />
<MemberSignature Language="F#" Value="member this.ChangeDecisionCallbackUrl : string with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.ChangeDecisionCallbackUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="changeDecisionCallbackUrl")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="changeDecisionCallbackUrl")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets custom decision algorithm can be provided in
TiPCallback site extension which URL can be specified. See
TiPCallback site extension for the scaffold and contracts.
https://www.siteextensions.net/packages/TiPCallback/
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ChangeIntervalInMinutes">
<MemberSignature Language="C#" Value="public int? ChangeIntervalInMinutes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> ChangeIntervalInMinutes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.ChangeIntervalInMinutes" />
<MemberSignature Language="VB.NET" Value="Public Property ChangeIntervalInMinutes As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.ChangeIntervalInMinutes : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.ChangeIntervalInMinutes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="changeIntervalInMinutes")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="changeIntervalInMinutes")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies interval in minutes to reevaluate
ReroutePercentage.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ChangeStep">
<MemberSignature Language="C#" Value="public double? ChangeStep { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> ChangeStep" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.ChangeStep" />
<MemberSignature Language="VB.NET" Value="Public Property ChangeStep As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.ChangeStep : Nullable<double> with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.ChangeStep" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="changeStep")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="changeStep")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets in auto ramp up scenario this is the step to
add/remove from
&lt;code&gt;ReroutePercentage&lt;/code&gt; until it
reaches
\n&lt;code&gt;MinReroutePercentage&lt;/code&gt; or
&lt;code&gt;MaxReroutePercentage&lt;/code&gt;. Site
metrics are checked every N minutes specified in
&lt;code&gt;ChangeIntervalInMinutes&lt;/code&gt;.\nCustom
decision algorithm
can be provided in TiPCallback site extension which URL can be
specified in
&lt;code&gt;ChangeDecisionCallbackUrl&lt;/code&gt;.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxReroutePercentage">
<MemberSignature Language="C#" Value="public double? MaxReroutePercentage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> MaxReroutePercentage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.MaxReroutePercentage" />
<MemberSignature Language="VB.NET" Value="Public Property MaxReroutePercentage As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.MaxReroutePercentage : Nullable<double> with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.MaxReroutePercentage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxReroutePercentage")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxReroutePercentage")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies upper boundary below which ReroutePercentage
will stay.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinReroutePercentage">
<MemberSignature Language="C#" Value="public double? MinReroutePercentage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> MinReroutePercentage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.MinReroutePercentage" />
<MemberSignature Language="VB.NET" Value="Public Property MinReroutePercentage As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.MinReroutePercentage : Nullable<double> with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.MinReroutePercentage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="minReroutePercentage")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="minReroutePercentage")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies lower boundary above which ReroutePercentage
will stay.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="name")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="name")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets name of the routing rule. The recommended name would
be to point to the slot which will receive the traffic in the
experiment.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReroutePercentage">
<MemberSignature Language="C#" Value="public double? ReroutePercentage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> ReroutePercentage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.WebSites.Models.RampUpRule.ReroutePercentage" />
<MemberSignature Language="VB.NET" Value="Public Property ReroutePercentage As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.ReroutePercentage : Nullable<double> with get, set" Usage="Microsoft.Azure.Management.WebSites.Models.RampUpRule.ReroutePercentage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Websites</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="reroutePercentage")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="reroutePercentage")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets percentage of the traffic which will be redirected to
&lt;code&gt;ActionHostName&lt;/code&gt;.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>