-
Notifications
You must be signed in to change notification settings - Fork 255
/
RollingUpgradePolicy.xml
332 lines (332 loc) · 21.6 KB
/
RollingUpgradePolicy.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
<Type Name="RollingUpgradePolicy" FullName="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy">
<TypeSignature Language="C#" Value="public class RollingUpgradePolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RollingUpgradePolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy" />
<TypeSignature Language="VB.NET" Value="Public Class RollingUpgradePolicy" />
<TypeSignature Language="F#" Value="type RollingUpgradePolicy = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The configuration parameters used while performing a rolling upgrade.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RollingUpgradePolicy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the RollingUpgradePolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RollingUpgradePolicy (bool? enableCrossZoneUpgrade = default, int? maxBatchInstancePercent = default, int? maxUnhealthyInstancePercent = default, int? maxUnhealthyUpgradedInstancePercent = default, TimeSpan? pauseTimeBetweenBatches = default, bool? prioritizeUnhealthyInstances = default, bool? rollbackFailedInstancesOnPolicyBreach = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<bool> enableCrossZoneUpgrade, valuetype System.Nullable`1<int32> maxBatchInstancePercent, valuetype System.Nullable`1<int32> maxUnhealthyInstancePercent, valuetype System.Nullable`1<int32> maxUnhealthyUpgradedInstancePercent, valuetype System.Nullable`1<valuetype System.TimeSpan> pauseTimeBetweenBatches, valuetype System.Nullable`1<bool> prioritizeUnhealthyInstances, valuetype System.Nullable`1<bool> rollbackFailedInstancesOnPolicyBreach) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.#ctor(System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.TimeSpan},System.Nullable{System.Boolean},System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional enableCrossZoneUpgrade As Nullable(Of Boolean) = Nothing, Optional maxBatchInstancePercent As Nullable(Of Integer) = Nothing, Optional maxUnhealthyInstancePercent As Nullable(Of Integer) = Nothing, Optional maxUnhealthyUpgradedInstancePercent As Nullable(Of Integer) = Nothing, Optional pauseTimeBetweenBatches As Nullable(Of TimeSpan) = Nothing, Optional prioritizeUnhealthyInstances As Nullable(Of Boolean) = Nothing, Optional rollbackFailedInstancesOnPolicyBreach As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy : Nullable<bool> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<TimeSpan> * Nullable<bool> * Nullable<bool> -> Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy" Usage="new Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy (enableCrossZoneUpgrade, maxBatchInstancePercent, maxUnhealthyInstancePercent, maxUnhealthyUpgradedInstancePercent, pauseTimeBetweenBatches, prioritizeUnhealthyInstances, rollbackFailedInstancesOnPolicyBreach)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="enableCrossZoneUpgrade" Type="System.Nullable<System.Boolean>" />
<Parameter Name="maxBatchInstancePercent" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxUnhealthyInstancePercent" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxUnhealthyUpgradedInstancePercent" Type="System.Nullable<System.Int32>" />
<Parameter Name="pauseTimeBetweenBatches" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="prioritizeUnhealthyInstances" Type="System.Nullable<System.Boolean>" />
<Parameter Name="rollbackFailedInstancesOnPolicyBreach" Type="System.Nullable<System.Boolean>" />
</Parameters>
<Docs>
<param name="enableCrossZoneUpgrade">Allow VMSS to ignore AZ
boundaries when constructing upgrade batches. Take into
consideration the Update Domain and maxBatchInstancePercent to
determine the batch size. This field is able to be set to true or
false only when using NodePlacementConfiguration as Zonal.</param>
<param name="maxBatchInstancePercent">The maximum percent of total
virtual machine instances that will be upgraded simultaneously by
the rolling upgrade in one batch. As this is a maximum, unhealthy
instances in previous or future batches can cause the percentage of
instances in a batch to decrease to ensure higher reliability. The
value of this field should be between 5 and 100, inclusive. If both
maxBatchInstancePercent and maxUnhealthyInstancePercent are
assigned with value, the value of maxBatchInstancePercent should
not be more than maxUnhealthyInstancePercent.</param>
<param name="maxUnhealthyInstancePercent">The maximum percentage of
the total virtual machine instances in the scale set that can be
simultaneously unhealthy, either as a result of being upgraded, or
by being found in an unhealthy state by the virtual machine health
checks before the rolling upgrade aborts. This constraint will be
checked prior to starting any batch. The value of this field should
be between 5 and 100, inclusive. If both maxBatchInstancePercent
and maxUnhealthyInstancePercent are assigned with value, the value
of maxBatchInstancePercent should not be more than
maxUnhealthyInstancePercent.</param>
<param name="maxUnhealthyUpgradedInstancePercent">The maximum
percentage of upgraded virtual machine instances that can be found
to be in an unhealthy state. This check will happen after each
batch is upgraded. If this percentage is ever exceeded, the rolling
update aborts. The value of this field should be between 0 and 100,
inclusive.</param>
<param name="pauseTimeBetweenBatches">The wait time between
completing the update for all virtual machines in one batch and
starting the next batch. The time duration should be specified in
ISO 8601 format.</param>
<param name="prioritizeUnhealthyInstances">Upgrade all unhealthy
instances in a scale set before any healthy instances.</param>
<param name="rollbackFailedInstancesOnPolicyBreach">Rollback failed
instances to previous model if the Rolling Upgrade policy is
violated.</param>
<summary>
Initializes a new instance of the RollingUpgradePolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableCrossZoneUpgrade">
<MemberSignature Language="C#" Value="public bool? EnableCrossZoneUpgrade { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> EnableCrossZoneUpgrade" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.EnableCrossZoneUpgrade" />
<MemberSignature Language="VB.NET" Value="Public Property EnableCrossZoneUpgrade As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.EnableCrossZoneUpgrade : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.EnableCrossZoneUpgrade" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="enableCrossZoneUpgrade")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="enableCrossZoneUpgrade")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets allow VMSS to ignore AZ boundaries when constructing
upgrade batches. Take into consideration the Update Domain and
maxBatchInstancePercent to determine the batch size. This field is
able to be set to true or false only when using
NodePlacementConfiguration as Zonal.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxBatchInstancePercent">
<MemberSignature Language="C#" Value="public int? MaxBatchInstancePercent { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxBatchInstancePercent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.MaxBatchInstancePercent" />
<MemberSignature Language="VB.NET" Value="Public Property MaxBatchInstancePercent As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxBatchInstancePercent : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.MaxBatchInstancePercent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxBatchInstancePercent")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxBatchInstancePercent")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum percent of total virtual machine instances
that will be upgraded simultaneously by the rolling upgrade in one
batch. As this is a maximum, unhealthy instances in previous or
future batches can cause the percentage of instances in a batch to
decrease to ensure higher reliability. The value of this field
should be between 5 and 100, inclusive. If both
maxBatchInstancePercent and maxUnhealthyInstancePercent are
assigned with value, the value of maxBatchInstancePercent should
not be more than maxUnhealthyInstancePercent.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxUnhealthyInstancePercent">
<MemberSignature Language="C#" Value="public int? MaxUnhealthyInstancePercent { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxUnhealthyInstancePercent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.MaxUnhealthyInstancePercent" />
<MemberSignature Language="VB.NET" Value="Public Property MaxUnhealthyInstancePercent As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxUnhealthyInstancePercent : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.MaxUnhealthyInstancePercent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxUnhealthyInstancePercent")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxUnhealthyInstancePercent")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum percentage of the total virtual machine
instances in the scale set that can be simultaneously unhealthy,
either as a result of being upgraded, or by being found in an
unhealthy state by the virtual machine health checks before the
rolling upgrade aborts. This constraint will be checked prior to
starting any batch. The value of this field should be between 5 and
100, inclusive. If both maxBatchInstancePercent and
maxUnhealthyInstancePercent are assigned with value, the value of
maxBatchInstancePercent should not be more than
maxUnhealthyInstancePercent.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxUnhealthyUpgradedInstancePercent">
<MemberSignature Language="C#" Value="public int? MaxUnhealthyUpgradedInstancePercent { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxUnhealthyUpgradedInstancePercent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.MaxUnhealthyUpgradedInstancePercent" />
<MemberSignature Language="VB.NET" Value="Public Property MaxUnhealthyUpgradedInstancePercent As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxUnhealthyUpgradedInstancePercent : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.MaxUnhealthyUpgradedInstancePercent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxUnhealthyUpgradedInstancePercent")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxUnhealthyUpgradedInstancePercent")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum percentage of upgraded virtual machine
instances that can be found to be in an unhealthy state. This check
will happen after each batch is upgraded. If this percentage is
ever exceeded, the rolling update aborts. The value of this field
should be between 0 and 100, inclusive.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PauseTimeBetweenBatches">
<MemberSignature Language="C#" Value="public TimeSpan? PauseTimeBetweenBatches { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> PauseTimeBetweenBatches" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.PauseTimeBetweenBatches" />
<MemberSignature Language="VB.NET" Value="Public Property PauseTimeBetweenBatches As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.PauseTimeBetweenBatches : Nullable<TimeSpan> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.PauseTimeBetweenBatches" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="pauseTimeBetweenBatches")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="pauseTimeBetweenBatches")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the wait time between completing the update for all
virtual machines in one batch and starting the next batch. The time
duration should be specified in ISO 8601 format.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrioritizeUnhealthyInstances">
<MemberSignature Language="C#" Value="public bool? PrioritizeUnhealthyInstances { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> PrioritizeUnhealthyInstances" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.PrioritizeUnhealthyInstances" />
<MemberSignature Language="VB.NET" Value="Public Property PrioritizeUnhealthyInstances As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.PrioritizeUnhealthyInstances : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.PrioritizeUnhealthyInstances" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="prioritizeUnhealthyInstances")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="prioritizeUnhealthyInstances")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets upgrade all unhealthy instances in a scale set before
any healthy instances.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RollbackFailedInstancesOnPolicyBreach">
<MemberSignature Language="C#" Value="public bool? RollbackFailedInstancesOnPolicyBreach { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> RollbackFailedInstancesOnPolicyBreach" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.RollbackFailedInstancesOnPolicyBreach" />
<MemberSignature Language="VB.NET" Value="Public Property RollbackFailedInstancesOnPolicyBreach As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.RollbackFailedInstancesOnPolicyBreach : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.RollingUpgradePolicy.RollbackFailedInstancesOnPolicyBreach" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="rollbackFailedInstancesOnPolicyBreach")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="rollbackFailedInstancesOnPolicyBreach")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets rollback failed instances to previous model if the
Rolling Upgrade policy is violated.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>