-
Notifications
You must be signed in to change notification settings - Fork 256
/
PoolUpdatePropertiesParameter.xml
268 lines (267 loc) · 18.6 KB
/
PoolUpdatePropertiesParameter.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
<Type Name="PoolUpdatePropertiesParameter" FullName="Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter">
<TypeSignature Language="C#" Value="public class PoolUpdatePropertiesParameter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PoolUpdatePropertiesParameter extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter" />
<TypeSignature Language="VB.NET" Value="Public Class PoolUpdatePropertiesParameter" />
<TypeSignature Language="F#" Value="type PoolUpdatePropertiesParameter = 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>
The set of changes to be made to a Pool.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PoolUpdatePropertiesParameter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.#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 PoolUpdatePropertiesParameter
class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PoolUpdatePropertiesParameter (System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> certificateReferences, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> applicationPackageReferences, System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> metadata, Microsoft.Azure.Batch.Protocol.Models.StartTask startTask = default, Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode? targetNodeCommunicationMode = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.CertificateReference> certificateReferences, class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> applicationPackageReferences, class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.MetadataItem> metadata, class Microsoft.Azure.Batch.Protocol.Models.StartTask startTask, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode> targetNodeCommunicationMode) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.CertificateReference},System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference},System.Collections.Generic.IList{Microsoft.Azure.Batch.Protocol.Models.MetadataItem},Microsoft.Azure.Batch.Protocol.Models.StartTask,System.Nullable{Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (certificateReferences As IList(Of CertificateReference), applicationPackageReferences As IList(Of ApplicationPackageReference), metadata As IList(Of MetadataItem), Optional startTask As StartTask = Nothing, Optional targetNodeCommunicationMode As Nullable(Of NodeCommunicationMode) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> * System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> * Microsoft.Azure.Batch.Protocol.Models.StartTask * Nullable<Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode> -> Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter" Usage="new Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter (certificateReferences, applicationPackageReferences, metadata, startTask, targetNodeCommunicationMode)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="certificateReferences" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference>" />
<Parameter Name="applicationPackageReferences" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference>" />
<Parameter Name="metadata" Type="System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem>" />
<Parameter Name="startTask" Type="Microsoft.Azure.Batch.Protocol.Models.StartTask" />
<Parameter Name="targetNodeCommunicationMode" Type="System.Nullable<Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode>" />
</Parameters>
<Docs>
<param name="certificateReferences">A list of Certificates to be
installed on each Compute Node in the Pool.</param>
<param name="applicationPackageReferences">The list of Application
Packages to be installed on each Compute Node in the Pool.</param>
<param name="metadata">A list of name-value pairs associated with
the Pool as metadata.</param>
<param name="startTask">A Task to run on each Compute Node as it
joins the Pool. The Task runs when the Compute Node is added to the
Pool or when the Compute Node is restarted.</param>
<param name="targetNodeCommunicationMode">The desired node
communication mode for the pool.</param>
<summary>
Initializes a new instance of the PoolUpdatePropertiesParameter
class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplicationPackageReferences">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> ApplicationPackageReferences { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> ApplicationPackageReferences" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.ApplicationPackageReferences" />
<MemberSignature Language="VB.NET" Value="Public Property ApplicationPackageReferences As IList(Of ApplicationPackageReference)" />
<MemberSignature Language="F#" Value="member this.ApplicationPackageReferences : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.ApplicationPackageReferences" />
<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="applicationPackageReferences")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="applicationPackageReferences")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.ApplicationPackageReference></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of Application Packages to be installed on
each Compute Node in the Pool.
</summary>
<value>To be added.</value>
<remarks>
The list replaces any existing Application Package references on
the Pool. Changes to Application Package references affect all new
Compute Nodes joining the Pool, but do not affect Compute Nodes
that are already in the Pool until they are rebooted or reimaged.
There is a maximum of 10 Application Package references on any
given Pool. If omitted, or if you specify an empty collection, any
existing Application Packages references are removed from the Pool.
A maximum of 10 references may be specified on a given Pool.
</remarks>
</Docs>
</Member>
<Member MemberName="CertificateReferences">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> CertificateReferences { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.CertificateReference> CertificateReferences" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.CertificateReferences" />
<MemberSignature Language="VB.NET" Value="Public Property CertificateReferences As IList(Of CertificateReference)" />
<MemberSignature Language="F#" Value="member this.CertificateReferences : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.CertificateReferences" />
<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="certificateReferences")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="certificateReferences")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.CertificateReference></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of Certificates to be installed on each Compute
Node in the Pool.
</summary>
<value>To be added.</value>
<remarks>
This list replaces any existing Certificate references configured
on the Pool. If you specify an empty collection, any existing
Certificate references are removed from the Pool. For Windows
Nodes, the Batch service installs the Certificates to the specified
Certificate store and location. For Linux Compute Nodes, the
Certificates are stored in a directory inside the Task working
directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is
supplied to the Task to query for this location. For Certificates
with visibility of 'remoteUser', a 'certs' directory is created in
the user's home directory (e.g., /home/{user-name}/certs) and
Certificates are placed in that directory.
Warning: This property is deprecated and will be removed after
February, 2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
</remarks>
</Docs>
</Member>
<Member MemberName="Metadata">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> Metadata { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.Protocol.Models.MetadataItem> Metadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.Metadata" />
<MemberSignature Language="VB.NET" Value="Public Property Metadata As IList(Of MetadataItem)" />
<MemberSignature Language="F#" Value="member this.Metadata : System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.Metadata" />
<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="metadata")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="metadata")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.Protocol.Models.MetadataItem></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of name-value pairs associated with the Pool as
metadata.
</summary>
<value>To be added.</value>
<remarks>
This list replaces any existing metadata configured on the Pool. If
omitted, or if you specify an empty collection, any existing
metadata is removed from the Pool.
</remarks>
</Docs>
</Member>
<Member MemberName="StartTask">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.StartTask StartTask { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.StartTask StartTask" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.StartTask" />
<MemberSignature Language="VB.NET" Value="Public Property StartTask As StartTask" />
<MemberSignature Language="F#" Value="member this.StartTask : Microsoft.Azure.Batch.Protocol.Models.StartTask with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.StartTask" />
<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="startTask")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="startTask")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.StartTask</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a Task to run on each Compute Node as it joins the
Pool. The Task runs when the Compute Node is added to the Pool or
when the Compute Node is restarted.
</summary>
<value>To be added.</value>
<remarks>
If this element is present, it overwrites any existing StartTask.
If omitted, any existing StartTask is removed from the Pool.
</remarks>
</Docs>
</Member>
<Member MemberName="TargetNodeCommunicationMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode? TargetNodeCommunicationMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode> TargetNodeCommunicationMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.TargetNodeCommunicationMode" />
<MemberSignature Language="VB.NET" Value="Public Property TargetNodeCommunicationMode As Nullable(Of NodeCommunicationMode)" />
<MemberSignature Language="F#" Value="member this.TargetNodeCommunicationMode : Nullable<Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.PoolUpdatePropertiesParameter.TargetNodeCommunicationMode" />
<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="targetNodeCommunicationMode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="targetNodeCommunicationMode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Batch.Protocol.Models.NodeCommunicationMode></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the desired node communication mode for the pool.
</summary>
<value>To be added.</value>
<remarks>
This setting replaces any existing targetNodeCommunication setting
on the Pool. If omitted, the existing setting is default. Possible
values include: 'default', 'classic', 'simplified'
</remarks>
</Docs>
</Member>
</Members>
</Type>