-
Notifications
You must be signed in to change notification settings - Fork 256
/
PoolResizeParameter.xml
205 lines (205 loc) · 12.4 KB
/
PoolResizeParameter.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
<Type Name="PoolResizeParameter" FullName="Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter">
<TypeSignature Language="C#" Value="public class PoolResizeParameter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PoolResizeParameter extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter" />
<TypeSignature Language="VB.NET" Value="Public Class PoolResizeParameter" />
<TypeSignature Language="F#" Value="type PoolResizeParameter = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
<AssemblyVersion>15.3.0.0</AssemblyVersion>
<AssemblyVersion>15.4.0.0</AssemblyVersion>
<AssemblyVersion>16.0.0.0</AssemblyVersion>
<AssemblyVersion>16.1.0.0</AssemblyVersion>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options for changing the size of a Pool.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PoolResizeParameter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.#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 PoolResizeParameter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PoolResizeParameter (int? targetDedicatedNodes = default, int? targetLowPriorityNodes = default, TimeSpan? resizeTimeout = default, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption? nodeDeallocationOption = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<int32> targetDedicatedNodes, valuetype System.Nullable`1<int32> targetLowPriorityNodes, valuetype System.Nullable`1<valuetype System.TimeSpan> resizeTimeout, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption> nodeDeallocationOption) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.#ctor(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.TimeSpan},System.Nullable{Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional targetDedicatedNodes As Nullable(Of Integer) = Nothing, Optional targetLowPriorityNodes As Nullable(Of Integer) = Nothing, Optional resizeTimeout As Nullable(Of TimeSpan) = Nothing, Optional nodeDeallocationOption As Nullable(Of ComputeNodeDeallocationOption) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter : Nullable<int> * Nullable<int> * Nullable<TimeSpan> * Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption> -> Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter" Usage="new Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter (targetDedicatedNodes, targetLowPriorityNodes, resizeTimeout, nodeDeallocationOption)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="targetDedicatedNodes" Type="System.Nullable<System.Int32>" />
<Parameter Name="targetLowPriorityNodes" Type="System.Nullable<System.Int32>" />
<Parameter Name="resizeTimeout" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="nodeDeallocationOption" Type="System.Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption>" />
</Parameters>
<Docs>
<param name="targetDedicatedNodes">The desired number of dedicated
Compute Nodes in the Pool.</param>
<param name="targetLowPriorityNodes">The desired number of
Spot/Low-priority Compute Nodes in the Pool.</param>
<param name="resizeTimeout">The timeout for allocation of Nodes to
the Pool or removal of Compute Nodes from the Pool.</param>
<param name="nodeDeallocationOption">Determines what to do with a
Compute Node and its running task(s) if the Pool size is
decreasing.</param>
<summary>
Initializes a new instance of the PoolResizeParameter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NodeDeallocationOption">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption? NodeDeallocationOption { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption> NodeDeallocationOption" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.NodeDeallocationOption" />
<MemberSignature Language="VB.NET" Value="Public Property NodeDeallocationOption As Nullable(Of ComputeNodeDeallocationOption)" />
<MemberSignature Language="F#" Value="member this.NodeDeallocationOption : Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.NodeDeallocationOption" />
<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="nodeDeallocationOption")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="nodeDeallocationOption")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Batch.Protocol.Models.ComputeNodeDeallocationOption></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets determines what to do with a Compute Node and its
running task(s) if the Pool size is decreasing.
</summary>
<value>To be added.</value>
<remarks>
The default value is requeue. Possible values include: 'requeue',
'terminate', 'taskCompletion', 'retainedData'
</remarks>
</Docs>
</Member>
<Member MemberName="ResizeTimeout">
<MemberSignature Language="C#" Value="public TimeSpan? ResizeTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> ResizeTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.ResizeTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property ResizeTimeout As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.ResizeTimeout : Nullable<TimeSpan> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.ResizeTimeout" />
<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="resizeTimeout")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="resizeTimeout")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the timeout for allocation of Nodes to the Pool or
removal of Compute Nodes from the Pool.
</summary>
<value>To be added.</value>
<remarks>
The default value is 15 minutes. The minimum value is 5 minutes. If
you specify a value less than 5 minutes, the Batch service returns
an error; if you are calling the REST API directly, the HTTP status
code is 400 (Bad Request).
</remarks>
</Docs>
</Member>
<Member MemberName="TargetDedicatedNodes">
<MemberSignature Language="C#" Value="public int? TargetDedicatedNodes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> TargetDedicatedNodes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.TargetDedicatedNodes" />
<MemberSignature Language="VB.NET" Value="Public Property TargetDedicatedNodes As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.TargetDedicatedNodes : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.TargetDedicatedNodes" />
<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="targetDedicatedNodes")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="targetDedicatedNodes")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the desired number of dedicated Compute Nodes in the
Pool.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TargetLowPriorityNodes">
<MemberSignature Language="C#" Value="public int? TargetLowPriorityNodes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> TargetLowPriorityNodes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.TargetLowPriorityNodes" />
<MemberSignature Language="VB.NET" Value="Public Property TargetLowPriorityNodes As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.TargetLowPriorityNodes : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolResizeParameter.TargetLowPriorityNodes" />
<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="targetLowPriorityNodes")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="targetLowPriorityNodes")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the desired number of Spot/Low-priority Compute Nodes
in the Pool.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>