-
Notifications
You must be signed in to change notification settings - Fork 260
/
AutoPoolSpecification.xml
210 lines (210 loc) · 12.1 KB
/
AutoPoolSpecification.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
<Type Name="AutoPoolSpecification" FullName="Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification">
<TypeSignature Language="C#" Value="public class AutoPoolSpecification" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AutoPoolSpecification extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification" />
<TypeSignature Language="VB.NET" Value="Public Class AutoPoolSpecification" />
<TypeSignature Language="F#" Value="type AutoPoolSpecification = 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>
Specifies characteristics for a temporary 'auto pool'. The Batch
service will create this auto Pool when the Job is submitted.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AutoPoolSpecification ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.#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 AutoPoolSpecification class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AutoPoolSpecification (Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption poolLifetimeOption, string autoPoolIdPrefix = default, bool? keepAlive = default, Microsoft.Azure.Batch.Protocol.Models.PoolSpecification pool = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption poolLifetimeOption, string autoPoolIdPrefix, valuetype System.Nullable`1<bool> keepAlive, class Microsoft.Azure.Batch.Protocol.Models.PoolSpecification pool) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.#ctor(Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption,System.String,System.Nullable{System.Boolean},Microsoft.Azure.Batch.Protocol.Models.PoolSpecification)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (poolLifetimeOption As PoolLifetimeOption, Optional autoPoolIdPrefix As String = Nothing, Optional keepAlive As Nullable(Of Boolean) = Nothing, Optional pool As PoolSpecification = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification : Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption * string * Nullable<bool> * Microsoft.Azure.Batch.Protocol.Models.PoolSpecification -> Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification" Usage="new Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification (poolLifetimeOption, autoPoolIdPrefix, keepAlive, pool)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="poolLifetimeOption" Type="Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption" />
<Parameter Name="autoPoolIdPrefix" Type="System.String" />
<Parameter Name="keepAlive" Type="System.Nullable<System.Boolean>" />
<Parameter Name="pool" Type="Microsoft.Azure.Batch.Protocol.Models.PoolSpecification" />
</Parameters>
<Docs>
<param name="poolLifetimeOption">The minimum lifetime of created
auto Pools, and how multiple Jobs on a schedule are assigned to
Pools.</param>
<param name="autoPoolIdPrefix">A prefix to be added to the unique
identifier when a Pool is automatically created.</param>
<param name="keepAlive">Whether to keep an auto Pool alive after
its lifetime expires.</param>
<param name="pool">The Pool specification for the auto
Pool.</param>
<summary>
Initializes a new instance of the AutoPoolSpecification class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutoPoolIdPrefix">
<MemberSignature Language="C#" Value="public string AutoPoolIdPrefix { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AutoPoolIdPrefix" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.AutoPoolIdPrefix" />
<MemberSignature Language="VB.NET" Value="Public Property AutoPoolIdPrefix As String" />
<MemberSignature Language="F#" Value="member this.AutoPoolIdPrefix : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.AutoPoolIdPrefix" />
<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="autoPoolIdPrefix")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="autoPoolIdPrefix")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a prefix to be added to the unique identifier when a
Pool is automatically created.
</summary>
<value>To be added.</value>
<remarks>
The Batch service assigns each auto Pool a unique identifier on
creation. To distinguish between Pools created for different
purposes, you can specify this element to add a prefix to the ID
that is assigned. The prefix can be up to 20 characters long.
</remarks>
</Docs>
</Member>
<Member MemberName="KeepAlive">
<MemberSignature Language="C#" Value="public bool? KeepAlive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> KeepAlive" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.KeepAlive" />
<MemberSignature Language="VB.NET" Value="Public Property KeepAlive As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.KeepAlive : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.KeepAlive" />
<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="keepAlive")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="keepAlive")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets whether to keep an auto Pool alive after its lifetime
expires.
</summary>
<value>To be added.</value>
<remarks>
If false, the Batch service deletes the Pool once its lifetime (as
determined by the poolLifetimeOption setting) expires; that is,
when the Job or Job Schedule completes. If true, the Batch service
does not delete the Pool automatically. It is up to the user to
delete auto Pools created with this option.
</remarks>
</Docs>
</Member>
<Member MemberName="Pool">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.PoolSpecification Pool { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.PoolSpecification Pool" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.Pool" />
<MemberSignature Language="VB.NET" Value="Public Property Pool As PoolSpecification" />
<MemberSignature Language="F#" Value="member this.Pool : Microsoft.Azure.Batch.Protocol.Models.PoolSpecification with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.Pool" />
<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="pool")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="pool")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.PoolSpecification</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Pool specification for the auto Pool.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PoolLifetimeOption">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption PoolLifetimeOption { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption PoolLifetimeOption" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.PoolLifetimeOption" />
<MemberSignature Language="VB.NET" Value="Public Property PoolLifetimeOption As PoolLifetimeOption" />
<MemberSignature Language="F#" Value="member this.PoolLifetimeOption : Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.AutoPoolSpecification.PoolLifetimeOption" />
<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="poolLifetimeOption")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="poolLifetimeOption")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.PoolLifetimeOption</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the minimum lifetime of created auto Pools, and how
multiple Jobs on a schedule are assigned to Pools.
</summary>
<value>To be added.</value>
<remarks>
Possible values include: 'jobSchedule', 'job'
</remarks>
</Docs>
</Member>
</Members>
</Type>