-
Notifications
You must be signed in to change notification settings - Fork 256
/
TaskContainerSettings.xml
208 lines (208 loc) · 11.9 KB
/
TaskContainerSettings.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
<Type Name="TaskContainerSettings" FullName="Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings">
<TypeSignature Language="C#" Value="public class TaskContainerSettings" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TaskContainerSettings extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings" />
<TypeSignature Language="VB.NET" Value="Public Class TaskContainerSettings" />
<TypeSignature Language="F#" Value="type TaskContainerSettings = 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 container settings for a Task.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskContainerSettings ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.#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 TaskContainerSettings class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TaskContainerSettings (string imageName, string containerRunOptions = default, Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry registry = default, Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory? workingDirectory = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string imageName, string containerRunOptions, class Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry registry, valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory> workingDirectory) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.#ctor(System.String,System.String,Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry,System.Nullable{Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (imageName As String, Optional containerRunOptions As String = Nothing, Optional registry As ContainerRegistry = Nothing, Optional workingDirectory As Nullable(Of ContainerWorkingDirectory) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings : string * string * Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry * Nullable<Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory> -> Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings" Usage="new Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings (imageName, containerRunOptions, registry, workingDirectory)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="imageName" Type="System.String" />
<Parameter Name="containerRunOptions" Type="System.String" />
<Parameter Name="registry" Type="Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry" />
<Parameter Name="workingDirectory" Type="System.Nullable<Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory>" />
</Parameters>
<Docs>
<param name="imageName">The Image to use to create the container in
which the Task will run.</param>
<param name="containerRunOptions">Additional options to the
container create command.</param>
<param name="registry">The private registry which contains the
container Image.</param>
<param name="workingDirectory">The location of the container Task
working directory.</param>
<summary>
Initializes a new instance of the TaskContainerSettings class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContainerRunOptions">
<MemberSignature Language="C#" Value="public string ContainerRunOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContainerRunOptions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.ContainerRunOptions" />
<MemberSignature Language="VB.NET" Value="Public Property ContainerRunOptions As String" />
<MemberSignature Language="F#" Value="member this.ContainerRunOptions : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.ContainerRunOptions" />
<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="containerRunOptions")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="containerRunOptions")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets additional options to the container create command.
</summary>
<value>To be added.</value>
<remarks>
These additional options are supplied as arguments to the "docker
create" command, in addition to those controlled by the Batch
Service.
</remarks>
</Docs>
</Member>
<Member MemberName="ImageName">
<MemberSignature Language="C#" Value="public string ImageName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ImageName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.ImageName" />
<MemberSignature Language="VB.NET" Value="Public Property ImageName As String" />
<MemberSignature Language="F#" Value="member this.ImageName : string with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.ImageName" />
<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="imageName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="imageName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Image to use to create the container in which the
Task will run.
</summary>
<value>To be added.</value>
<remarks>
This is the full Image reference, as would be specified to "docker
pull". If no tag is provided as part of the Image name, the tag
":latest" is used as a default.
</remarks>
</Docs>
</Member>
<Member MemberName="Registry">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry Registry { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry Registry" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.Registry" />
<MemberSignature Language="VB.NET" Value="Public Property Registry As ContainerRegistry" />
<MemberSignature Language="F#" Value="member this.Registry : Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.Registry" />
<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="registry")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="registry")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Batch.Protocol.Models.ContainerRegistry</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the private registry which contains the container
Image.
</summary>
<value>To be added.</value>
<remarks>
This setting can be omitted if was already provided at Pool
creation.
</remarks>
</Docs>
</Member>
<Member MemberName="WorkingDirectory">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory? WorkingDirectory { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory> WorkingDirectory" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.WorkingDirectory" />
<MemberSignature Language="VB.NET" Value="Public Property WorkingDirectory As Nullable(Of ContainerWorkingDirectory)" />
<MemberSignature Language="F#" Value="member this.WorkingDirectory : Nullable<Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.TaskContainerSettings.WorkingDirectory" />
<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="workingDirectory")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="workingDirectory")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Batch.Protocol.Models.ContainerWorkingDirectory></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the location of the container Task working directory.
</summary>
<value>To be added.</value>
<remarks>
The default is 'taskWorkingDirectory'. Possible values include:
'taskWorkingDirectory', 'containerImageDefault'
</remarks>
</Docs>
</Member>
</Members>
</Type>