-
Notifications
You must be signed in to change notification settings - Fork 255
/
AutomaticOSUpgradePolicy.xml
201 lines (201 loc) · 12.4 KB
/
AutomaticOSUpgradePolicy.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
<Type Name="AutomaticOSUpgradePolicy" FullName="Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy">
<TypeSignature Language="C#" Value="public class AutomaticOSUpgradePolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AutomaticOSUpgradePolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy" />
<TypeSignature Language="VB.NET" Value="Public Class AutomaticOSUpgradePolicy" />
<TypeSignature Language="F#" Value="type AutomaticOSUpgradePolicy = 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 for performing automatic OS upgrade.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AutomaticOSUpgradePolicy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.#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 AutomaticOSUpgradePolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AutomaticOSUpgradePolicy (bool? disableAutomaticRollback = default, bool? enableAutomaticOSUpgrade = default, bool? useRollingUpgradePolicy = default, bool? osRollingUpgradeDeferral = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<bool> disableAutomaticRollback, valuetype System.Nullable`1<bool> enableAutomaticOSUpgrade, valuetype System.Nullable`1<bool> useRollingUpgradePolicy, valuetype System.Nullable`1<bool> osRollingUpgradeDeferral) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.#ctor(System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional disableAutomaticRollback As Nullable(Of Boolean) = Nothing, Optional enableAutomaticOSUpgrade As Nullable(Of Boolean) = Nothing, Optional useRollingUpgradePolicy As Nullable(Of Boolean) = Nothing, Optional osRollingUpgradeDeferral As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy : Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> -> Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy" Usage="new Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy (disableAutomaticRollback, enableAutomaticOSUpgrade, useRollingUpgradePolicy, osRollingUpgradeDeferral)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="disableAutomaticRollback" Type="System.Nullable<System.Boolean>" />
<Parameter Name="enableAutomaticOSUpgrade" Type="System.Nullable<System.Boolean>" />
<Parameter Name="useRollingUpgradePolicy" Type="System.Nullable<System.Boolean>" />
<Parameter Name="osRollingUpgradeDeferral" Type="System.Nullable<System.Boolean>" />
</Parameters>
<Docs>
<param name="disableAutomaticRollback">Whether OS image rollback
feature should be disabled.</param>
<param name="enableAutomaticOSUpgrade">Indicates whether OS
upgrades should automatically be applied to scale set instances in
a rolling fashion when a newer version of the OS image becomes
available. <br /><br /> If this is set to true for
Windows based pools,
[WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration)
cannot be set to true.</param>
<param name="useRollingUpgradePolicy">Indicates whether rolling
upgrade policy should be used during Auto OS Upgrade. Auto OS
Upgrade will fallback to the default policy if no policy is defined
on the VMSS.</param>
<param name="osRollingUpgradeDeferral">Defer OS upgrades on the
TVMs if they are running tasks.</param>
<summary>
Initializes a new instance of the AutomaticOSUpgradePolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableAutomaticRollback">
<MemberSignature Language="C#" Value="public bool? DisableAutomaticRollback { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> DisableAutomaticRollback" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.DisableAutomaticRollback" />
<MemberSignature Language="VB.NET" Value="Public Property DisableAutomaticRollback As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.DisableAutomaticRollback : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.DisableAutomaticRollback" />
<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="disableAutomaticRollback")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="disableAutomaticRollback")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets whether OS image rollback feature should be disabled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableAutomaticOSUpgrade">
<MemberSignature Language="C#" Value="public bool? EnableAutomaticOSUpgrade { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> EnableAutomaticOSUpgrade" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.EnableAutomaticOSUpgrade" />
<MemberSignature Language="VB.NET" Value="Public Property EnableAutomaticOSUpgrade As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.EnableAutomaticOSUpgrade : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.EnableAutomaticOSUpgrade" />
<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="enableAutomaticOSUpgrade")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="enableAutomaticOSUpgrade")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets indicates whether OS upgrades should automatically be
applied to scale set instances in a rolling fashion when a newer
version of the OS image becomes available. &lt;br
/&gt;&lt;br /&gt; If this is set to true for Windows
based pools,
[WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration)
cannot be set to true.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OsRollingUpgradeDeferral">
<MemberSignature Language="C#" Value="public bool? OsRollingUpgradeDeferral { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> OsRollingUpgradeDeferral" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.OsRollingUpgradeDeferral" />
<MemberSignature Language="VB.NET" Value="Public Property OsRollingUpgradeDeferral As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.OsRollingUpgradeDeferral : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.OsRollingUpgradeDeferral" />
<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="osRollingUpgradeDeferral")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="osRollingUpgradeDeferral")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets defer OS upgrades on the TVMs if they are running
tasks.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UseRollingUpgradePolicy">
<MemberSignature Language="C#" Value="public bool? UseRollingUpgradePolicy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> UseRollingUpgradePolicy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.UseRollingUpgradePolicy" />
<MemberSignature Language="VB.NET" Value="Public Property UseRollingUpgradePolicy As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.UseRollingUpgradePolicy : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutomaticOSUpgradePolicy.UseRollingUpgradePolicy" />
<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="useRollingUpgradePolicy")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="useRollingUpgradePolicy")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets indicates whether rolling upgrade policy should be
used during Auto OS Upgrade. Auto OS Upgrade will fallback to the
default policy if no policy is defined on the VMSS.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>