/
ComputeNodeUser.xml
310 lines (310 loc) · 20.1 KB
/
ComputeNodeUser.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
<Type Name="ComputeNodeUser" FullName="Microsoft.Azure.Batch.ComputeNodeUser">
<TypeSignature Language="C#" Value="public class ComputeNodeUser : Microsoft.Azure.Batch.IInheritedBehaviors" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ComputeNodeUser extends System.Object implements class Microsoft.Azure.Batch.IInheritedBehaviors" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.ComputeNodeUser" />
<TypeSignature Language="VB.NET" Value="Public Class ComputeNodeUser
Implements IInheritedBehaviors" />
<TypeSignature Language="F#" Value="type ComputeNodeUser = class
 interface IInheritedBehaviors" />
<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>
<Interface>
<InterfaceName>Microsoft.Azure.Batch.IInheritedBehaviors</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A user for a specific Azure Batch compute node.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ComputeNodeUser ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.ComputeNodeUser.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Default constructor to support mocking the <see cref="T:Microsoft.Azure.Batch.ComputeNodeUser" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Commit">
<MemberSignature Language="C#" Value="public void Commit (Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics addOrUpdate = Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics.AddUser, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Commit(valuetype Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics addOrUpdate, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.ComputeNodeUser.Commit(Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />
<MemberSignature Language="VB.NET" Value="Public Sub Commit (Optional addOrUpdate As ComputeNodeUserCommitSemantics = Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics.AddUser, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" />
<MemberSignature Language="F#" Value="member this.Commit : Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics * seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="computeNodeUser.Commit (addOrUpdate, additionalBehaviors)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="addOrUpdate" Type="Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics" />
<Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" />
</Parameters>
<Docs>
<param name="addOrUpdate">Selects the type of commit operation to perform.</param>
<param name="additionalBehaviors">A collection of BatchClientBehavior instances that are applied after the CustomBehaviors on the current object.</param>
<summary>
Blocking call to create or update a user account on the compute node.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CommitAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CommitAsync (Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics addOrUpdate = Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics.AddUser, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task CommitAsync(valuetype Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics addOrUpdate, class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.ComputeNodeUser.CommitAsync(Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics,System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function CommitAsync (Optional addOrUpdate As ComputeNodeUserCommitSemantics = Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics.AddUser, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="member this.CommitAsync : Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="computeNodeUser.CommitAsync (addOrUpdate, additionalBehaviors, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="addOrUpdate" Type="Microsoft.Azure.Batch.ComputeNodeUserCommitSemantics" />
<Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="addOrUpdate">Selects the type of commit operation to perform.</param>
<param name="additionalBehaviors">A collection of BatchClientBehavior instances that are applied after the CustomBehaviors on the current object.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param>
<summary>
Begins an asynchronous call to create or update a user account on the compute node.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> object that represents the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CustomBehaviors">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior> CustomBehaviors { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Batch.BatchClientBehavior> CustomBehaviors" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.ComputeNodeUser.CustomBehaviors" />
<MemberSignature Language="VB.NET" Value="Public Property CustomBehaviors As IList(Of BatchClientBehavior)" />
<MemberSignature Language="F#" Value="member this.CustomBehaviors : System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior> with get, set" Usage="Microsoft.Azure.Batch.ComputeNodeUser.CustomBehaviors" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Azure.Batch.IInheritedBehaviors.CustomBehaviors</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Batch.BatchClientBehavior></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of behaviors that modify or customize requests to the Batch service
made via this <see cref="T:Microsoft.Azure.Batch.ComputeNodeUser" />.
</summary>
<value>To be added.</value>
<remarks>
<para>These behaviors are inherited by child objects.</para>
<para>Modifications are applied in the order of the collection. The last write wins.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Delete">
<MemberSignature Language="C#" Value="public void Delete (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Delete(class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.ComputeNodeUser.Delete(System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior})" />
<MemberSignature Language="VB.NET" Value="Public Sub Delete (Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing)" />
<MemberSignature Language="F#" Value="member this.Delete : seq<Microsoft.Azure.Batch.BatchClientBehavior> -> unit" Usage="computeNodeUser.Delete additionalBehaviors" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" />
</Parameters>
<Docs>
<param name="additionalBehaviors">A collection of BatchClientBehavior instances that are applied after the CustomBehaviors on the current object.</param>
<summary>
call to delete the current user from the compute node.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeleteAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task DeleteAsync(class System.Collections.Generic.IEnumerable`1<class Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.ComputeNodeUser.DeleteAsync(System.Collections.Generic.IEnumerable{Microsoft.Azure.Batch.BatchClientBehavior},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DeleteAsync (Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="member this.DeleteAsync : seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="computeNodeUser.DeleteAsync (additionalBehaviors, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="additionalBehaviors" Type="System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="additionalBehaviors">A collection of BatchClientBehavior instances that are applied after the CustomBehaviors on the current object.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for controlling the lifetime of the asynchronous operation.</param>
<summary>
Begins an asyncrhonous call to delete the current user from the compute node.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> object that represents the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpiryTime">
<MemberSignature Language="C#" Value="public DateTime ExpiryTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ExpiryTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.ComputeNodeUser.ExpiryTime" />
<MemberSignature Language="VB.NET" Value="Public Property ExpiryTime As DateTime" />
<MemberSignature Language="F#" Value="member this.ExpiryTime : DateTime with get, set" Usage="Microsoft.Azure.Batch.ComputeNodeUser.ExpiryTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the expiry time.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAdmin">
<MemberSignature Language="C#" Value="public bool? IsAdmin { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsAdmin" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.ComputeNodeUser.IsAdmin" />
<MemberSignature Language="VB.NET" Value="Public Property IsAdmin As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsAdmin : Nullable<bool> with get, set" Usage="Microsoft.Azure.Batch.ComputeNodeUser.IsAdmin" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the administrative privilege level of the user account. The value of this property is ignored when
UpdateUser is specified for the commit operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.ComputeNodeUser.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Azure.Batch.ComputeNodeUser.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name. If AddUser is specified for the commit operation, the value of this property is the name
of the local Windows account created. If UpdateUser is specified for the commit operation, the value of this
property selects the local Windows account to modify. Changing this property does not rename the local Windows
account on the compute node.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Password">
<MemberSignature Language="C#" Value="public string Password { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Password" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.ComputeNodeUser.Password" />
<MemberSignature Language="VB.NET" Value="Public Property Password As String" />
<MemberSignature Language="F#" Value="member this.Password : string with get, set" Usage="Microsoft.Azure.Batch.ComputeNodeUser.Password" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the password.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SshPublicKey">
<MemberSignature Language="C#" Value="public string SshPublicKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SshPublicKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.ComputeNodeUser.SshPublicKey" />
<MemberSignature Language="VB.NET" Value="Public Property SshPublicKey As String" />
<MemberSignature Language="F#" Value="member this.SshPublicKey : string with get, set" Usage="Microsoft.Azure.Batch.ComputeNodeUser.SshPublicKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the SSH public key that can be used for remote login to the compute node.
</summary>
<value>To be added.</value>
<remarks>
<para>The public key should be compatible with Open SSH encoding and should be base 64 encoded. This property
can be specified only for Linux nodes. The Batch service will return an error if this property is set for pools
created with <see cref="T:Microsoft.Azure.Batch.CloudServiceConfiguration" /> or <see cref="T:Microsoft.Azure.Batch.VirtualMachineConfiguration" />
with Windows compute nodes.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>