-
Notifications
You must be signed in to change notification settings - Fork 180
/
BatchServiceModels.JobSpecification.yml
272 lines (241 loc) · 8.93 KB
/
BatchServiceModels.JobSpecification.yml
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
### YamlMime:TSType
name: JobSpecification
uid: '@azure/batch.BatchServiceModels.JobSpecification'
package: '@azure/batch'
summary: An interface representing JobSpecification.
fullName: JobSpecification
remarks: ''
isDeprecated: false
type: interface
properties:
- name: commonEnvironmentSettings
uid: '@azure/batch.BatchServiceModels.JobSpecification.commonEnvironmentSettings'
package: '@azure/batch'
summary: >-
A list of common environment variable settings. These environment
variables are set for all
Tasks in Jobs created under this schedule (including the Job Manager, Job
Preparation and Job
Release Tasks). Individual Tasks can override an environment setting
specified here by
specifying the same setting name with a different value.
fullName: commonEnvironmentSettings
remarks: ''
isDeprecated: false
syntax:
content: 'commonEnvironmentSettings?: EnvironmentSetting[]'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.EnvironmentSetting" />[]
- name: constraints
uid: '@azure/batch.BatchServiceModels.JobSpecification.constraints'
package: '@azure/batch'
summary: The execution constraints for Jobs created under this schedule.
fullName: constraints
remarks: ''
isDeprecated: false
syntax:
content: 'constraints?: JobConstraints'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.JobConstraints" />
- name: displayName
uid: '@azure/batch.BatchServiceModels.JobSpecification.displayName'
package: '@azure/batch'
summary: >-
The display name for Jobs created under this schedule. The name need not
be unique and can
contain any Unicode characters up to a maximum length of 1024.
fullName: displayName
remarks: ''
isDeprecated: false
syntax:
content: 'displayName?: string'
return:
description: ''
type: string
- name: jobManagerTask
uid: '@azure/batch.BatchServiceModels.JobSpecification.jobManagerTask'
package: '@azure/batch'
summary: >-
The details of a Job Manager Task to be launched when a Job is started
under this schedule. If
the Job does not specify a Job Manager Task, the user must explicitly add
Tasks to the Job
using the Task API. If the Job does specify a Job Manager Task, the Batch
service creates the
Job Manager Task when the Job is created, and will try to schedule the Job
Manager Task before
scheduling other Tasks in the Job.
fullName: jobManagerTask
remarks: ''
isDeprecated: false
syntax:
content: 'jobManagerTask?: JobManagerTask'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.JobManagerTask" />
- name: jobPreparationTask
uid: '@azure/batch.BatchServiceModels.JobSpecification.jobPreparationTask'
package: '@azure/batch'
summary: >-
The Job Preparation Task for Jobs created under this schedule. If a Job
has a Job Preparation
Task, the Batch service will run the Job Preparation Task on a Node before
starting any Tasks
of that Job on that Compute Node.
fullName: jobPreparationTask
remarks: ''
isDeprecated: false
syntax:
content: 'jobPreparationTask?: JobPreparationTask'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.JobPreparationTask" />
- name: jobReleaseTask
uid: '@azure/batch.BatchServiceModels.JobSpecification.jobReleaseTask'
package: '@azure/batch'
summary: >-
The Job Release Task for Jobs created under this schedule. The primary
purpose of the Job
Release Task is to undo changes to Nodes made by the Job Preparation Task.
Example activities
include deleting local files, or shutting down services that were started
as part of Job
preparation. A Job Release Task cannot be specified without also
specifying a Job Preparation
Task for the Job. The Batch service runs the Job Release Task on the
Compute Nodes that have
run the Job Preparation Task.
fullName: jobReleaseTask
remarks: ''
isDeprecated: false
syntax:
content: 'jobReleaseTask?: JobReleaseTask'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.JobReleaseTask" />
- name: metadata
uid: '@azure/batch.BatchServiceModels.JobSpecification.metadata'
package: '@azure/batch'
summary: >-
A list of name-value pairs associated with each Job created under this
schedule as metadata.
The Batch service does not assign any meaning to metadata; it is solely
for the use of user
code.
fullName: metadata
remarks: ''
isDeprecated: false
syntax:
content: 'metadata?: MetadataItem[]'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.MetadataItem" />[]
- name: networkConfiguration
uid: '@azure/batch.BatchServiceModels.JobSpecification.networkConfiguration'
package: '@azure/batch'
summary: The network configuration for the Job.
fullName: networkConfiguration
remarks: ''
isDeprecated: false
syntax:
content: 'networkConfiguration?: JobNetworkConfiguration'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.JobNetworkConfiguration" />
- name: onAllTasksComplete
uid: '@azure/batch.BatchServiceModels.JobSpecification.onAllTasksComplete'
package: '@azure/batch'
summary: >-
The action the Batch service should take when all Tasks in a Job created
under this schedule
are in the completed state. Note that if a Job contains no Tasks, then all
Tasks are
considered complete. This option is therefore most commonly used with a
Job Manager task; if
you want to use automatic Job termination without a Job Manager, you
should initially set
onAllTasksComplete to noaction and update the Job properties to set
onAllTasksComplete to
terminatejob once you have finished adding Tasks. The default is noaction.
Possible values
include: 'noAction', 'terminateJob'
fullName: onAllTasksComplete
remarks: ''
isDeprecated: false
syntax:
content: 'onAllTasksComplete?: OnAllTasksComplete'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.OnAllTasksComplete" />
- name: onTaskFailure
uid: '@azure/batch.BatchServiceModels.JobSpecification.onTaskFailure'
package: '@azure/batch'
summary: >-
The action the Batch service should take when any Task fails in a Job
created under this
schedule. A Task is considered to have failed if it have failed if has a
failureInfo. A
failureInfo is set if the Task completes with a non-zero exit code after
exhausting its retry
count, or if there was an error starting the Task, for example due to a
resource file download
error. The default is noaction. Possible values include: 'noAction',
'performExitOptionsJobAction'
fullName: onTaskFailure
remarks: ''
isDeprecated: false
syntax:
content: 'onTaskFailure?: OnTaskFailure'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.OnTaskFailure" />
- name: poolInfo
uid: '@azure/batch.BatchServiceModels.JobSpecification.poolInfo'
package: '@azure/batch'
summary: >-
The Pool on which the Batch service runs the Tasks of Jobs created under
this schedule.
fullName: poolInfo
remarks: ''
isDeprecated: false
syntax:
content: 'poolInfo: PoolInformation'
return:
description: ''
type: <xref uid="@azure/batch.BatchServiceModels.PoolInformation" />
- name: priority
uid: '@azure/batch.BatchServiceModels.JobSpecification.priority'
package: '@azure/batch'
summary: >-
The priority of Jobs created under this schedule. Priority values can
range from -1000 to
1000, with -1000 being the lowest priority and 1000 being the highest
priority. The default
value is 0. This priority is used as the default for all Jobs under the
Job Schedule. You can
update a Job's priority after it has been created using by using the
update Job API.
fullName: priority
remarks: ''
isDeprecated: false
syntax:
content: 'priority?: number'
return:
description: ''
type: number
- name: usesTaskDependencies
uid: '@azure/batch.BatchServiceModels.JobSpecification.usesTaskDependencies'
package: '@azure/batch'
summary: >-
Whether Tasks in the Job can define dependencies on each other. The
default is false.
fullName: usesTaskDependencies
remarks: ''
isDeprecated: false
syntax:
content: 'usesTaskDependencies?: boolean'
return:
description: ''
type: boolean