-
Notifications
You must be signed in to change notification settings - Fork 256
/
SetupTask.xml
258 lines (258 loc) · 15.2 KB
/
SetupTask.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
<Type Name="SetupTask" FullName="Microsoft.Azure.Management.BatchAI.Models.SetupTask">
<TypeSignature Language="C#" Value="public class SetupTask" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SetupTask extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.BatchAI.Models.SetupTask" />
<TypeSignature Language="VB.NET" Value="Public Class SetupTask" />
<TypeSignature Language="F#" Value="type SetupTask = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Specifies a setup task which can be used to customize the compute nodes
of the cluster.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SetupTask ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.BatchAI.Models.SetupTask.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the SetupTask class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SetupTask (string commandLine, string stdOutErrPathPrefix, System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable> environmentVariables = default, System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue> secrets = default, string stdOutErrPathSuffix = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string commandLine, string stdOutErrPathPrefix, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable> environmentVariables, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue> secrets, string stdOutErrPathSuffix) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.BatchAI.Models.SetupTask.#ctor(System.String,System.String,System.Collections.Generic.IList{Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable},System.Collections.Generic.IList{Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (commandLine As String, stdOutErrPathPrefix As String, Optional environmentVariables As IList(Of EnvironmentVariable) = Nothing, Optional secrets As IList(Of EnvironmentVariableWithSecretValue) = Nothing, Optional stdOutErrPathSuffix As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.BatchAI.Models.SetupTask : string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable> * System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue> * string -> Microsoft.Azure.Management.BatchAI.Models.SetupTask" Usage="new Microsoft.Azure.Management.BatchAI.Models.SetupTask (commandLine, stdOutErrPathPrefix, environmentVariables, secrets, stdOutErrPathSuffix)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="commandLine" Type="System.String" />
<Parameter Name="stdOutErrPathPrefix" Type="System.String" />
<Parameter Name="environmentVariables" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable>" />
<Parameter Name="secrets" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue>" />
<Parameter Name="stdOutErrPathSuffix" Type="System.String" />
</Parameters>
<Docs>
<param name="commandLine">Command line.</param>
<param name="stdOutErrPathPrefix">Output path prefix.</param>
<param name="environmentVariables">Environment variables.</param>
<param name="secrets">Secrets.</param>
<param name="stdOutErrPathSuffix">Output path suffix.</param>
<summary>
Initializes a new instance of the SetupTask class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CommandLine">
<MemberSignature Language="C#" Value="public string CommandLine { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CommandLine" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.BatchAI.Models.SetupTask.CommandLine" />
<MemberSignature Language="VB.NET" Value="Public Property CommandLine As String" />
<MemberSignature Language="F#" Value="member this.CommandLine : string with get, set" Usage="Microsoft.Azure.Management.BatchAI.Models.SetupTask.CommandLine" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="commandLine")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="commandLine")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets command line.
</summary>
<value>To be added.</value>
<remarks>
The command line to be executed on each cluster's node after it
being allocated or rebooted. The command is executed in a bash
subshell as a root.
</remarks>
</Docs>
</Member>
<Member MemberName="EnvironmentVariables">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable> EnvironmentVariables { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable> EnvironmentVariables" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.BatchAI.Models.SetupTask.EnvironmentVariables" />
<MemberSignature Language="VB.NET" Value="Public Property EnvironmentVariables As IList(Of EnvironmentVariable)" />
<MemberSignature Language="F#" Value="member this.EnvironmentVariables : System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable> with get, set" Usage="Microsoft.Azure.Management.BatchAI.Models.SetupTask.EnvironmentVariables" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="environmentVariables")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="environmentVariables")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariable></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets environment variables.
</summary>
<value>To be added.</value>
<remarks>
A collection of user defined environment variables to be set for
setup task.
</remarks>
</Docs>
</Member>
<Member MemberName="Secrets">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue> Secrets { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue> Secrets" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.BatchAI.Models.SetupTask.Secrets" />
<MemberSignature Language="VB.NET" Value="Public Property Secrets As IList(Of EnvironmentVariableWithSecretValue)" />
<MemberSignature Language="F#" Value="member this.Secrets : System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue> with get, set" Usage="Microsoft.Azure.Management.BatchAI.Models.SetupTask.Secrets" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="secrets")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="secrets")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.BatchAI.Models.EnvironmentVariableWithSecretValue></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets secrets.
</summary>
<value>To be added.</value>
<remarks>
A collection of user defined environment variables with secret
values to be set for the setup task. Server will never report
values of these variables back.
</remarks>
</Docs>
</Member>
<Member MemberName="StdOutErrPathPrefix">
<MemberSignature Language="C#" Value="public string StdOutErrPathPrefix { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StdOutErrPathPrefix" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.BatchAI.Models.SetupTask.StdOutErrPathPrefix" />
<MemberSignature Language="VB.NET" Value="Public Property StdOutErrPathPrefix As String" />
<MemberSignature Language="F#" Value="member this.StdOutErrPathPrefix : string with get, set" Usage="Microsoft.Azure.Management.BatchAI.Models.SetupTask.StdOutErrPathPrefix" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="stdOutErrPathPrefix")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="stdOutErrPathPrefix")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets output path prefix.
</summary>
<value>To be added.</value>
<remarks>
The prefix of a path where the Batch AI service will upload the
stdout, stderr and execution log of the setup task.
</remarks>
</Docs>
</Member>
<Member MemberName="StdOutErrPathSuffix">
<MemberSignature Language="C#" Value="public string StdOutErrPathSuffix { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StdOutErrPathSuffix" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.BatchAI.Models.SetupTask.StdOutErrPathSuffix" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StdOutErrPathSuffix As String" />
<MemberSignature Language="F#" Value="member this.StdOutErrPathSuffix : string" Usage="Microsoft.Azure.Management.BatchAI.Models.SetupTask.StdOutErrPathSuffix" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="stdOutErrPathSuffix")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="stdOutErrPathSuffix")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets output path suffix.
</summary>
<value>To be added.</value>
<remarks>
A path segment appended by Batch AI to stdOutErrPathPrefix to form
a path where stdout, stderr and execution log of the setup task
will be uploaded. Batch AI creates the setup task output
directories under an unique path to avoid conflicts between
different clusters. The full path can be obtained by concatenation
of stdOutErrPathPrefix and stdOutErrPathSuffix.
</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.BatchAI.Models.SetupTask.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="setupTask.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.BatchAI</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>