swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Jobs API schemes: - https tags: - name: Jobs paths: /jobs: get: operationId: microsoftAzureBatchListjobs summary: Microsoft Azure Lists All Of The Jobs In The Specified Account description: Lists all of the Jobs in the specified Account. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.' required: false type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv - name: $expand in: query description: An OData $expand clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchJobListResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job list: $ref: ./examples/JobList.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Jobs post: operationId: microsoftAzureBatchCreatejob summary: Microsoft Azure Creates A Job To The Specified Account description: 'The Batch service supports two ways to control the work done as part of a Job.
In the first approach, the user specifies a Job Manager Task. The Batch service
launches this Task when it is ready to start the Job. The Job Manager Task
controls all other Tasks that run under this Job, by using the Task APIs. In
the second approach, the user directly controls the execution of Tasks under an
active Job, by using the Task APIs. Also note: when naming Jobs, avoid
including sensitive information such as user names or secret project names.
This information may appear in telemetry logs accessible to Microsoft Support
engineers.' consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: job in: body description: The Job to be created. required: true schema: $ref: '#/definitions/BatchJobCreateContent' responses: '201': description: The request has succeeded and a new resource has been created as a result. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Creates a basic job: $ref: ./examples/JobCreate_Basic.json Creates a complex job: $ref: ./examples/JobCreate_Complex.json tags: - Jobs /jobs/{jobId}: get: operationId: microsoftAzureBatchGetjob summary: Microsoft Azure Gets Information About The Specified Job description: Gets information about the specified Job. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job. required: true type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv - name: $expand in: query description: An OData $expand clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchJob' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job get: $ref: ./examples/JobGet.json tags: - Jobs put: operationId: microsoftAzureBatchReplacejob summary: Microsoft Azure Updates The Properties Of The Specified Job description: This fully replaces all the updatable properties of the Job. For example, if
the Job has constraints associated with it and if constraints is not specified
with this request, then the Batch service will remove the existing constraints. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job whose properties you want to update. required: true type: string - name: job in: body description: A job with updated properties required: true schema: $ref: '#/definitions/BatchJob' responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job update: $ref: ./examples/JobUpdate.json tags: - Jobs patch: operationId: microsoftAzureBatchUpdatejob summary: Microsoft Azure Updates The Properties Of The Specified Job description: This replaces only the Job properties specified in the request. For example, if
the Job has constraints, and a request does not specify the constraints
element, then the Job keeps the existing constraints. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job whose properties you want to update. required: true type: string - name: job in: body description: The options to use for updating the Job. required: true schema: $ref: '#/definitions/BatchJobUpdateContent' responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job patch: $ref: ./examples/JobPatch.json tags: - Jobs delete: operationId: microsoftAzureBatchDeletejob summary: Microsoft Azure Deletes A Job description: Deleting a Job also deletes all Tasks that are part of that Job, and all Job
statistics. This also overrides the retention period for Task data; that is, if
the Job contains Tasks which are still retained on Compute Nodes, the Batch
services deletes those Tasks' working directories and all their contents. When
a Delete Job request is received, the Batch service sets the Job to the
deleting state. All update operations on a Job that is in deleting state will
fail with status code 409 (Conflict), with additional information indicating
that the Job is being deleted. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job to delete. required: true type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Delete Job: $ref: ./examples/JobDelete.json tags: - Jobs /jobs/{jobId}/addtaskcollection: post: operationId: microsoftAzureBatchCreatetaskcollection summary: Microsoft Azure Adds A Collection Of Tasks To The Specified Job description: Note that each Task must have a unique ID. The Batch service may not return the
results for each Task in the same order the Tasks were submitted in this
request. If the server times out or the connection is closed during the
request, the request may have been partially or fully processed, or not at all.
In such cases, the user should re-issue the request. Note that it is up to the
user to correctly handle failures when re-issuing a request. For example, you
should use the same Task IDs during a retry so that if the prior operation
succeeded, the retry will not create extra Tasks unexpectedly. If the response
contains any Tasks which failed to add, a client can retry the request. In a
retry, it is most efficient to resubmit only Tasks that failed to add, and to
omit Tasks that were successfully added on the first attempt. The maximum
lifetime of a Task from addition to completion is 180 days. If a Task has not
completed within 180 days of being added it will be terminated by the Batch
service and left in whatever state it was in at that time. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: jobId in: path description: The ID of the Job to which the Task collection is to be added. required: true type: string - name: taskCollection in: body description: The Tasks to be added. required: true schema: $ref: '#/definitions/BatchTaskGroup' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchTaskAddCollectionResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Creates a basic collection of tasks: $ref: ./examples/TaskCreateCollection_Basic.json Creates a complex collection of tasks: $ref: ./examples/TaskCreateCollection_Complex.json tags: - Jobs /jobs/{jobId}/disable: post: operationId: microsoftAzureBatchDisablejob summary: Microsoft Azure Disables The Specified Job, Preventing New Tasks From Running description: The Batch Service immediately moves the Job to the disabling state. Batch then
uses the disableTasks parameter to determine what to do with the currently
running Tasks of the Job. The Job remains in the disabling state until the
disable operation is completed and all Tasks have been dealt with according to
the disableTasks option; the Job then moves to the disabled state. No new Tasks
are started under the Job until it moves back to active state. If you try to
disable a Job that is in any state other than active, disabling, or disabled,
the request fails with status code 409. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job to disable. required: true type: string - name: content in: body description: The options to use for disabling the Job. required: true schema: $ref: '#/definitions/BatchJobDisableContent' responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job disable: $ref: ./examples/JobDisable.json tags: - Jobs /jobs/{jobId}/enable: post: operationId: microsoftAzureBatchEnablejob summary: Microsoft Azure Enables The Specified Job, Allowing New Tasks To Run description: When you call this API, the Batch service sets a disabled Job to the enabling
state. After the this operation is completed, the Job moves to the active
state, and scheduling of new Tasks under the Job resumes. The Batch service
does not allow a Task to remain in the active state for more than 180 days.
Therefore, if you enable a Job containing active Tasks which were added more
than 180 days ago, those Tasks will not run. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job to enable. required: true type: string responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job enable: $ref: ./examples/JobEnable.json tags: - Jobs /jobs/{jobId}/jobpreparationandreleasetaskstatus: get: operationId: microsoftAzureBatchListjobpreparationandreleasetaskstatus summary: 'Microsoft Azure Lists The Execution Status Of The Job Preparation And Job Release Task For The specified Job Across The Compute Nodes Where The Job Has Run' description: This API returns the Job Preparation and Job Release Task status on all Compute
Nodes that have run the Job Preparation or Job Release Task. This includes
Compute Nodes which have since been removed from the Pool. If this API is
invoked on a Job which has no Job Preparation or Job Release Task, the Batch
service returns HTTP status code 409 (Conflict) with an error code of
JobPreparationTaskNotSpecified. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: jobId in: path description: The ID of the Job. required: true type: string - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.' required: false type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchJobPreparationAndReleaseTaskStatusListResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job list preparation and release task status: $ref: ./examples/JobListPreparationAndReleaseTaskStatus.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Jobs /jobs/{jobId}/taskcounts: get: operationId: microsoftAzureBatchGetjobtaskcounts summary: Microsoft Azure Gets The Task Counts For The Specified Job description: Task counts provide a count of the Tasks by active, running or completed Task
state, and a count of Tasks which succeeded or failed. Tasks in the preparing
state are counted as running. Note that the numbers returned may not always be
up to date. If you need exact task counts, use a list query. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: jobId in: path description: The ID of the Job. required: true type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchTaskCountsResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job get task counts: $ref: ./examples/JobGetTaskCounts.json tags: - Jobs /jobs/{jobId}/tasks: get: operationId: microsoftAzureBatchListtasks summary: Microsoft Azure Lists All Of The Tasks That Are Associated With The Specified Job description: For multi-instance Tasks, information such as affinityId, executionInfo and
nodeInfo refer to the primary Task. Use the list subtasks API to retrieve
information about subtasks. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: jobId in: path description: The ID of the Job. required: true type: string - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.' required: false type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv - name: $expand in: query description: An OData $expand clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchTaskListResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Task list: $ref: ./examples/TaskList.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Jobs post: operationId: microsoftAzureBatchCreatetask summary: Microsoft Azure Creates A Task To The Specified Job description: The maximum lifetime of a Task from addition to completion is 180 days. If a
Task has not completed within 180 days of being added it will be terminated by
the Batch service and left in whatever state it was in at that time. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: jobId in: path description: The ID of the Job to which the Task is to be created. required: true type: string - name: task in: body description: The Task to be created. required: true schema: $ref: '#/definitions/BatchTaskCreateContent' responses: '201': description: The request has succeeded and a new resource has been created as a result. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Creates a basic task: $ref: ./examples/TaskCreate_Basic.json Creates a task with container settings: $ref: ./examples/TaskCreate_ContainerSettings.json Creates a task with exit conditions: $ref: ./examples/TaskCreate_ExitConditions.json Creates a task with extra slot requirement: $ref: ./examples/TaskCreate_RequiredSlots.json tags: - Jobs /jobs/{jobId}/tasks/{taskId}: get: operationId: microsoftAzureBatchGettask summary: Microsoft Azure Gets Information About The Specified Task description: For multi-instance Tasks, information such as affinityId, executionInfo and
nodeInfo refer to the primary Task. Use the list subtasks API to retrieve
information about subtasks. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job that contains the Task. required: true type: string - name: taskId in: path description: The ID of the Task to get information about. required: true type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv - name: $expand in: query description: An OData $expand clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchTask' headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Task get: $ref: ./examples/TaskGet.json tags: - Jobs put: operationId: microsoftAzureBatchReplacetask description: Updates the properties of the specified Task. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job containing the Task. required: true type: string - name: taskId in: path description: The ID of the Task to update. required: true type: string - name: task in: body description: The Task to update. required: true schema: $ref: '#/definitions/BatchTask' responses: '200': description: The request has succeeded. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Task update: $ref: ./examples/TaskUpdate.json summary: Microsoft Azure Put Jobs Jobid Tasks Taskid tags: - Jobs delete: operationId: microsoftAzureBatchDeletetask summary: Microsoft Azure Deletes A Task From The Specified Job description: When a Task is deleted, all of the files in its directory on the Compute Node
where it ran are also deleted (regardless of the retention time). For
multi-instance Tasks, the delete Task operation applies synchronously to the
primary task; subtasks and their files are then deleted asynchronously in the
background. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job from which to delete the Task. required: true type: string - name: taskId in: path description: The ID of the Task to delete. required: true type: string responses: '200': description: The request has succeeded. headers: client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Task delete: $ref: ./examples/TaskDelete.json tags: - Jobs /jobs/{jobId}/tasks/{taskId}/files: get: operationId: microsoftAzureBatchListtaskfiles summary: Microsoft Azure Lists The Files In A Task S Directory On Its Compute Node description: Lists the files in a Task's directory on its Compute Node. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 - name: jobId in: path description: The ID of the Job that contains the Task. required: true type: string - name: taskId in: path description: The ID of the Task whose files you want to list. required: true type: string - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.' required: false type: string - name: recursive in: query description: 'Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files.' required: false type: boolean responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchNodeFileListResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: File list from task: $ref: ./examples/FileListFromTask.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Jobs /jobs/{jobId}/tasks/{taskId}/files/{filePath}: get: operationId: microsoftAzureBatchGettaskfile description: Returns the content of the specified Task file. produces: - application/octet-stream - application/json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: jobId in: path description: The ID of the Job that contains the Task. required: true type: string - name: taskId in: path description: The ID of the Task whose file you want to retrieve. required: true type: string - name: filePath in: path description: The path to the Task file that you want to get the content of. required: true type: string - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: ocp-range in: header description: 'The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.' required: false type: string responses: '200': description: The request has succeeded. schema: type: file headers: Content-Length: type: integer format: int64 description: The length of the file. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ocp-batch-file-isdirectory: type: boolean description: Whether the object represents a directory. ocp-batch-file-mode: type: string description: The file mode attribute in octal format. ocp-batch-file-url: type: string description: The URL of the file. ocp-creation-time: type: string format: date-time-rfc7231 description: The file creation time. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Get File From Task: $ref: ./examples/FileGetFromTask.json summary: Microsoft Azure Get Jobs Jobid Tasks Taskid Files Filepath tags: - Jobs delete: operationId: microsoftAzureBatchDeletetaskfile summary: Microsoft Azure Deletes The Specified Task File From The Compute Node Where The Task Ran description: Deletes the specified Task file from the Compute Node where the Task ran. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: jobId in: path description: The ID of the Job that contains the Task. required: true type: string - name: taskId in: path description: The ID of the Task whose file you want to retrieve. required: true type: string - name: filePath in: path description: The path to the Task file that you want to get the content of. required: true type: string - name: recursive in: query description: 'Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.' required: false type: boolean responses: '200': description: The request has succeeded. headers: client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: File delete from task: $ref: ./examples/FileDeleteFromTask.json tags: - Jobs head: operationId: microsoftAzureBatchGettaskfileproperties description: Gets the properties of the specified Task file. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: jobId in: path description: The ID of the Job that contains the Task. required: true type: string - name: taskId in: path description: The ID of the Task whose file you want to retrieve. required: true type: string - name: filePath in: path description: The path to the Task file that you want to get the content of. required: true type: string - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince responses: '200': description: The request has succeeded. headers: Content-Length: type: integer format: int64 description: The length of the file. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ocp-batch-file-isdirectory: type: boolean description: Whether the object represents a directory. ocp-batch-file-mode: type: string description: The file mode attribute in octal format. ocp-batch-file-url: type: string description: The URL of the file. ocp-creation-time: type: string format: date-time-rfc7231 description: The file creation time. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: File get properties from task: $ref: ./examples/FileGetPropertiesFromTask.json summary: Microsoft Azure Head Jobs Jobid Tasks Taskid Files Filepath tags: - Jobs /jobs/{jobId}/tasks/{taskId}/reactivate: post: operationId: microsoftAzureBatchReactivatetask summary: 'Microsoft Azure Reactivates A Task, Allowing It To Run Again Even If Its Retry Count Has Been exhausted' description: Reactivation makes a Task eligible to be retried again up to its maximum retry
count. The Task's state is changed to active. As the Task is no longer in the
completed state, any previous exit code or failure information is no longer
available after reactivation. Each time a Task is reactivated, its retry count
is reset to 0. Reactivation will fail for Tasks that are not completed or that
previously completed successfully (with an exit code of 0). Additionally, it
will fail if the Job has completed (or is terminating or deleting). parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job containing the Task. required: true type: string - name: taskId in: path description: The ID of the Task to reactivate. required: true type: string responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Task reactivate: $ref: ./examples/TaskReactivate.json tags: - Jobs /jobs/{jobId}/tasks/{taskId}/subtasksinfo: get: operationId: microsoftAzureBatchListsubtasks summary: 'Microsoft Azure Lists All Of The Subtasks That Are Associated With The Specified Multi Instance task' description: If the Task is not a multi-instance Task then this returns an empty collection. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: jobId in: path description: The ID of the Job. required: true type: string - name: taskId in: path description: The ID of the Task. required: true type: string - name: $select in: query description: An OData $select clause. required: false type: array items: type: string collectionFormat: csv responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchTaskListSubtasksResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Task list subtasks: $ref: ./examples/TaskListSubtasks.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Jobs /jobs/{jobId}/tasks/{taskId}/terminate: post: operationId: microsoftAzureBatchTerminatetask summary: Microsoft Azure Terminates The Specified Task description: When the Task has been terminated, it moves to the completed state. For
multi-instance Tasks, the terminate Task operation applies synchronously to the
primary task; subtasks are then terminated asynchronously in the background. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job containing the Task. required: true type: string - name: taskId in: path description: The ID of the Task to terminate. required: true type: string responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Task terminate: $ref: ./examples/TaskTerminate.json tags: - Jobs /jobs/{jobId}/terminate: post: operationId: microsoftAzureBatchTerminatejob summary: Microsoft Azure Terminates The Specified Job, Marking It As Completed description: When a Terminate Job request is received, the Batch service sets the Job to the
terminating state. The Batch service then terminates any running Tasks
associated with the Job and runs any required Job release Tasks. Then the Job
moves into the completed state. If there are any Tasks in the Job in the active
state, they will remain in the active state. Once a Job is terminated, new
Tasks cannot be added and any remaining active Tasks will not be scheduled. consumes: - application/json; odata=minimalmetadata parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: If-Modified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifModifiedSince - name: If-Unmodified-Since in: header description: 'A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ifUnmodifiedSince - name: If-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service exactly matches the value specified by the client.' required: false type: string x-ms-client-name: ifMatch - name: If-None-Match in: header description: 'An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource''s current ETag on the service does not match the value specified by the client.' required: false type: string x-ms-client-name: ifNoneMatch - name: jobId in: path description: The ID of the Job to terminate. required: true type: string - name: parameters in: body description: The options to use for terminating the Job. required: false schema: $ref: '#/definitions/BatchJobTerminateContent' responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: type: string description: The OData ID of the resource to which the request applied. ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Job terminate: $ref: ./examples/JobTerminate.json tags: - Jobs /jobs/{jobId}/devices: get: operationId: microsoftAzureJobsGetdevices summary: Microsoft Azure Get Device Statuses description: Get the list of individual device statuses by job ID. x-ms-examples: Get device statuses: $ref: ./examples/jobs_devices.json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/JobId' x-ms-pageable: nextLinkName: nextLink responses: '200': description: Success schema: $ref: '#/definitions/JobDeviceStatusCollection' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' tags: - Jobs /jobs/{jobId}/rerun/{rerunId}: put: operationId: microsoftAzureJobsRerun summary: Microsoft Azure Rerun A Job On Failed Devices description: Execute a rerun of an existing job on all failed devices. x-ms-examples: Rerun a job on failed devices: $ref: ./examples/jobs_rerun.json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/JobId' - in: path name: rerunId description: Unique ID of the job rerun. x-ms-parameter-location: method type: string required: true responses: '200': description: Success schema: $ref: '#/definitions/Job' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' tags: - Jobs /jobs/{jobId}/resume: post: operationId: microsoftAzureJobsResume summary: Microsoft Azure Resume A Stopped Job description: Resume execution of an existing stopped job. x-ms-examples: Resume a stopped job: $ref: ./examples/jobs_resume.json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/JobId' responses: '204': description: Success default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' tags: - Jobs /jobs/{jobId}/stop: post: operationId: microsoftAzureJobsStop summary: Microsoft Azure Stop A Running Job description: Stop execution of a job that is currently running. x-ms-examples: Stop a running job: $ref: ./examples/jobs_stop.json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/JobId' responses: '204': description: Success default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' tags: - Jobs /lifetimejobstats: get: tags: - Jobs operationId: microsoftAzureJobGetalllifetimestatistics x-ms-examples: Job get lifetime statistics: $ref: ./examples/JobGetLifetimeStatistics.json summary: Microsoft Azure Gets Lifetime Summary Statistics For All Of The Jobs In The Specified Account description: Statistics are aggregated across all Jobs that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. x-ms-request-id: request-id parameters: - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the Job statistics for the lifetime of the Batch Account. schema: $ref: '#/definitions/JobStatistics' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' /jobschedules/{jobScheduleId}/jobs: get: tags: - Jobs x-ms-pageable: nextLinkName: odata.nextLink x-ms-examples: List Job Under Job Schedule: $ref: ./examples/JobListFromJobSchedule.json operationId: microsoftAzureJobListfromjobschedule summary: Microsoft Azure Lists The Jobs That Have Been Created Under The Specified Job Schedule x-ms-request-id: request-id parameters: - name: jobScheduleId in: path required: true type: string description: The ID of the Job Schedule from which you want to get a list of Jobs. - name: $filter in: query required: false type: string description: An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. x-ms-parameter-grouping: postfix: Options - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: $expand in: query required: false type: string description: An OData $expand clause. x-ms-parameter-grouping: postfix: Options - name: maxresults x-ms-client-name: maxResults default: 1000 minimum: 1 maximum: 1000 in: query required: false type: integer format: int32 description: The maximum number of items to return in the response. A maximum of 1000 Jobs can be returned. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the list of Jobs. schema: $ref: '#/definitions/CloudJobListResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError_2' description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name} : get: tags: - Jobs summary: Microsoft Azure Gets The Details Of A Specified Job On A Data Box Edge Data Box Gateway Device operationId: microsoftAzureJobsGet parameters: - name: deviceName in: path description: The device name. required: true type: string - name: name in: path description: The job name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The job details. schema: $ref: '#/definitions/Job_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: JobsGet: $ref: ./examples/JobsGet.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs: get: tags: - Jobs description: Lists all the jobs available under the subscription. operationId: microsoftAzureJobsList consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/apiVersionParameter_2' - name: $skipToken in: query description: $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. required: false type: string responses: '200': description: List of jobs available under the subscription. schema: $ref: '#/definitions/JobResourceList' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: JobsList: $ref: ./examples/JobsList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databox Jobs /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate: post: tags: - Jobs description: Request to mitigate for a given job operationId: microsoftAzureMitigate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/apiVersionParameter_2' - name: mitigateJobRequest in: body description: Mitigation Request required: true schema: $ref: '#/definitions/MitigateJobRequest' responses: '204': description: Success default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-examples: Mitigate: $ref: ./examples/JobMitigate.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Mitigate ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/markDevicesShipped : post: tags: - Jobs description: Request to mark devices for a given job as shipped operationId: microsoftAzureJobsMarkdevicesshipped consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/apiVersionParameter_2' - name: markDevicesShippedRequest in: body description: Mark Devices Shipped Request required: true schema: $ref: '#/definitions/MarkDevicesShippedRequest' responses: '204': description: Success default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-examples: MarkDevicesShipped: $ref: ./examples/MarkDevicesShipped.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Markdevicesshipped /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs: get: tags: - Jobs description: Lists all the jobs available under the given resource group. operationId: microsoftAzureJobsListbyresourcegroup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/apiVersionParameter_2' - name: $skipToken in: query description: $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. required: false type: string responses: '200': description: List of jobs by resource group. schema: $ref: '#/definitions/JobResourceList' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: JobsListByResourceGroup: $ref: ./examples/JobsListByResourceGroup.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}: get: tags: - Jobs description: Gets information about the specified job. operationId: microsoftAzureJobsGet consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/apiVersionParameter_2' - name: $expand in: query description: $expand is supported on details parameter for job, which provides details on the job stages. required: false type: string responses: '200': description: Job object. schema: $ref: '#/definitions/JobResource' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-examples: JobsGet: $ref: ./examples/JobsGet.json JobsGetCmk: $ref: ./examples/JobsGetCmk.json JobsGetExport: $ref: ./examples/JobsGetExport.json JobsGetCopyStuck: $ref: ./examples/JobsGetCopyStuck.json JobsGetWaitingForAction: $ref: ./examples/JobsGetWaitingForAction.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname put: tags: - Jobs description: Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API. operationId: microsoftAzureJobsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/apiVersionParameter_2' - name: jobResource in: body description: Job details from request body. required: true schema: $ref: '#/definitions/JobResource' responses: '200': description: Job object. schema: $ref: '#/definitions/JobResource' '202': description: Accepted request for create Job. default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-long-running-operation: true x-ms-examples: JobsCreate: $ref: ./examples/JobsCreate.json JobsCreateDevicePassword: $ref: ./examples/JobsCreateDevicePassword.json JobsCreateExport: $ref: ./examples/JobsCreateExport.json JobsCreateDoubleEncryption: $ref: ./examples/JobsCreateDoubleEncryption.json JobsCreateWithUserAssignedIdentity: $ref: ./examples/JobsCreateWithUserAssignedIdentity.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname delete: tags: - Jobs description: Deletes a job. operationId: microsoftAzureJobsDelete consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: Just for swagger we are adding this status code. '202': description: Accepted request for delete Job. headers: Location: description: The URI to poll for completion status. type: string '204': description: Job deleted. default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-long-running-operation: true x-ms-examples: JobsDelete: $ref: ./examples/JobsDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname patch: tags: - Jobs description: Updates the properties of an existing job. operationId: microsoftAzureJobsUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/apiVersionParameter_2' - name: If-Match in: header description: Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value. type: string - name: jobResourceUpdateParameter in: body description: Job update parameters from request body. required: true schema: $ref: '#/definitions/JobResourceUpdateParameter' responses: '200': description: Job object. schema: $ref: '#/definitions/JobResource' '202': description: Accepted request for job updated. headers: Location: description: The URI to poll for completion status. type: string default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-long-running-operation: true x-ms-examples: JobsPatch: $ref: ./examples/JobsPatch.json JobsPatchCmk: $ref: ./examples/JobsPatchCmk.json JobsPatchSystemAssignedToUserAssigned: $ref: ./examples/JobsPatchSystemAssignedToUserAssigned.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp : post: tags: - Jobs description: Book shipment pick up. operationId: microsoftAzureJobsBookshipmentpickup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/apiVersionParameter_2' - name: shipmentPickUpRequest in: body description: Details of shipment pick up request. required: true schema: $ref: '#/definitions/ShipmentPickUpRequest' responses: '200': description: Booked shipment pick up successfully. schema: $ref: '#/definitions/ShipmentPickUpResponse' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-examples: BookShipmentPickupPost: $ref: ./examples/BookShipmentPickupPost.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Bookshipmentpickup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel: post: tags: - Jobs description: CancelJob. operationId: microsoftAzureJobsCancel consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/apiVersionParameter_2' - name: cancellationReason in: body description: Reason for cancellation. required: true schema: $ref: '#/definitions/CancellationReason' responses: '204': description: Job cancelled. default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-examples: JobsCancelPost: $ref: ./examples/JobsCancelPost.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials : post: tags: - Jobs description: This method gets the unencrypted secrets related to the job. operationId: microsoftAzureJobsListcredentials consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_2' - $ref: '#/parameters/resourceGroupNameParameter_2' - $ref: '#/parameters/jobNameParameter' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: List of unencrypted credentials of the job. schema: $ref: '#/definitions/UnencryptedCredentialsList' default: description: Error response describing reason for operation failure. schema: $ref: '#/definitions/ApiError' x-ms-pageable: nextLinkName: null x-ms-examples: JobsListCredentials: $ref: ./examples/JobsListCredentials.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Listcredentials ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs : get: tags: - Jobs description: This method gets all the jobs of a given job definition. operationId: microsoftAzureJobsListbyjobdefinition consumes: - application/json produces: - application/json parameters: - name: dataServiceName in: path description: The name of the data service of the job definition. required: true type: string - name: jobDefinitionName in: path description: The name of the job definition for which jobs are needed. required: true type: string - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/dataManagerNameParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: $filter in: query description: OData Filter options required: false type: string responses: '200': description: The list of jobs. schema: $ref: '#/definitions/JobList' x-ms-odata: '#/definitions/JobFilter' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Jobs_ListByJobDefinitionGET91: $ref: ./examples/Jobs_ListByJobDefinition-GET-example-91.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId} : get: tags: - Jobs description: This method gets a data manager job given the jobId. operationId: microsoftAzureJobsGet consumes: - application/json produces: - application/json parameters: - name: dataServiceName in: path description: The name of the data service of the job definition. required: true type: string - name: jobDefinitionName in: path description: The name of the job definition of the job. required: true type: string - name: jobId in: path description: The job id of the job queried. required: true type: string - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/dataManagerNameParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: $expand in: query description: $expand is supported on details parameter for job, which provides details on the job stages. required: false type: string responses: '200': description: The job that matches the given criteria. schema: $ref: '#/definitions/Job_3' x-ms-examples: Jobs_GetGET101: $ref: ./examples/Jobs_Get-GET-example-101.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs Jobid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/cancel : post: tags: - Jobs description: Cancels the given job. operationId: microsoftAzureJobsCancel consumes: - application/json produces: - application/json parameters: - name: dataServiceName in: path description: The name of the data service of the job definition. required: true type: string - name: jobDefinitionName in: path description: The name of the job definition of the job. required: true type: string - name: jobId in: path description: The job id of the job queried. required: true type: string - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/dataManagerNameParameter' - $ref: '#/parameters/apiVersionParameter_3' responses: '202': description: Accepted job cancellation request. '204': description: Job cancelled. x-ms-long-running-operation: true x-ms-examples: Jobs_CancelPOST111: $ref: ./examples/Jobs_Cancel-POST-example-111.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs Jobid Cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/resume : post: tags: - Jobs description: Resumes the given job. operationId: microsoftAzureJobsResume consumes: - application/json produces: - application/json parameters: - name: dataServiceName in: path description: The name of the data service of the job definition. required: true type: string - name: jobDefinitionName in: path description: The name of the job definition of the job. required: true type: string - name: jobId in: path description: The job id of the job queried. required: true type: string - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/dataManagerNameParameter' - $ref: '#/parameters/apiVersionParameter_3' responses: '202': description: Accepted job resume request. '204': description: Job resumed. x-ms-long-running-operation: true x-ms-examples: Jobs_ResumePOST121: $ref: ./examples/Jobs_Resume-POST-example-121.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs Jobid Resume ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobs : get: tags: - Jobs description: This method gets all the jobs of a data service type in a given resource. operationId: microsoftAzureJobsListbydataservice consumes: - application/json produces: - application/json parameters: - name: dataServiceName in: path description: The name of the data service of interest. required: true type: string - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/dataManagerNameParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: $filter in: query description: OData Filter options required: false type: string responses: '200': description: The list of jobs that match the service and resource. schema: $ref: '#/definitions/JobList' x-ms-odata: '#/definitions/JobFilter' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Jobs_ListByDataServiceGET141: $ref: ./examples/Jobs_ListByDataService-GET-example-141.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/jobs : get: tags: - Jobs description: This method gets all the jobs at the data manager resource level. operationId: microsoftAzureJobsListbydatamanager consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_3' - $ref: '#/parameters/resourceGroupNameParameter_3' - $ref: '#/parameters/dataManagerNameParameter' - $ref: '#/parameters/apiVersionParameter_3' - name: $filter in: query description: OData Filter options required: false type: string responses: '200': description: The list of jobs in the resource specified. schema: $ref: '#/definitions/JobList' x-ms-odata: '#/definitions/JobFilter' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Jobs_ListByDataManagerGET201: $ref: ./examples/Jobs_ListByDataManager-GET-example-201.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Jobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport : post: tags: - Jobs description: Triggers export of jobs specified by filters and returns an OperationID to track. operationId: microsoftAzureJobsExport produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/VaultName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: $filter in: query description: OData filter options. required: false type: string responses: '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-odata: '#/definitions/JobQueryObject' x-ms-examples: Export Jobs: $ref: ./examples/Common/TriggerExportJobs.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobsexport ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName} : get: tags: - Jobs operationId: microsoftAzureJobsGet description: Gets a job. parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: jobCollectionName in: path required: true type: string description: The job collection name. - name: jobName in: path required: true type: string description: The job name. - $ref: '#/parameters/apiVersion' responses: '200': description: The job has been successfully returned. schema: $ref: '#/definitions/JobDefinition_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname put: tags: - Jobs operationId: microsoftAzureJobsCreateorupdate description: Provisions a new job or updates an existing job. parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: jobCollectionName in: path required: true type: string description: The job collection name. - name: jobName in: path required: true type: string description: The job name. - $ref: '#/parameters/apiVersion' - name: job in: body required: true schema: $ref: '#/definitions/JobDefinition_2' description: The job definition. responses: '200': description: The job has been successfully updated. schema: $ref: '#/definitions/JobDefinition_2' '201': description: The job has been successfully created. schema: $ref: '#/definitions/JobDefinition_2' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname patch: tags: - Jobs operationId: microsoftAzureJobsPatch description: Patches an existing job. parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: jobCollectionName in: path required: true type: string description: The job collection name. - name: jobName in: path required: true type: string description: The job name. - $ref: '#/parameters/apiVersion' - name: job in: body required: true schema: $ref: '#/definitions/JobDefinition_2' description: The job definition. responses: '200': description: The job has been successfully patched. schema: $ref: '#/definitions/JobDefinition_2' summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname delete: tags: - Jobs operationId: microsoftAzureJobsDelete description: Deletes a job. parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: jobCollectionName in: path required: true type: string description: The job collection name. - name: jobName in: path required: true type: string description: The job name. - $ref: '#/parameters/apiVersion' responses: '200': description: The job has been successfully deleted. summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run : post: tags: - Jobs operationId: microsoftAzureJobsRun description: Runs a job. parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: jobCollectionName in: path required: true type: string description: The job collection name. - name: jobName in: path required: true type: string description: The job name. - $ref: '#/parameters/apiVersion' responses: '200': description: The job has been successfully run. summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname Run ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs : get: tags: - Jobs operationId: microsoftAzureJobsList description: Lists all jobs under the specified job collection. parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: jobCollectionName in: path required: true type: string description: The job collection name. - $ref: '#/parameters/apiVersion' - name: $top in: query required: false type: integer minimum: 1 maximum: 100 description: The number of jobs to request, in the of range of [1..100]. - name: $skip in: query required: false type: integer description: The (0-based) index of the job history list from which to begin requesting entries. - name: $filter description: The filter to apply on the job state. in: query required: false type: string responses: '200': description: The job has been successfully returned. schema: $ref: '#/definitions/JobListResult' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/JobStateFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history : get: tags: - Jobs operationId: microsoftAzureJobsListjobhistory description: Lists job history. parameters: - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The resource group name. - name: jobCollectionName in: path required: true type: string description: The job collection name. - name: jobName in: path required: true type: string description: The job name. - $ref: '#/parameters/apiVersion' - name: $top in: query required: false type: integer minimum: 1 maximum: 100 description: the number of job history to request, in the of range of [1..100]. - name: $skip in: query required: false type: integer description: The (0-based) index of the job history list from which to begin requesting entries. - name: $filter description: The filter to apply on the job state. in: query required: false type: string responses: '200': description: The job histories have been successfully returned. schema: $ref: '#/definitions/JobHistoryListResult' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/JobHistoryFilter' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname History ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs : get: tags: - Jobs description: Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned. operationId: microsoftAzureJobsListbydevice consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - $ref: '#/parameters/subscriptionIdParameter_4' - $ref: '#/parameters/resourceGroupNameParameter_4' - $ref: '#/parameters/managerNameParameter' - $ref: '#/parameters/apiVersionParameter_4' - name: $filter in: query description: OData Filter options required: false type: string responses: '200': description: The collection of jobs for the specified manager and device name. schema: $ref: '#/definitions/JobList_2' deprecated: false x-ms-odata: '#/definitions/JobFilter' x-ms-pageable: nextLinkName: nextLink x-ms-examples: JobsListByDevice: $ref: ./examples/JobsListByDevice.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName} : get: tags: - Jobs description: Gets the details of the specified job name. operationId: microsoftAzureJobsGet consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - name: jobName in: path description: The job Name. required: true type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter_4' - $ref: '#/parameters/resourceGroupNameParameter_4' - $ref: '#/parameters/managerNameParameter' - $ref: '#/parameters/apiVersionParameter_4' responses: '200': description: The job. schema: $ref: '#/definitions/Job_4' deprecated: false x-ms-examples: JobsGet: $ref: ./examples/JobsGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs Jobname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName}/cancel : post: tags: - Jobs description: Cancels a job on the device. operationId: microsoftAzureJobsCancel consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/deviceNameParameter' - name: jobName in: path description: The jobName. required: true type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter_4' - $ref: '#/parameters/resourceGroupNameParameter_4' - $ref: '#/parameters/managerNameParameter' - $ref: '#/parameters/apiVersionParameter_4' responses: '202': description: Accepted the request to cancel a deviceJob '204': description: Successfully cancelled the deviceJob deprecated: false x-ms-long-running-operation: true x-ms-examples: JobsCancel: $ref: ./examples/JobsCancel.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs Jobname Cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/jobs : get: tags: - Jobs description: Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned. operationId: microsoftAzureJobsListbymanager consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionIdParameter_4' - $ref: '#/parameters/resourceGroupNameParameter_4' - $ref: '#/parameters/managerNameParameter' - $ref: '#/parameters/apiVersionParameter_4' - name: $filter in: query description: OData Filter options required: false type: string responses: '200': description: The collection of device jobs on all devices under the specified manager. schema: $ref: '#/definitions/JobList_2' deprecated: false x-ms-odata: '#/definitions/JobFilter' x-ms-pageable: nextLinkName: nextLink x-ms-examples: JobsListByManager: $ref: ./examples/JobsListByManager.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Jobs definitions: CloudServiceConfigurationUpdate: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.' properties: osFamily: type: string description: 'Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).' osVersion: type: string description: The Azure Guest OS version to be installed on the virtual machines in the Pool. The default value is * which specifies the latest operating system version for the specified OS family. BatchTaskSchedulingPolicy: type: object description: Specifies how Tasks should be distributed across Compute Nodes. properties: nodeFillType: $ref: '#/definitions/BatchNodeFillType' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. required: - nodeFillType VirtualMachineConfiguration_2: properties: imageReference: $ref: '#/definitions/ImageReference_2' title: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. nodeAgentSKUId: type: string title: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. description: The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. windowsConfiguration: $ref: '#/definitions/WindowsConfiguration_2' title: Windows operating system settings on the virtual machine. description: This property must not be specified if the imageReference property specifies a Linux OS Image. dataDisks: type: array items: $ref: '#/definitions/DataDisk_2' title: The configuration for data disks attached to the Compute Nodes in the Pool. description: This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. licenseType: type: string title: The type of on-premises license to be used when deploying the operating system. description: "This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n" containerConfiguration: $ref: '#/definitions/ContainerConfiguration_2' title: The container configuration for the Pool. description: If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. diskEncryptionConfiguration: $ref: '#/definitions/DiskEncryptionConfiguration_2' title: The disk encryption configuration for the pool. description: If specified, encryption is performed on each node in the pool during node provisioning. required: - nodeAgentSKUId - imageReference title: The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure. EncryptionPreferences: description: Preferences related to the Encryption. type: object properties: doubleEncryption: description: Defines secondary layer of software-based encryption enablement. enum: - Enabled - Disabled type: string x-ms-enum: name: DoubleEncryption modelAsExtensible: true values: - value: Enabled description: Software-based encryption is enabled. - value: Disabled description: Software-based encryption is disabled. default: Disabled hardwareEncryption: description: Defines Hardware level encryption (Only for disk) enum: - Enabled - Disabled type: string x-ms-enum: name: HardwareEncryption modelAsExtensible: true values: - value: Enabled description: Hardware-based encryption is enabled. - value: Disabled description: Hardware-based encryption is enabled. CIFSMountConfiguration: properties: username: type: string title: The user to use for authentication against the CIFS file system. source: type: string title: The URI of the file system to mount. relativeMountPath: type: string title: The relative path on the compute node where the file system will be mounted description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string title: Additional command line options to pass to the mount command. description: These are 'net use' options in Windows and 'mount' options in Linux. password: type: string title: The password to use for authentication against the CIFS file system. required: - username - source - password - relativeMountPath title: Information used to connect to a CIFS file system. JobStatistics: properties: url: type: string title: The URL of the statistics. startTime: type: string format: date-time title: The start time of the time range covered by the statistics. lastUpdateTime: type: string format: date-time title: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. userCPUTime: type: string format: duration title: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. kernelCPUTime: type: string format: duration title: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. wallClockTime: type: string format: duration title: The total wall clock time of all Tasks in the Job. description: ' The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries.' readIOps: type: integer format: int64 title: The total number of disk read operations made by all Tasks in the Job. writeIOps: type: integer format: int64 title: The total number of disk write operations made by all Tasks in the Job. readIOGiB: type: number format: double title: The total amount of data in GiB read from disk by all Tasks in the Job. writeIOGiB: type: number format: double title: The total amount of data in GiB written to disk by all Tasks in the Job. numSucceededTasks: type: integer format: int64 title: The total number of Tasks successfully completed in the Job during the given time range. description: A Task completes successfully if it returns exit code 0. numFailedTasks: type: integer format: int64 title: The total number of Tasks in the Job that failed during the given time range. description: A Task fails if it exhausts its maximum retry count without returning exit code 0. numTaskRetries: type: integer format: int64 title: The total number of retries on all the Tasks in the Job during the given time range. waitTime: type: string format: duration title: The total wait time of all Tasks in the Job. description: The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. required: - url - startTime - lastUpdateTime - userCPUTime - kernelCPUTime - wallClockTime - readIOps - writeIOps - readIOGiB - writeIOGiB - numSucceededTasks - numFailedTasks - numTaskRetries - waitTime title: Resource usage statistics for a Job. JobProperties_3: description: Job Properties required: - isCancellable type: object properties: isCancellable: description: Describes whether the job is cancellable. enum: - NotCancellable - Cancellable type: string x-ms-enum: name: IsJobCancellable modelAsString: false bytesProcessed: format: int64 description: Number of bytes processed by the job as of now. type: integer itemsProcessed: format: int64 description: Number of items processed by the job as of now type: integer totalBytesToProcess: format: int64 description: Number of bytes to be processed by the job in total. type: integer totalItemsToProcess: format: int64 description: Number of items to be processed by the job in total type: integer details: $ref: '#/definitions/JobDetails_2' description: Details of a job run. This field will only be sent for expand details filter. dataSourceName: description: Name of the data source on which the job was triggered. type: string dataSinkName: description: Name of the data sink on which the job was triggered. type: string TransferAllDetails: description: Details to transfer all data. required: - dataAccountType type: object properties: dataAccountType: description: Type of the account of data enum: - StorageAccount - ManagedDisk type: string x-ms-enum: name: DataAccountType modelAsExtensible: true values: - value: StorageAccount description: Storage Accounts . - value: ManagedDisk description: Azure Managed disk storage. default: StorageAccount transferAllBlobs: description: To indicate if all Azure blobs have to be transferred type: boolean transferAllFiles: description: To indicate if all Azure Files have to be transferred type: boolean ContainerRegistry: type: object description: A private container registry. properties: username: type: string description: The user name to log into the registry server. password: type: string description: The password to log into the registry server. registryServer: type: string description: The registry URL. If omitted, the default is "docker.io". identityReference: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ServiceArtifactReference: type: object description: 'Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using ''latest'' image version.' properties: id: type: string description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} required: - id EnvironmentSetting_2: properties: name: type: string title: The name of the environment variable. value: type: string title: The value of the environment variable. required: - name title: An environment variable to be set on a Task process. UpdateJobDetails: description: Job details for update. type: object properties: contactDetails: $ref: '#/definitions/ContactDetails' description: Contact details for notification and shipping. shippingAddress: $ref: '#/definitions/ShippingAddress' description: Shipping address of the customer. reverseShippingDetails: $ref: '#/definitions/ReverseShippingDetails' preferences: $ref: '#/definitions/Preferences' keyEncryptionKey: $ref: '#/definitions/KeyEncryptionKey' description: Key encryption key for the job. returnToCustomerPackageDetails: $ref: '#/definitions/PackageCarrierDetails' description: Return package details of job. BatchPoolSpecificationUpdate: type: object description: Specification for creating a new Pool. properties: displayName: type: string description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. vmSize: type: string description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). cloudServiceConfiguration: $ref: '#/definitions/CloudServiceConfigurationUpdate' description: The cloud service configuration for the Pool. This property must be specified if the Pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'. virtualMachineConfiguration: $ref: '#/definitions/VirtualMachineConfigurationUpdate' description: The virtual machine configuration for the Pool. This property must be specified if the Pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). taskSlotsPerNode: type: integer format: int32 description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. taskSchedulingPolicy: $ref: '#/definitions/BatchTaskSchedulingPolicyUpdate' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. resizeTimeout: type: string format: duration description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). resourceTags: type: string description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. targetDedicatedNodes: type: integer format: int32 description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. targetLowPriorityNodes: type: integer format: int32 description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. enableAutoScale: type: boolean description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. autoScaleFormula: type: string description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. autoScaleEvaluationInterval: type: string format: duration description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). enableInterNodeCommunication: type: boolean description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. networkConfiguration: $ref: '#/definitions/NetworkConfigurationUpdate' description: The network configuration for the Pool. startTask: $ref: '#/definitions/BatchStartTaskUpdate' description: 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. certificateReferences: type: array description: '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.' items: $ref: '#/definitions/BatchCertificateReference' x-ms-identifiers: [] applicationPackageReferences: type: array description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new 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 Package references on any given Pool. items: $ref: '#/definitions/BatchApplicationPackageReference' x-ms-identifiers: [] applicationLicenses: type: array description: The list of application licenses the Batch service will make available on each Compute Node in the Pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail. The permitted licenses available on the Pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the Pool. items: type: string userAccounts: type: array description: The list of user Accounts to be created on each Compute Node in the Pool. items: $ref: '#/definitions/UserAccount' x-ms-identifiers: [] metadata: type: array description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] mountConfiguration: type: array description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. items: $ref: '#/definitions/MountConfiguration' x-ms-identifiers: [] targetNodeCommunicationMode: $ref: '#/definitions/BatchNodeCommunicationMode' description: The desired node communication mode for the pool. If omitted, the default value is Default. upgradePolicy: $ref: '#/definitions/UpgradePolicyUpdate' description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. BatchJobManagerTask: type: object description: 'Specifies details of a Job Manager Task. The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running ''normal'' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.' properties: id: type: string description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. displayName: type: string description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. commandLine: type: string description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/BatchTaskContainerSettings' description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] outputFiles: type: array description: A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. items: $ref: '#/definitions/OutputFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the Job Manager Task. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] constraints: $ref: '#/definitions/BatchTaskConstraints' description: Constraints that apply to the Job Manager Task. requiredSlots: type: integer format: int32 description: The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this property is not supported and must not be specified. killJobOnCompletion: type: boolean description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. runExclusive: type: boolean description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. applicationPackageReferences: type: array description: 'A list of Application Packages that the Batch service will deploy to the Compute Node before running the command line.Application Packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced Application Package is already on the Compute Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Application Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails.' items: $ref: '#/definitions/BatchApplicationPackageReference' x-ms-identifiers: [] authenticationTokenSettings: $ref: '#/definitions/AuthenticationTokenSettings' description: The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. allowLowPriorityNode: type: boolean description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. required: - id - commandLine CloudServiceConfiguration: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.' properties: osFamily: type: string description: 'Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).' osVersion: type: string description: The Azure Guest OS version to be installed on the virtual machines in the Pool. The default value is * which specifies the latest operating system version for the specified OS family. required: - osFamily OutputFile_2: properties: filePattern: type: string title: A pattern indicating which file(s) to upload. description: 'Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\*.txt matches any file that does not start in ''.'' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied.' destination: title: The destination for the output file(s). $ref: '#/definitions/OutputFileDestination_2' uploadOptions: title: Additional options for the upload operation, including under what conditions to perform the upload. $ref: '#/definitions/OutputFileUploadOptions' required: - filePattern - destination - uploadOptions title: A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process. description: On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure. BatchPoolSpecification: type: object description: Specification for creating a new Pool. properties: displayName: type: string description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. vmSize: type: string description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). cloudServiceConfiguration: $ref: '#/definitions/CloudServiceConfiguration' description: The cloud service configuration for the Pool. This property must be specified if the Pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'. virtualMachineConfiguration: $ref: '#/definitions/VirtualMachineConfiguration' description: The virtual machine configuration for the Pool. This property must be specified if the Pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). taskSlotsPerNode: type: integer format: int32 description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. taskSchedulingPolicy: $ref: '#/definitions/BatchTaskSchedulingPolicy' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. resizeTimeout: type: string format: duration description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). resourceTags: type: string description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. targetDedicatedNodes: type: integer format: int32 description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. targetLowPriorityNodes: type: integer format: int32 description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. enableAutoScale: type: boolean description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. autoScaleFormula: type: string description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. autoScaleEvaluationInterval: type: string format: duration description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). enableInterNodeCommunication: type: boolean description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. networkConfiguration: $ref: '#/definitions/NetworkConfiguration' description: The network configuration for the Pool. startTask: $ref: '#/definitions/BatchStartTask' description: 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. certificateReferences: type: array description: '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.' items: $ref: '#/definitions/BatchCertificateReference' x-ms-identifiers: [] applicationPackageReferences: type: array description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new 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 Package references on any given Pool. items: $ref: '#/definitions/BatchApplicationPackageReference' x-ms-identifiers: [] applicationLicenses: type: array description: The list of application licenses the Batch service will make available on each Compute Node in the Pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail. The permitted licenses available on the Pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the Pool. items: type: string userAccounts: type: array description: The list of user Accounts to be created on each Compute Node in the Pool. items: $ref: '#/definitions/UserAccount' x-ms-identifiers: [] metadata: type: array description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] mountConfiguration: type: array description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. items: $ref: '#/definitions/MountConfiguration' x-ms-identifiers: [] targetNodeCommunicationMode: $ref: '#/definitions/BatchNodeCommunicationMode' description: The desired node communication mode for the pool. If omitted, the default value is Default. upgradePolicy: $ref: '#/definitions/UpgradePolicy' description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. required: - vmSize JobRecurrenceSchedule: properties: weekDays: type: array items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday x-ms-enum: name: DayOfWeek modelAsString: false description: Gets or sets the days of the week that the job should execute on. hours: type: array items: type: integer description: Gets or sets the hours of the day that the job should execute at. minutes: type: array items: type: integer description: Gets or sets the minutes of the hour that the job should execute at. monthDays: type: array items: type: integer description: Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. monthlyOccurrences: type: array items: $ref: '#/definitions/JobRecurrenceScheduleMonthlyOccurrence' description: Gets or sets the occurrences of days within a month. DataAccountDetails: description: Account details of the data to be transferred required: - dataAccountType type: object properties: dataAccountType: description: Account Type of the data to be transferred. enum: - StorageAccount - ManagedDisk type: string x-ms-enum: name: DataAccountType modelAsExtensible: true values: - value: StorageAccount description: Storage Accounts . - value: ManagedDisk description: Azure Managed disk storage. default: StorageAccount sharePassword: description: 'Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+' type: string x-ms-secret: true x-ms-mutability: - create discriminator: dataAccountType CachingType_2: type: string title: The type of caching to enable for the disk. description: 'The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.' enum: - none - readonly - readwrite x-ms-enum: name: CachingType modelAsString: false values: - value: none description: The caching mode for the disk is not enabled. - value: readonly description: The caching mode for the disk is read only. name: readOnly - value: readwrite description: The caching mode for the disk is read and write. name: readWrite VirtualMachineConfiguration: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.' properties: imageReference: $ref: '#/definitions/ImageReference' description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. nodeAgentSKUId: type: string description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. x-ms-client-name: nodeAgentSkuId windowsConfiguration: $ref: '#/definitions/WindowsConfiguration' description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. dataDisks: type: array description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. items: $ref: '#/definitions/DataDisk' x-ms-identifiers: [] licenseType: type: string description: "This only applies to Images that contain the Windows operating system, and\nshould only be used when you hold valid on-premises licenses for the Compute\nNodes which will be deployed. If omitted, no on-premises licensing discount is\napplied. Values are:\n\n Windows_Server - The on-premises license is for Windows\nServer.\n Windows_Client - The on-premises license is for Windows Client.\n" containerConfiguration: $ref: '#/definitions/ContainerConfiguration' description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. diskEncryptionConfiguration: $ref: '#/definitions/DiskEncryptionConfiguration' description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. nodePlacementConfiguration: $ref: '#/definitions/BatchNodePlacementConfiguration' description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. extensions: type: array description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. items: $ref: '#/definitions/VMExtension' x-ms-identifiers: [] osDisk: $ref: '#/definitions/OSDisk' description: Settings for the operating system disk of the Virtual Machine. securityProfile: $ref: '#/definitions/SecurityProfile' description: Specifies the security profile settings for the virtual machine or virtual machine scale set. serviceArtifactReference: $ref: '#/definitions/ServiceArtifactReference' description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} required: - imageReference - nodeAgentSKUId systemData: description: Provides details about resource creation and update time type: object properties: createdBy: description: A string identifier for the identity that created the resource type: string readOnly: true createdByType: description: 'The type of identity that created the resource: user, application, managedIdentity' type: string readOnly: true createdAt: format: date-time description: The timestamp of resource creation (UTC) type: string readOnly: true lastModifiedBy: description: A string identifier for the identity that last modified the resource type: string readOnly: true lastModifiedByType: description: 'The type of identity that last modified the resource: user, application, managedIdentity' type: string readOnly: true lastModifiedAt: format: date-time description: The timestamp of resource last modification (UTC) type: string readOnly: true ErrorMessage: properties: lang: type: string title: The language code of the error message value: type: string title: The text of the message. title: An error message received in an Azure Batch error response. BatchJobConstraints: type: object description: The execution constraints for a Job. properties: maxWallClockTime: type: string format: duration description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. maxTaskRetryCount: type: integer format: int32 description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). KeyEncryptionKey: description: Encryption key containing details about key to encrypt different keys. required: - kekType type: object properties: kekType: description: Type of encryption key used for key encryption. enum: - MicrosoftManaged - CustomerManaged type: string x-ms-enum: name: KekType modelAsExtensible: true values: - value: MicrosoftManaged description: Key encryption key is managed by Microsoft. - value: CustomerManaged description: Key encryption key is managed by the Customer. default: MicrosoftManaged identityProperties: $ref: '#/definitions/IdentityProperties' description: Managed identity properties used for key encryption. kekUrl: description: Key encryption key. It is required in case of Customer managed KekType. type: string kekVaultResourceID: description: Kek vault resource id. It is required in case of Customer managed KekType. type: string DcAccessSecurityCode: description: Dc access security code type: object properties: reverseDCAccessCode: description: Reverse Dc access security code. type: string forwardDCAccessCode: description: Forward Dc access security code. type: string JobResource: description: Job Resource. required: - properties type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/JobProperties_2' description: Properties of a job. x-ms-client-flatten: true name: description: Name of the object. type: string readOnly: true id: description: Id of the object. type: string readOnly: true type: description: Type of the object. type: string readOnly: true systemData: $ref: '#/definitions/systemData' description: Metadata pertaining to creation and last modification of the resource. readOnly: true HttpAuthentication: discriminator: type required: - type properties: type: type: string description: Gets or sets the HTTP authentication type. enum: - NotSpecified - ClientCertificate - ActiveDirectoryOAuth - Basic x-ms-enum: name: HttpAuthenticationType modelAsString: false JobHistoryDefinition: properties: id: type: string readOnly: true description: Gets the job history identifier. type: type: string readOnly: true description: Gets the job history resource type. name: type: string readOnly: true description: Gets the job history name. properties: $ref: '#/definitions/JobHistoryDefinitionProperties' readOnly: true description: Gets or sets the job history properties. ShippingAddress: description: Shipping address where customer wishes to receive the device. required: - streetAddress1 - country type: object properties: streetAddress1: description: Street Address line 1. type: string streetAddress2: description: Street Address line 2. type: string streetAddress3: description: Street Address line 3. type: string city: description: Name of the City. type: string stateOrProvince: description: Name of the State or Province. type: string country: description: Name of the Country. type: string postalCode: description: Postal code. type: string zipExtendedCode: description: Extended Zip Code. type: string companyName: description: Name of the company. type: string addressType: description: Type of address. enum: - None - Residential - Commercial type: string x-ms-enum: name: AddressType modelAsExtensible: true values: - value: None description: Address type not known. - value: Residential description: Residential Address. - value: Commercial description: Commercial Address. default: None skipAddressValidation: type: boolean description: Flag to indicate if customer has chosen to skip default address validation taxIdentificationNumber: type: string description: Tax Identification Number JobErrorItem: description: The job error items. type: object properties: recommendations: description: The recommended actions. uniqueItems: false type: array items: type: string readOnly: true x-ms-identifiers: [] code: description: The code intended for programmatic access. type: string readOnly: true message: description: The message that describes the error in detail. type: string readOnly: true BatchJobUpdateContent: type: object description: Parameters for updating an Azure Batch Job. properties: priority: type: integer format: int32 description: The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the Job is left unchanged. allowTaskPreemption: type: boolean description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. maxParallelTasks: type: integer format: int32 description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. constraints: $ref: '#/definitions/BatchJobConstraints' description: The execution constraints for the Job. If omitted, the existing execution constraints are left unchanged. poolInfo: $ref: '#/definitions/BatchPoolInfoUpdate' description: The Pool on which the Batch service runs the Job's Tasks. You may change the Pool for a Job only when the Job is disabled. The Patch Job call will fail if you include the poolInfo element and the Job is not disabled. If you specify an autoPoolSpecification in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal). If omitted, the Job continues to run on its current Pool. onAllTasksComplete: $ref: '#/definitions/OnAllBatchTasksComplete' description: The action the Batch service should take when all Tasks in the Job are in the completed state. If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic Job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). metadata: type: array description: A list of name-value pairs associated with the Job as metadata. If omitted, the existing Job metadata is left unchanged. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] BatchPoolEndpointConfiguration: type: object description: The endpoint configuration for a Pool. properties: inboundNATPools: type: array description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. items: $ref: '#/definitions/InboundNATPool' x-ms-client-name: inboundNatPools x-ms-identifiers: [] required: - inboundNATPools BatchCertificateVisibility: type: string description: BatchCertificateVisibility enums enum: - starttask - task - remoteuser x-ms-enum: name: BatchCertificateVisibility modelAsString: true values: - name: StartTask value: starttask description: The Certificate should be visible to the user account under which the StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well. - name: Task value: task description: The Certificate should be visible to the user accounts under which Job Tasks are run. - name: RemoteUser value: remoteuser description: The Certificate should be visible to the user accounts under which users remotely access the Compute Node. InboundEndpointProtocol_2: type: string title: The protocol of the endpoint. enum: - tcp - udp x-ms-enum: name: InboundEndpointProtocol modelAsString: false values: - value: tcp description: Use TCP for the endpoint. name: tcp - value: udp description: Use UDP for the endpoint. name: udp JobData: description: The job data definition. type: object properties: type: description: Type of the job data. type: string required: - type discriminator: type PublicIPAddressConfiguration: properties: provision: $ref: '#/definitions/IPAddressProvisioningType' title: The provisioning type for Public IP Addresses for the Pool. description: The default value is BatchManaged. ipAddressIds: type: array items: type: string title: The list of public IPs which the Batch service will use when provisioning Compute Nodes. description: 'The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.' description: The public IP Address configuration of the networking configuration of a Pool. StorageQueueMessage: properties: storageAccount: type: string description: Gets or sets the storage account name. queueName: type: string description: Gets or sets the queue name. sasToken: type: string description: Gets or sets the SAS key. message: type: string description: Gets or sets the message. BatchCertificateStoreLocation: type: string description: BatchCertificateStoreLocation enums enum: - currentuser - localmachine x-ms-enum: name: BatchCertificateStoreLocation modelAsString: true values: - name: CurrentUser value: currentuser description: Certificates should be installed to the CurrentUser Certificate store. - name: LocalMachine value: localmachine description: Certificates should be installed to the LocalMachine Certificate store. BatchJobStatistics: type: object description: Resource usage statistics for a Job. properties: url: type: string description: The URL of the statistics. startTime: type: string format: date-time description: The start time of the time range covered by the statistics. lastUpdateTime: type: string format: date-time description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. userCPUTime: type: string format: duration description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. x-ms-client-name: userCpuTime kernelCPUTime: type: string format: duration description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. x-ms-client-name: kernelCpuTime wallClockTime: type: string format: duration description: The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. readIOps: type: integer format: int32 description: The total number of disk read operations made by all Tasks in the Job. writeIOps: type: integer format: int32 description: The total number of disk write operations made by all Tasks in the Job. readIOGiB: type: number format: float description: The total amount of data in GiB read from disk by all Tasks in the Job. writeIOGiB: type: number format: float description: The total amount of data in GiB written to disk by all Tasks in the Job. numSucceededTasks: type: integer format: int32 description: The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. numFailedTasks: type: integer format: int32 description: The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. numTaskRetries: type: integer format: int32 description: The total number of retries on all the Tasks in the Job during the given time range. waitTime: type: string format: duration description: The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. required: - url - startTime - lastUpdateTime - userCPUTime - kernelCPUTime - wallClockTime - readIOps - writeIOps - readIOGiB - writeIOGiB - numSucceededTasks - numFailedTasks - numTaskRetries - waitTime RollingUpgradePolicy: type: object description: The configuration parameters used while performing a rolling upgrade. properties: enableCrossZoneUpgrade: type: boolean description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. maxBatchInstancePercent: type: integer format: int32 description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. maxUnhealthyInstancePercent: type: integer format: int32 description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. maxUnhealthyUpgradedInstancePercent: type: integer format: int32 description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. pauseTimeBetweenBatches: type: string format: duration description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. prioritizeUnhealthyInstances: type: boolean description: Upgrade all unhealthy instances in a scale set before any healthy instances. rollbackFailedInstancesOnPolicyBreach: type: boolean description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. BatchStartTask: type: object description: 'Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask.' properties: commandLine: type: string description: The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/BatchTaskContainerSettings' description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the StartTask. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. maxTaskRetryCount: type: integer format: int32 description: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries). waitForSuccess: type: boolean description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. required: - commandLine UserIdentity: type: object description: The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both. properties: username: type: string description: The name of the user identity under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. autoUser: $ref: '#/definitions/AutoUserSpecification' description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. LinuxUserConfiguration: type: object description: Properties used to create a user Account on a Linux Compute Node. properties: uid: type: integer format: int32 description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. gid: type: integer format: int32 description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. sshPrivateKey: type: string description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). DiffDiskSettings: type: object description: 'Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).' properties: placement: $ref: '#/definitions/DiffDiskPlacement' description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. BatchStartTaskUpdate: type: object description: 'Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask.' properties: commandLine: type: string description: The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/BatchTaskContainerSettingsUpdate' description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the StartTask. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. maxTaskRetryCount: type: integer format: int32 description: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries). waitForSuccess: type: boolean description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. WindowsConfiguration_2: properties: enableAutomaticUpdates: type: boolean title: Whether automatic updates are enabled on the virtual machine. description: If omitted, the default value is true. title: Windows operating system settings to apply to the virtual machine. DiskEncryptionConfiguration_2: properties: targets: type: array items: type: string x-nullable: false title: A disk to encrypt. enum: - osdisk - temporarydisk x-ms-enum: name: DiskEncryptionTarget modelAsString: false values: - value: osdisk description: The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time. name: OsDisk - value: temporarydisk description: The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time. name: TemporaryDisk title: The list of disk targets Batch Service will encrypt on the compute node. description: If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. description: The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Shared Image Gallery Image. JobPreparationTask: properties: id: type: string title: A string that uniquely identifies the Job Preparation Task within the Job. description: The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). commandLine: type: string title: The command line of the Job Preparation Task. description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/TaskContainerSettings' title: The settings for the container under which the Job Preparation Task runs. description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array items: $ref: '#/definitions/ResourceFile_2' title: A list of files that the Batch service will download to the Compute Node before running the command line. description: Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. environmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting_2' title: A list of environment variable settings for the Job Preparation Task. constraints: $ref: '#/definitions/TaskConstraints' title: Constraints that apply to the Job Preparation Task. waitForSuccess: type: boolean title: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. description: If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. userIdentity: $ref: '#/definitions/UserIdentity_2' title: The user identity under which the Job Preparation Task runs. description: If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. rerunOnNodeRebootAfterSuccess: type: boolean title: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. description: The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. required: - commandLine title: A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. description: 'You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.' ServiceBusQueueMessage: properties: queueName: type: string description: Gets or sets the queue name. allOf: - $ref: '#/definitions/ServiceBusMessage' BatchTaskContainerExecutionInfo: type: object description: Contains information about the container which a Task is executing. properties: containerId: type: string description: The ID of the container. state: type: string description: The state of the container. This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect". error: type: string description: Detailed error information about the container. This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect". DataDisk: type: object description: 'Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.' properties: lun: type: integer format: int32 description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. x-ms-client-name: logicalUnitNumber caching: $ref: '#/definitions/CachingType' description: 'The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.' diskSizeGB: type: integer format: int32 description: The initial disk size in gigabytes. x-ms-client-name: diskSizeGb storageAccountType: $ref: '#/definitions/StorageAccountType' description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". required: - lun - diskSizeGB AzureBlobFileSystemConfiguration: type: object description: Information used to connect to an Azure Storage Container using Blobfuse. properties: accountName: type: string description: The Azure Storage Account name. containerName: type: string description: The Azure Blob Storage Container name. accountKey: type: string description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. sasKey: type: string description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. blobfuseOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. identityReference: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. required: - accountName - containerName - relativeMountPath AccessScope: type: string description: AccessScope enums enum: - job x-ms-enum: name: AccessScope modelAsString: true values: - name: Job value: job description: Grants access to perform all operations on the Job containing the Task. ContactInfo: description: Contact Info. required: - contactName - phone type: object properties: contactName: description: Contact name of the person. minLength: 1 type: string phone: description: Phone number of the contact person. minLength: 1 type: string phoneExtension: description: Phone extension number of the contact person. type: string mobile: description: Mobile number of the contact person. type: string WindowsConfiguration: type: object description: Windows operating system settings to apply to the virtual machine. properties: enableAutomaticUpdates: type: boolean description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ErrorCategory_2: type: string title: The category of the error. enum: - usererror - servererror x-ms-enum: name: ErrorCategory modelAsString: false values: - value: usererror description: The error is due to a user issue, such as misconfiguration. name: userError - value: servererror description: The error is due to an internal server issue. name: serverError IdentityProperties: description: Managed identity properties. type: object properties: type: description: Managed service identity type. type: string userAssigned: $ref: '#/definitions/UserAssignedProperties' description: User assigned identity properties. HttpRequest: properties: authentication: $ref: '#/definitions/HttpAuthentication' description: Gets or sets the authentication method of the request. uri: type: string description: Gets or sets the URI of the request. method: type: string description: Gets or sets the method of the request. body: type: string description: Gets or sets the request body. headers: type: object additionalProperties: type: string description: Gets or sets the headers. JobStages_2: description: Job stages. required: - stageStatus type: object properties: stageName: description: Name of the job stage. type: string stageStatus: description: Status of the job stage. enum: - None - InProgress - Succeeded - WaitingForAction - Failed - Cancelled - Cancelling type: string x-ms-enum: name: JobStatus modelAsString: false jobStageDetails: description: Job Stage Details type: object errorDetails: description: Error details for the stage. This is optional type: array items: $ref: '#/definitions/ErrorDetails_2' LoginMode: type: string description: LoginMode enums enum: - batch - interactive x-ms-enum: name: LoginMode modelAsString: true values: - name: Batch value: batch description: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. - name: Interactive value: interactive description: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ManagedDiskUpdate: type: object description: The managed disk parameters. properties: storageAccountType: $ref: '#/definitions/StorageAccountType' description: The storage account type for managed disk. Schedule: description: Schedule for the job run. type: object properties: name: description: Name of the schedule. type: string policyList: description: A list of repetition intervals in ISO 8601 format. type: array items: type: string AzureFileShareConfiguration: type: object description: Information used to connect to an Azure Fileshare. properties: accountName: type: string description: The Azure Storage account name. azureFileUrl: type: string description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. accountKey: type: string description: The Azure Storage account key. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. required: - accountName - azureFileUrl - accountKey - relativeMountPath UpdateJobProperties: description: Job Properties for update type: object properties: details: $ref: '#/definitions/UpdateJobDetails' description: Details of a job to be updated. NetworkConfigurationUpdate: type: object description: The network configuration for a Pool. properties: subnetId: type: string description: 'The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn''t have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The ''MicrosoftAzureBatch'' service principal must have the ''Classic Virtual Machine Contributor'' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks (''Microsoft.Network/virtualNetworks'') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For Pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.' dynamicVNetAssignmentScope: $ref: '#/definitions/DynamicVNetAssignmentScope' description: The scope of dynamic vnet assignment. endpointConfiguration: $ref: '#/definitions/BatchPoolEndpointConfigurationUpdate' description: The configuration for endpoints on Compute Nodes in the Batch Pool. Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property. publicIPAddressConfiguration: $ref: '#/definitions/PublicIpAddressConfiguration' description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property. x-ms-client-name: publicIpAddressConfiguration enableAcceleratedNetworking: type: boolean description: 'Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.' DataImportDetails: description: Details of the data to be used for importing data to azure. required: - accountDetails type: object properties: accountDetails: $ref: '#/definitions/DataAccountDetails' description: Account details of the data to be transferred logCollectionLevel: description: Level of the logs to be collected. enum: - Error - Verbose type: string x-ms-enum: name: LogCollectionLevel modelAsExtensible: true values: - value: Error description: Only Errors will be collected in the logs. - value: Verbose description: Verbose logging (includes Errors, CRC, size information and others). default: Error UnencryptedCredentialsList: description: List of unencrypted credentials for accessing device. type: object properties: value: description: List of unencrypted credentials. type: array items: $ref: '#/definitions/UnencryptedCredentials' nextLink: description: Link for the next set of unencrypted credentials. type: string ContainerConfiguration: type: object description: The configuration for container-enabled Pools. properties: type: $ref: '#/definitions/ContainerType' description: The container technology to be used. containerImageNames: type: array description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. items: type: string containerRegistries: type: array description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. items: $ref: '#/definitions/ContainerRegistry' x-ms-identifiers: [] required: - type ServiceBusTopicMessage: properties: topicPath: type: string description: Gets or sets the topic path. allOf: - $ref: '#/definitions/ServiceBusMessage' JobManagerTask: properties: id: type: string title: A string that uniquely identifies the Job Manager Task within the Job. description: The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. displayName: type: string title: The display name of the Job Manager Task. description: It need not be unique and can contain any Unicode characters up to a maximum length of 1024. commandLine: type: string title: The command line of the Job Manager Task. description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/TaskContainerSettings' title: The settings for the container under which the Job Manager Task runs. description: If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array items: $ref: '#/definitions/ResourceFile_2' title: A list of files that the Batch service will download to the Compute Node before running the command line. description: Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. outputFiles: type: array items: $ref: '#/definitions/OutputFile_2' title: A list of files that the Batch service will upload from the Compute Node after running the command line. description: For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. environmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting_2' title: A list of environment variable settings for the Job Manager Task. constraints: $ref: '#/definitions/TaskConstraints' title: Constraints that apply to the Job Manager Task. requiredSlots: type: integer format: int32 title: The number of scheduling slots that the Task requires to run. description: The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. killJobOnCompletion: type: boolean title: Whether completion of the Job Manager Task signifies completion of the entire Job. description: If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. userIdentity: $ref: '#/definitions/UserIdentity_2' title: The user identity under which the Job Manager Task runs. description: If omitted, the Task runs as a non-administrative user unique to the Task. runExclusive: type: boolean title: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. description: If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. applicationPackageReferences: type: array items: $ref: '#/definitions/ApplicationPackageReference' title: A list of Application Packages that the Batch service will deploy to the Compute Node before running the command line. description: Application Packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced Application Package is already on the Compute Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Application Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails. authenticationTokenSettings: title: The settings for an authentication token that the Task can use to perform Batch service operations. description: If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. $ref: '#/definitions/AuthenticationTokenSettings_2' allowLowPriorityNode: type: boolean title: Whether the Job Manager Task may run on a low-priority Compute Node. description: The default value is true. required: - id - commandLine title: Specifies details of a Job Manager Task. description: The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. MountConfiguration: type: object description: The file system to mount on each node. properties: azureBlobFileSystemConfiguration: $ref: '#/definitions/AzureBlobFileSystemConfiguration' description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. nfsMountConfiguration: $ref: '#/definitions/NfsMountConfiguration' description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. cifsMountConfiguration: $ref: '#/definitions/CifsMountConfiguration' description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. azureFileShareConfiguration: $ref: '#/definitions/AzureFileShareConfiguration' description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. JobHistoryListResult: properties: value: type: array items: $ref: '#/definitions/JobHistoryDefinition' description: Gets or sets the job histories under job. nextLink: type: string description: Gets or sets the URL to get the next set of job histories. ContainerWorkingDirectory: type: string description: ContainerWorkingDirectory enums enum: - taskWorkingDirectory - containerImageDefault x-ms-enum: name: ContainerWorkingDirectory modelAsString: true values: - name: TaskWorkingDirectory value: taskWorkingDirectory description: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. - name: ContainerImageDefault value: containerImageDefault description: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ExitConditions: type: object description: Specifies how the Batch service should respond when the Task completes. properties: exitCodes: type: array description: A list of individual Task exit codes and how the Batch service should respond to them. items: $ref: '#/definitions/ExitCodeMapping' x-ms-identifiers: [] exitCodeRanges: type: array description: A list of Task exit code ranges and how the Batch service should respond to them. items: $ref: '#/definitions/ExitCodeRangeMapping' x-ms-identifiers: [] preProcessingError: $ref: '#/definitions/ExitOptions' description: How the Batch service should respond if the Task fails to start due to an error. fileUploadError: $ref: '#/definitions/ExitOptions' description: How the Batch service should respond if a file upload error occurs. If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence. default: $ref: '#/definitions/ExitOptions' description: How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties. This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection. PackageCarrierDetails: description: Package carrier details. type: object properties: carrierAccountNumber: description: Carrier Account Number of customer for customer disk. type: string x-ms-secret: true carrierName: description: Name of the carrier. type: string trackingId: description: Tracking Id of shipment. type: string CertificateReference: properties: thumbprint: type: string title: The thumbprint of the Certificate. thumbprintAlgorithm: type: string title: The algorithm with which the thumbprint is associated. This must be sha1. storeLocation: type: string title: The location of the Certificate store on the Compute Node into which to install the Certificate. description: The default value is currentuser. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). 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. enum: - currentuser - localmachine x-ms-enum: name: CertificateStoreLocation modelAsString: false values: - value: currentuser description: Certificates should be installed to the CurrentUser Certificate store. name: currentUser - value: localmachine description: Certificates should be installed to the LocalMachine Certificate store. name: localMachine storeName: type: string title: The name of the Certificate store on the Compute Node into which to install the Certificate. description: 'This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.' visibility: type: array items: type: string x-nullable: false enum: - starttask - task - remoteuser x-ms-enum: name: CertificateVisibility modelAsString: false values: - value: starttask description: The Certificate should be visible to the user account under which the StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well. name: startTask - value: task description: The Certificate should be visible to the user accounts under which Job Tasks are run. - value: remoteuser description: The Certificate should be visible to the user accounts under which users remotely access the Compute Node. name: remoteUser title: Which user Accounts on the Compute Node should have access to the private data of the Certificate. description: You can specify more than one visibility in this collection. The default is all Accounts. required: - thumbprint - thumbprintAlgorithm title: A reference to a Certificate to be installed on Compute Nodes in a Pool. WindowsUserConfiguration: type: object description: Properties used to create a user Account on a Windows Compute Node. properties: loginMode: $ref: '#/definitions/LoginMode' description: The login mode for the user. The default value for VirtualMachineConfiguration Pools is 'batch' and for CloudServiceConfiguration Pools is 'interactive'. PoolInformation: properties: poolId: type: string title: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. description: You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. autoPoolSpecification: $ref: '#/definitions/AutoPoolSpecification' title: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. description: If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. title: Specifies how a Job should be assigned to a Pool. AutoPoolSpecification: properties: autoPoolIdPrefix: type: string title: A prefix to be added to the unique identifier when a Pool is automatically created. description: The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. poolLifetimeOption: type: string title: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. enum: - jobschedule - job x-ms-enum: name: PoolLifetimeOption modelAsString: false values: - value: jobschedule description: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. name: jobSchedule - value: job description: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. keepAlive: type: boolean title: Whether to keep an auto Pool alive after its lifetime expires. description: If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. pool: $ref: '#/definitions/PoolSpecification' title: The Pool specification for the auto Pool. required: - poolLifetimeOption title: Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. JobStage: description: The details about the specific stage of a job. required: - stageStatus type: object properties: message: description: The message of the job stage. type: string stageStatus: description: The stage status. enum: - Running - Succeeded - Failed - Canceled type: string x-ms-enum: name: JobStatus modelAsString: false detail: description: The details of the stage. type: string errorCode: description: The error code of the stage if any. type: string BatchJobReleaseTaskState: type: string description: BatchJobReleaseTaskState enums enum: - running - completed x-ms-enum: name: BatchJobReleaseTaskState modelAsString: true values: - name: Running value: running description: The Task is currently running (including retrying). - name: Completed value: completed description: The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures). BatchNodeIdentityReference: type: object description: 'The reference to a user assigned identity associated with the Batch pool which a compute node will use.' properties: resourceId: type: string description: The ARM resource id of the user assigned identity. ErrorCategory: type: string description: ErrorCategory enums enum: - usererror - servererror x-ms-enum: name: ErrorCategory modelAsString: true values: - name: UserError value: usererror description: The error is due to a user issue, such as misconfiguration. - name: ServerError value: servererror description: The error is due to an internal server issue. BatchTaskStatistics: type: object description: Resource usage statistics for a Task. properties: url: type: string description: The URL of the statistics. startTime: type: string format: date-time description: The start time of the time range covered by the statistics. lastUpdateTime: type: string format: date-time description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. userCPUTime: type: string format: duration description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. x-ms-client-name: userCpuTime kernelCPUTime: type: string format: duration description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. x-ms-client-name: kernelCpuTime wallClockTime: type: string format: duration description: The total wall clock time of the Task. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If the Task was retried, this includes the wall clock time of all the Task retries. readIOps: type: integer format: int32 description: The total number of disk read operations made by the Task. writeIOps: type: integer format: int32 description: The total number of disk write operations made by the Task. readIOGiB: type: number format: float description: The total gibibytes read from disk by the Task. writeIOGiB: type: number format: float description: The total gibibytes written to disk by the Task. waitTime: type: string format: duration description: The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.). required: - url - startTime - lastUpdateTime - userCPUTime - kernelCPUTime - wallClockTime - readIOps - writeIOps - readIOGiB - writeIOGiB - waitTime CloudError: description: An error response from the service. type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: The error details. x-ms-external: true JobErrorDetails: description: The job error information containing the list of job errors. type: object properties: errorDetails: description: The error details. uniqueItems: false type: array items: $ref: '#/definitions/JobErrorItem' x-ms-identifiers: [] readOnly: true code: description: The code intended for programmatic access. type: string readOnly: true message: description: The message that describes the error in detail. type: string readOnly: true BatchErrorDetail: type: object description: An item of additional information included in an Azure Batch error response. properties: key: type: string description: An identifier specifying the meaning of the Value property. value: type: string description: The additional information included with the error response. Error_2: description: Top level error for the job. required: - code type: object properties: code: description: Error code that can be used to programmatically identify the error. type: string message: description: Describes the error in detail and provides debugging information. type: string VirtualMachineConfigurationUpdate: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.' properties: imageReference: $ref: '#/definitions/ImageReference' description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. nodeAgentSKUId: type: string description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. x-ms-client-name: nodeAgentSkuId windowsConfiguration: $ref: '#/definitions/WindowsConfiguration' description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. dataDisks: type: array description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. items: $ref: '#/definitions/DataDisk' x-ms-identifiers: [] licenseType: type: string description: "This only applies to Images that contain the Windows operating system, and\nshould only be used when you hold valid on-premises licenses for the Compute\nNodes which will be deployed. If omitted, no on-premises licensing discount is\napplied. Values are:\n\n Windows_Server - The on-premises license is for Windows\nServer.\n Windows_Client - The on-premises license is for Windows Client.\n" containerConfiguration: $ref: '#/definitions/ContainerConfigurationUpdate' description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. diskEncryptionConfiguration: $ref: '#/definitions/DiskEncryptionConfiguration' description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. nodePlacementConfiguration: $ref: '#/definitions/BatchNodePlacementConfiguration' description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. extensions: type: array description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. items: $ref: '#/definitions/VMExtension' x-ms-identifiers: [] osDisk: $ref: '#/definitions/OSDiskUpdate' description: Settings for the operating system disk of the Virtual Machine. securityProfile: $ref: '#/definitions/SecurityProfileUpdate' description: Specifies the security profile settings for the virtual machine or virtual machine scale set. serviceArtifactReference: $ref: '#/definitions/ServiceArtifactReferenceUpdate' description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} BatchTaskContainerSettings: type: object description: The container settings for a Task. properties: containerRunOptions: type: string description: Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string description: The Image to use to create the container in which the Task will run. 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. registry: $ref: '#/definitions/ContainerRegistry' description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. workingDirectory: $ref: '#/definitions/ContainerWorkingDirectory' description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. required: - imageName DependencyAction: type: string description: DependencyAction enums enum: - satisfy - block x-ms-enum: name: DependencyAction modelAsString: true values: - name: Satisfy value: satisfy description: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. - name: Block value: block description: Blocks tasks waiting on this task, preventing them from being scheduled. UserAccount_2: properties: name: type: string title: The name of the user Account. password: type: string title: The password for the user Account. elevationLevel: title: The elevation level of the user Account. description: The default value is nonAdmin. $ref: '#/definitions/ElevationLevel_2' linuxUserConfiguration: title: The Linux-specific user configuration for the user Account. description: This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. $ref: '#/definitions/LinuxUserConfiguration_2' windowsUserConfiguration: title: The Windows-specific user configuration for the user Account. description: This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. $ref: '#/definitions/WindowsUserConfiguration_2' required: - name - password title: Properties used to create a user used to execute Tasks on an Azure Batch Compute Node. Details: required: - code - message type: object properties: code: type: string message: type: string AdditionalErrorInfo: description: This class represents additional info which Resource Providers pass when an error occurs. properties: info: description: Additional information of the type of error. type: object type: description: Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). type: string type: object BatchTaskDependencies: type: object description: 'Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled.' properties: taskIds: type: array description: The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent Task can be scheduled. The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using Task ID ranges instead. items: type: string taskIdRanges: type: array description: The list of Task ID ranges that this Task depends on. All Tasks in all ranges must complete successfully before the dependent Task can be scheduled. items: $ref: '#/definitions/BatchTaskIdRange' x-ms-identifiers: [] JobDelayDetails: description: Job Delay Notification details type: object properties: status: description: Status of notification enum: - Active - Resolved type: string readOnly: true x-ms-enum: name: DelayNotificationStatus modelAsString: true values: - value: Active description: Delay is still active - value: Resolved description: Delay has been resolved errorCode: description: Delay Error code enum: - InternalIssueDelay - ActiveOrderLimitBreachedDelay - HighDemandDelay - LargeNumberOfFilesDelay type: string readOnly: true x-ms-enum: name: PortalDelayErrorCode modelAsString: true values: - value: InternalIssueDelay description: Delay due to any internal reasons - value: ActiveOrderLimitBreachedDelay description: Active Order limit breached. - value: ActiveOrderLimitBreachedDelay description: High demand - value: ActiveOrderLimitBreachedDelay description: Slow copy due to large number of files description: description: Description of the delay. type: string readOnly: true startTime: format: date-time description: Timestamp when the delay notification was created. type: string readOnly: true resolutionTime: format: date-time description: Timestamp when the delay notification was resolved. type: string readOnly: true BatchNodePlacementPolicyType: type: string description: BatchNodePlacementPolicyType enums enum: - regional - zonal x-ms-enum: name: BatchNodePlacementPolicyType modelAsString: true values: - name: Regional value: regional description: All nodes in the pool will be allocated in the same region. - name: Zonal value: zonal description: Nodes in the pool will be spread across different availability zones with best effort balancing. BatchJobReleaseTaskExecutionInfo: type: object description: 'Contains information about the execution of a Job Release Task on a Compute Node.' properties: startTime: type: string format: date-time description: The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running. endTime: type: string format: date-time description: The time at which the Job Release Task completed. This property is set only if the Task is in the Completed state. state: $ref: '#/definitions/BatchJobReleaseTaskState' description: The current state of the Job Release Task on the Compute Node. taskRootDirectory: type: string description: The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files. taskRootDirectoryUrl: type: string description: The URL to the root directory of the Job Release Task on the Compute Node. exitCode: type: integer format: int32 description: The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated. containerInfo: $ref: '#/definitions/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. result: $ref: '#/definitions/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - startTime - state SecurityTypes: type: string description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. enum: - trustedLaunch x-ms-enum: name: SecurityTypes modelAsString: true values: - name: trustedLaunch value: trustedLaunch description: Trusted launch protects against advanced and persistent attack techniques. NetworkConfiguration: type: object description: The network configuration for a Pool. properties: subnetId: type: string description: 'The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn''t have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The ''MicrosoftAzureBatch'' service principal must have the ''Classic Virtual Machine Contributor'' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks (''Microsoft.Network/virtualNetworks'') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For Pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.' dynamicVNetAssignmentScope: $ref: '#/definitions/DynamicVNetAssignmentScope' description: The scope of dynamic vnet assignment. endpointConfiguration: $ref: '#/definitions/BatchPoolEndpointConfiguration' description: The configuration for endpoints on Compute Nodes in the Batch Pool. Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property. publicIPAddressConfiguration: $ref: '#/definitions/PublicIpAddressConfiguration' description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property. x-ms-client-name: publicIpAddressConfiguration enableAcceleratedNetworking: type: boolean description: 'Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.' Error: description: The response error definition. type: object properties: error: description: Error details for current request. $ref: '#/definitions/ErrorDetails' required: - error JobProperties_2: description: Job Properties required: - transferType type: object properties: transferType: description: Type of the data transfer. enum: - ImportToAzure - ExportFromAzure type: string x-ms-enum: name: TransferType modelAsExtensible: true values: - value: ImportToAzure description: Import data to azure. - value: ExportFromAzure description: Export data from azure. isCancellable: description: Describes whether the job is cancellable or not. type: boolean readOnly: true isDeletable: description: Describes whether the job is deletable or not. type: boolean readOnly: true isShippingAddressEditable: description: Describes whether the shipping address is editable or not. type: boolean readOnly: true reverseShippingDetailsUpdate: description: The Editable status for Reverse Shipping Address and Contact Info enum: - Enabled - Disabled - NotSupported type: string readOnly: true x-ms-enum: name: ReverseShippingDetailsEditStatus modelAsExtensible: true values: - value: Enabled description: Reverse shipping details can be edited. - value: Disabled description: Edit is disabled for Reverse shipping details. - value: NotSupported description: Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature. reverseTransportPreferenceUpdate: description: The Editable status for Reverse Transport preferences enum: - Enabled - Disabled - NotSupported type: string readOnly: true x-ms-enum: name: ReverseTransportPreferenceEditStatus modelAsExtensible: true values: - value: Enabled description: Reverse Transport Preferences can be edited. - value: Disabled description: Edit is disabled for Reverse Transport Preferences. - value: NotSupported description: Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature. isPrepareToShipEnabled: description: Is Prepare To Ship Enabled on this job type: boolean readOnly: true status: description: Name of the stage which is in progress. enum: - DeviceOrdered - DevicePrepared - Dispatched - Delivered - PickedUp - AtAzureDC - DataCopy - Completed - CompletedWithErrors - Cancelled - Failed_IssueReportedAtCustomer - Failed_IssueDetectedAtAzureDC - Aborted - CompletedWithWarnings - ReadyToDispatchFromAzureDC - ReadyToReceiveAtAzureDC - Created - ShippedToAzureDC - AwaitingShipmentDetails - PreparingToShipFromAzureDC - ShippedToCustomer type: string readOnly: true x-ms-enum: name: StageName modelAsString: true values: - value: DeviceOrdered description: An order has been created. - value: DevicePrepared description: A device has been prepared for the order. - value: Dispatched description: Device has been dispatched to the user of the order. - value: Delivered description: Device has been delivered to the user of the order. - value: PickedUp description: Device has been picked up from user and in transit to Azure datacenter. - value: AtAzureDC description: Device has been received at Azure datacenter from the user. - value: DataCopy description: Data copy from the device at Azure datacenter. - value: Completed description: Order has completed. - value: CompletedWithErrors description: Order has completed with errors. - value: Cancelled description: Order has been cancelled. - value: Failed_IssueReportedAtCustomer description: Order has failed due to issue reported by user. - value: Failed_IssueDetectedAtAzureDC description: Order has failed due to issue detected at Azure datacenter. - value: Aborted description: Order has been aborted. - value: CompletedWithWarnings description: Order has completed with warnings. - value: ReadyToDispatchFromAzureDC description: Device is ready to be handed to customer from Azure DC. - value: ReadyToReceiveAtAzureDC description: Device can be dropped off at Azure DC. - value: Created description: Job created by the customer. - value: ShippedToAzureDC description: User shipped the device to AzureDC. - value: AwaitingShipmentDetails description: Awaiting shipment details of device from customer. - value: PreparingToShipFromAzureDC description: Preparing the device to ship to customer. - value: ShippedToCustomer description: Shipped the device to customer. delayedStage: description: Name of the stage where delay might be present. enum: - DeviceOrdered - DevicePrepared - Dispatched - Delivered - PickedUp - AtAzureDC - DataCopy - Completed - CompletedWithErrors - Cancelled - Failed_IssueReportedAtCustomer - Failed_IssueDetectedAtAzureDC - Aborted - CompletedWithWarnings - ReadyToDispatchFromAzureDC - ReadyToReceiveAtAzureDC - Created - ShippedToAzureDC - AwaitingShipmentDetails - PreparingToShipFromAzureDC - ShippedToCustomer type: string readOnly: true x-ms-enum: name: StageName modelAsString: true values: - value: DeviceOrdered description: An order has been created. - value: DevicePrepared description: A device has been prepared for the order. - value: Dispatched description: Device has been dispatched to the user of the order. - value: Delivered description: Device has been delivered to the user of the order. - value: PickedUp description: Device has been picked up from user and in transit to Azure datacenter. - value: AtAzureDC description: Device has been received at Azure datacenter from the user. - value: DataCopy description: Data copy from the device at Azure datacenter. - value: Completed description: Order has completed. - value: CompletedWithErrors description: Order has completed with errors. - value: Cancelled description: Order has been cancelled. - value: Failed_IssueReportedAtCustomer description: Order has failed due to issue reported by user. - value: Failed_IssueDetectedAtAzureDC description: Order has failed due to issue detected at Azure datacenter. - value: Aborted description: Order has been aborted. - value: CompletedWithWarnings description: Order has completed with warnings. - value: ReadyToDispatchFromAzureDC description: Device is ready to be handed to customer from Azure DC. - value: ReadyToReceiveAtAzureDC description: Device can be dropped off at Azure DC. - value: Created description: Job created by the customer. - value: ShippedToAzureDC description: User shipped the device to AzureDC. - value: AwaitingShipmentDetails description: Awaiting shipment details of device from customer. - value: PreparingToShipFromAzureDC description: Preparing the device to ship to customer. - value: ShippedToCustomer description: Shipped the device to customer. startTime: format: date-time description: Time at which the job was started in UTC ISO 8601 format. type: string readOnly: true error: $ref: '#/definitions/CloudError_2' description: Top level error for the job. readOnly: true details: $ref: '#/definitions/JobDetails' description: Details of a job run. This field will only be sent for expand details filter. cancellationReason: description: Reason for cancellation. type: string readOnly: true deliveryType: description: Delivery type of Job. enum: - NonScheduled - Scheduled type: string x-ms-enum: name: JobDeliveryType modelAsExtensible: true values: - value: NonScheduled description: Non Scheduled job. - value: Scheduled description: Scheduled job. default: NonScheduled deliveryInfo: $ref: '#/definitions/JobDeliveryInfo' description: Delivery Info of Job. isCancellableWithoutFee: description: Flag to indicate cancellation of scheduled job. type: boolean readOnly: true allDevicesLost: description: Flag to indicate if all devices associated with the job are lost. type: boolean readOnly: true BatchAutoPoolSpecification: type: object description: 'Specifies characteristics for a temporary ''auto pool''. The Batch service will create this auto Pool when the Job is submitted.' properties: autoPoolIdPrefix: type: string description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. poolLifetimeOption: $ref: '#/definitions/BatchPoolLifetimeOption' description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. keepAlive: type: boolean description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. pool: $ref: '#/definitions/BatchPoolSpecification' description: The Pool specification for the auto Pool. required: - poolLifetimeOption JobDefinition: description: Job Definition. required: - properties type: object allOf: - $ref: '#/definitions/DmsBaseObject' properties: properties: $ref: '#/definitions/JobDefinitionProperties' description: JobDefinition properties. x-ms-client-flatten: true ShipmentPickUpResponse: description: Shipment pick up response. type: object properties: confirmationNumber: description: Confirmation number for the pick up request. type: string readOnly: true readyByTime: format: date-time description: Time by which shipment should be ready for pick up, this is in local time of pick up area. type: string readOnly: true UpgradePolicy: type: object description: Describes an upgrade policy - automatic, manual, or rolling. properties: mode: $ref: '#/definitions/UpgradeMode' description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. automaticOsUpgradePolicy: $ref: '#/definitions/AutomaticOsUpgradePolicy' description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. x-ms-client-name: automaticOSUpgradePolicy rollingUpgradePolicy: $ref: '#/definitions/RollingUpgradePolicy' description: The configuration parameters used while performing a rolling upgrade. This property is only supported on Pools with the virtualMachineConfiguration property. required: - mode TaskContainerSettings: properties: containerRunOptions: type: string title: Additional options to the container create command. description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string title: The Image to use to create the container in which the Task will run. description: 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. registry: $ref: '#/definitions/ContainerRegistry_2' title: The private registry which contains the container Image. description: This setting can be omitted if was already provided at Pool creation. workingDirectory: type: string title: The location of the container Task working directory. description: The default is 'taskWorkingDirectory'. enum: - taskWorkingDirectory - containerImageDefault x-ms-enum: name: ContainerWorkingDirectory modelAsString: false values: - value: taskWorkingDirectory description: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. - value: containerImageDefault description: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. required: - imageName title: The container settings for a Task. BatchJobPreparationTask: type: object description: 'A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.' properties: id: type: string description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). commandLine: type: string description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/BatchTaskContainerSettings' description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the Job Preparation Task. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] constraints: $ref: '#/definitions/BatchTaskConstraints' description: Constraints that apply to the Job Preparation Task. waitForSuccess: type: boolean description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. rerunOnNodeRebootAfterSuccess: type: boolean description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. required: - commandLine MultiInstanceSettings: type: object description: 'Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit.' properties: numberOfInstances: type: integer format: int32 description: The number of Compute Nodes required by the Task. If omitted, the default is 1. coordinationCommandLine: type: string description: The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command. A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages. commonResourceFiles: type: array description: A list of files that the Batch service will download before running the coordination command line. The difference between common resource files and Task resource files is that common resource files are downloaded for all subtasks including the primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] required: - coordinationCommandLine MountConfiguration_2: properties: azureBlobFileSystemConfiguration: $ref: '#/definitions/AzureBlobFileSystemConfiguration_2' title: The Azure Storage Container to mount using blob FUSE on each node. description: This property is mutually exclusive with all other properties. nfsMountConfiguration: $ref: '#/definitions/NFSMountConfiguration' title: The NFS file system to mount on each node. description: This property is mutually exclusive with all other properties. cifsMountConfiguration: $ref: '#/definitions/CIFSMountConfiguration' title: The CIFS/SMB file system to mount on each node. description: This property is mutually exclusive with all other properties. azureFileShareConfiguration: $ref: '#/definitions/AzureFileShareConfiguration_2' title: The Azure File Share to mount on each node. description: This property is mutually exclusive with all other properties. title: The file system to mount on each node. BatchTaskAddCollectionResult: type: object description: The result of adding a collection of Tasks to a Job. properties: value: type: array description: The results of the add Task collection operation. items: $ref: '#/definitions/BatchTaskAddResult' x-ms-identifiers: [] BatchNodeFillType: type: string description: BatchNodeFillType enums enum: - spread - pack x-ms-enum: name: BatchNodeFillType modelAsString: true values: - name: Spread value: spread description: Tasks should be assigned evenly across all Compute Nodes in the Pool. - name: Pack value: pack description: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. JobRecurrenceScheduleMonthlyOccurrence: properties: day: type: string description: Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday x-ms-enum: name: JobScheduleDay modelAsString: false Occurrence: type: integer description: Gets or sets the occurrence. Must be between -5 and 5. StartTask: properties: commandLine: type: string title: The command line of the StartTask. description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/TaskContainerSettings' title: The settings for the container under which the StartTask runs. description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array items: $ref: '#/definitions/ResourceFile_2' title: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. description: Files listed under this element are located in the Task's working directory. environmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting_2' title: A list of environment variable settings for the StartTask. userIdentity: $ref: '#/definitions/UserIdentity_2' title: The user identity under which the StartTask runs. description: If omitted, the Task runs as a non-administrative user unique to the Task. maxTaskRetryCount: type: integer format: int32 title: The maximum number of times the Task may be retried. description: The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit. waitForSuccess: type: boolean title: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. description: If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. required: - commandLine title: A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged. description: Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask. BatchJob: type: object description: An Azure Batch Job. properties: id: type: string description: A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). readOnly: true displayName: type: string description: The display name for the Job. readOnly: true usesTaskDependencies: type: boolean description: Whether Tasks in the Job can define dependencies on each other. The default is false. readOnly: true url: type: string description: The URL of the Job. readOnly: true eTag: type: string description: The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime. readOnly: true lastModified: type: string format: date-time description: The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. readOnly: true creationTime: type: string format: date-time description: The creation time of the Job. readOnly: true state: $ref: '#/definitions/BatchJobState' description: The current state of the Job. readOnly: true stateTransitionTime: type: string format: date-time description: The time at which the Job entered its current state. readOnly: true previousState: $ref: '#/definitions/BatchJobState' description: The previous state of the Job. This property is not set if the Job is in its initial Active state. readOnly: true previousStateTransitionTime: type: string format: date-time description: The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state. readOnly: true priority: type: integer format: int32 description: The priority of the Job. 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. allowTaskPreemption: type: boolean description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. maxParallelTasks: type: integer format: int32 description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. default: -1 constraints: $ref: '#/definitions/BatchJobConstraints' description: The execution constraints for the Job. jobManagerTask: $ref: '#/definitions/BatchJobManagerTask' description: Details of a Job Manager Task to be launched when the Job is started. readOnly: true jobPreparationTask: $ref: '#/definitions/BatchJobPreparationTask' description: The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. readOnly: true jobReleaseTask: $ref: '#/definitions/BatchJobReleaseTask' description: The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. readOnly: true commonEnvironmentSettings: type: array description: The list of common environment variable settings. These environment variables are set for all Tasks in the Job (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. items: $ref: '#/definitions/EnvironmentSetting' readOnly: true x-ms-identifiers: [] poolInfo: $ref: '#/definitions/BatchPoolInfo' description: The Pool settings associated with the Job. onAllTasksComplete: $ref: '#/definitions/OnAllBatchTasksComplete' description: The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. onTaskFailure: $ref: '#/definitions/OnBatchTaskFailure' description: The action the Batch service should take when any Task in the Job fails. A Task is considered to 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. readOnly: true networkConfiguration: $ref: '#/definitions/BatchJobNetworkConfiguration' description: The network configuration for the Job. readOnly: true metadata: type: array description: A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] executionInfo: $ref: '#/definitions/BatchJobExecutionInfo' description: The execution information for the Job. readOnly: true stats: $ref: '#/definitions/BatchJobStatistics' description: Resource usage statistics for the entire lifetime of the Job. This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. readOnly: true required: - poolInfo DeviceErasureDetails: description: Device erasure details with erasure completion status and erasureordestructionlog sas key type: object properties: deviceErasureStatus: description: Holds the device erasure completion status enum: - None - InProgress - Succeeded - Failed - Cancelled - Cancelling - SucceededWithErrors - WaitingForCustomerAction - SucceededWithWarnings - WaitingForCustomerActionForKek - WaitingForCustomerActionForCleanUp - CustomerActionPerformedForCleanUp - CustomerActionPerformed type: string readOnly: true x-ms-enum: name: StageStatus modelAsExtensible: true values: - value: None description: No status available yet. - value: InProgress description: Stage is in progress. - value: Succeeded description: Stage has succeeded. - value: Failed description: Stage has failed. - value: Cancelled description: Stage has been cancelled. - value: Cancelling description: Stage is cancelling. - value: SucceededWithErrors description: Stage has succeeded with errors. - value: WaitingForCustomerAction description: Stage is stuck until customer takes some action. - value: SucceededWithWarnings description: Stage has succeeded with warnings. - value: WaitingForCustomerActionForKek description: Stage is waiting for customer action for kek action items. - value: WaitingForCustomerActionForCleanUp description: Stage is waiting for customer action for clean up. - value: CustomerActionPerformedForCleanUp description: Stage has performed customer action for clean up. - value: CustomerActionPerformed description: Stage has performed customer action for clean up. erasureOrDestructionCertificateSasKey: description: Shared access key to download cleanup or destruction certificate for device type: string readOnly: true ServiceBusAuthentication: properties: sasKey: type: string description: Gets or sets the SAS key. sasKeyName: type: string description: Gets or sets the SAS key name. type: type: string description: Gets or sets the authentication type. enum: - NotSpecified - SharedAccessKey x-ms-enum: name: ServiceBusAuthenticationType modelAsString: false JobConstraints: properties: maxWallClockTime: type: string format: duration title: The maximum elapsed time that the Job may run, measured from the time the Job is created. description: If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. maxTaskRetryCount: type: integer format: int32 title: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. description: Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). title: The execution constraints for a Job. CloudError_3: x-ms-external: true properties: error: type: object $ref: '#/definitions/CloudErrorBody_2' description: The error object. description: An error response from the Container Instance service. CloudErrorBody_2: x-ms-external: true properties: code: readOnly: true type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: readOnly: true type: string description: A message describing the error, intended to be suitable for display in a user interface. target: readOnly: true type: string description: The target of the particular error. For example, the name of the property in error. details: readOnly: true type: array items: $ref: '#/definitions/CloudErrorBody_2' x-ms-identifiers: - code description: A list of additional details about the error. additionalInfo: readOnly: true type: array items: $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo x-ms-identifiers: [] description: The error additional info. description: An error response from the Container Instance service. Preferences: description: Preferences related to the order type: object properties: preferredDataCenterRegion: description: Preferred data center region. type: array items: type: string transportPreferences: $ref: '#/definitions/TransportPreferences' description: Preferences related to the shipment logistics of the sku. reverseTransportPreferences: $ref: '#/definitions/TransportPreferences' description: Optional Preferences related to the reverse shipment logistics of the sku. encryptionPreferences: $ref: '#/definitions/EncryptionPreferences' description: Preferences related to the Encryption. storageAccountAccessTierPreferences: description: Preferences related to the Access Tier of storage accounts. uniqueItems: false type: array items: enum: - Archive type: string x-ms-enum: name: StorageAccountAccessTier modelAsExtensible: true values: - value: Archive description: Archive Access Tier shares requested by the customer. CloudJobListResult: properties: value: type: array items: $ref: '#/definitions/CloudJob' title: The list of Jobs. odata.nextLink: type: string title: The URL to get the next set of results. title: The result of listing the Jobs in an Account. JobList_2: description: The collection of jobs. required: - value type: object properties: value: description: The value. type: array items: $ref: '#/definitions/Job_4' nextLink: description: The NextLink. type: string DataStatistics: description: The additional details related to the data related statistics of a job. Currently applicable only for Backup, Clone and Restore jobs. type: object properties: totalData: format: int64 description: The total bytes of data to be processed, as part of the job. type: integer processedData: format: int64 description: The number of bytes of data processed till now, as part of the job. type: integer cloudData: format: int64 description: The number of bytes of data written to cloud, as part of the job. type: integer throughput: format: int64 description: The average throughput of data processed(bytes/sec), as part of the job. type: integer JobCancellationThreshold: description: The job cancellation threshold definition. type: object properties: type: description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices. type: string enum: - number - percentage x-ms-enum: name: JobCancellationThresholdType modelAsString: false values: - value: number name: Number description: Job cancellation threshold based on specified number of devices. - value: percentage name: Percentage description: Job cancellation threshold based on percentage of total devices. value: description: The number or percentage of devices on which the cancellation threshold is applied. type: number batch: description: Whether the cancellation threshold applies per-batch or to the overall job. type: boolean required: - type - value PackageCarrierInfo: description: package carrier info type: object properties: carrierName: description: Name of the carrier. type: string trackingId: description: Tracking Id of shipment. type: string CloudServiceConfiguration_2: properties: osFamily: type: string title: The Azure Guest OS family to be installed on the virtual machines in the Pool. description: 'Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).' osVersion: type: string title: The Azure Guest OS version to be installed on the virtual machines in the Pool. description: The default value is * which specifies the latest operating system version for the specified OS family. required: - osFamily title: The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform. JobProgress: description: progress summary for a scheduled job. type: object properties: total: description: The total number of entities targeted by the job. type: integer format: int32 pending: description: The number of entities for which the job is not yet running. type: integer format: int32 completed: description: The number of entities for which the job has completed. type: integer format: int32 failed: description: The number of entities for which the job has failed. type: integer format: int32 ApplicationPackageReference: properties: applicationId: type: string title: The ID of the application to deploy. version: type: string title: The version of the application to deploy. If omitted, the default version is deployed. description: If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. required: - applicationId title: A reference to an Package to be deployed to Compute Nodes. ElevationLevel_2: type: string title: The elevation level of the user. enum: - nonadmin - admin x-ms-enum: name: ElevationLevel modelAsString: false values: - value: nonadmin description: The user is a standard user without elevated access. name: nonAdmin - value: admin description: The user is a user with elevated access and operates with full Administrator permissions. BatchNodePlacementConfiguration: type: object description: 'For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones with best effort balancing.' properties: policy: $ref: '#/definitions/BatchNodePlacementPolicyType' description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. BatchTaskAddStatus: type: string description: BatchTaskAddStatus enums enum: - success - clienterror - servererror x-ms-enum: name: BatchTaskAddStatus modelAsString: true values: - name: Success value: success description: The Task was added successfully. - name: ClientError value: clienterror description: The Task failed to add due to a client error and should not be retried without modifying the request as appropriate. - name: ServerError value: servererror description: Task failed to add due to a server error and can be retried without modification. AutoUserScope: type: string description: AutoUserScope enums enum: - task - pool x-ms-enum: name: AutoUserScope modelAsString: true values: - name: Task value: task description: Specifies that the service should create a new user for the Task. - name: Pool value: pool description: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. BatchJobPreparationAndReleaseTaskStatusListResult: type: object description: 'The result of listing the status of the Job Preparation and Job Release Tasks for a Job.' properties: value: type: array description: A list of Job Preparation and Job Release Task execution information. items: $ref: '#/definitions/BatchJobPreparationAndReleaseTaskStatus' x-ms-identifiers: [] odata.nextLink: type: string description: The URL to get the next set of results. JobAction: properties: type: type: string description: Gets or sets the job action type. enum: - Http - Https - StorageQueue - ServiceBusQueue - ServiceBusTopic x-ms-enum: name: JobActionType modelAsString: false request: $ref: '#/definitions/HttpRequest' description: Gets or sets the http requests. queueMessage: $ref: '#/definitions/StorageQueueMessage' description: Gets or sets the storage queue message. serviceBusQueueMessage: $ref: '#/definitions/ServiceBusQueueMessage' description: Gets or sets the service bus queue message. serviceBusTopicMessage: $ref: '#/definitions/ServiceBusTopicMessage' description: Gets or sets the service bus topic message. retryPolicy: $ref: '#/definitions/RetryPolicy' description: Gets or sets the retry policy. errorAction: $ref: '#/definitions/JobErrorAction' description: Gets or sets the error action. MetadataItem: type: object description: 'The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.' properties: name: type: string description: The name of the metadata item. value: type: string description: The value of the metadata item. required: - name - value Resource: description: Model of the Resource. required: - location - sku type: object properties: location: description: The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed. type: string x-ms-mutability: - read - create tags: description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). type: object additionalProperties: type: string sku: $ref: '#/definitions/Sku' description: The sku type. identity: $ref: '#/definitions/ResourceIdentity' description: Msi identity of the resource x-ms-azure-resource: true HttpHeader: type: object description: An HTTP header name-value pair properties: name: type: string description: The case-insensitive name of the header to be used while uploading output files. value: type: string description: The value of the header to be used while uploading output files. required: - name JobDeviceStatus: description: The job device status definition. type: object properties: id: description: ID of the device whose job status is being provided. type: string readOnly: true status: description: Indicates whether the job is starting, running, etc. for the given device. type: string readOnly: true CustomerSecret: description: The pair of customer secret. required: - keyIdentifier - keyValue - algorithm type: object properties: keyIdentifier: description: The identifier to the data service input object which this secret corresponds to. type: string keyValue: description: It contains the encrypted customer secret. type: string algorithm: description: The encryption algorithm used to encrypt data. enum: - None - RSA1_5 - RSA_OAEP - PlainText type: string x-ms-enum: name: SupportedAlgorithm modelAsString: false FileProperties: type: object description: The properties of a file on a Compute Node. properties: creationTime: type: string format: date-time description: The file creation time. The creation time is not returned for files on Linux Compute Nodes. lastModified: type: string format: date-time description: The time at which the file was last modified. contentLength: type: integer format: int32 description: The length of the file. contentType: type: string description: The content type of the file. fileMode: type: string description: The file mode attribute in octal format. The file mode is returned only for files on Linux Compute Nodes. required: - lastModified - contentLength JobListResult: properties: value: type: array items: $ref: '#/definitions/JobDefinition_2' description: Gets or sets all jobs under job collection. nextLink: type: string description: Gets or sets the URL to get the next set of jobs. CloudError_2: description: Provides additional information about an http error response. properties: additionalInfo: description: Gets or sets additional error info. items: $ref: '#/definitions/AdditionalErrorInfo' readOnly: true type: array code: description: Error code. type: string details: description: Gets or sets details for the error. items: $ref: '#/definitions/CloudError_2' readOnly: true type: array message: description: The error message parsed from the body of the http error response. type: string target: description: Gets or sets the target of the error. type: string type: object BatchJobSchedulingError: type: object description: An error encountered by the Batch service when scheduling a Job. properties: category: $ref: '#/definitions/ErrorCategory' description: The category of the Job scheduling error. code: type: string description: An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Job scheduling error, intended to be suitable for display in a user interface. details: type: array description: A list of additional error details related to the scheduling error. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: [] required: - category BatchNodeFileListResult: type: object description: 'The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.' properties: value: type: array description: The list of files. items: $ref: '#/definitions/BatchNodeFile' x-ms-identifiers: [] odata.nextLink: type: string description: The URL to get the next set of results. CopyLogDetails: description: Details for log generated during copy. required: - copyLogDetailsType type: object properties: copyLogDetailsType: description: Indicates the type of job details. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: ClassDiscriminator modelAsExtensible: false values: - value: DataBox description: Data Box orders. - value: DataBoxDisk description: Data Box Disk orders. - value: DataBoxHeavy description: Data Box Heavy orders. - value: DataBoxCustomerDisk description: Data Box Customer Disk orders. discriminator: copyLogDetailsType BatchTaskListSubtasksResult: type: object description: The result of listing the subtasks of a Task. properties: value: type: array description: The list of subtasks. items: $ref: '#/definitions/BatchSubtask' odata.nextLink: type: string description: The URL to get the next set of results. BatchPoolInfoUpdate: type: object description: Specifies how a Job should be assigned to a Pool. properties: poolId: type: string description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. autoPoolSpecification: $ref: '#/definitions/BatchAutoPoolSpecificationUpdate' description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. TransferFilterDetails: description: Details of the filtering the transfer of data. required: - dataAccountType type: object properties: dataAccountType: description: Type of the account of data. enum: - StorageAccount - ManagedDisk type: string x-ms-enum: name: DataAccountType modelAsExtensible: true values: - value: StorageAccount description: Storage Accounts . - value: ManagedDisk description: Azure Managed disk storage. default: StorageAccount blobFilterDetails: $ref: '#/definitions/BlobFilterDetails' description: Filter details to transfer blobs. azureFileFilterDetails: $ref: '#/definitions/AzureFileFilterDetails' description: Filter details to transfer Azure files. filterFileDetails: description: Details of the filter files to be used for data transfer. type: array items: $ref: '#/definitions/FilterFileDetails' ContainerConfigurationUpdate: type: object description: The configuration for container-enabled Pools. properties: type: $ref: '#/definitions/ContainerType' description: The container technology to be used. containerImageNames: type: array description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. items: type: string containerRegistries: type: array description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. items: $ref: '#/definitions/ContainerRegistry' x-ms-identifiers: [] JobProperties_5: description: The properties of the job. required: - jobType type: object properties: jobType: description: The type of the job. enum: - ScheduledBackup - ManualBackup - RestoreBackup - CloneVolume - FailoverVolumeContainers - CreateLocallyPinnedVolume - ModifyVolume - InstallUpdates - SupportPackageLogs - CreateCloudAppliance type: string x-ms-enum: name: JobType modelAsString: false dataStats: $ref: '#/definitions/DataStatistics' description: The data statistics properties of the job. entityLabel: description: The entity identifier for which the job ran. type: string entityType: description: The entity type for which the job ran. type: string jobStages: description: The job stages. type: array items: $ref: '#/definitions/JobStage' x-ms-identifiers: [] deviceId: description: The device ID in which the job ran. type: string isCancellable: description: Represents whether the job is cancellable or not. type: boolean backupType: description: The backup type (CloudSnapshot | LocalSnapshot). Applicable only for backup jobs. enum: - LocalSnapshot - CloudSnapshot type: string x-ms-enum: name: BackupType modelAsString: false sourceDeviceId: description: The source device ID of the failover job. type: string backupPointInTime: format: date-time description: The time of the backup used for the failover. type: string CloudJob: properties: id: type: string title: A string that uniquely identifies the Job within the Account. description: The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). displayName: type: string title: The display name for the Job. usesTaskDependencies: type: boolean title: Whether Tasks in the Job can define dependencies on each other. The default is false. url: type: string title: The URL of the Job. eTag: type: string title: The ETag of the Job. description: This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime. lastModified: type: string format: date-time title: The last modified time of the Job. description: This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. creationTime: type: string format: date-time title: The creation time of the Job. state: title: The current state of the Job. $ref: '#/definitions/JobState' stateTransitionTime: type: string format: date-time title: The time at which the Job entered its current state. previousState: title: The previous state of the Job. description: This property is not set if the Job is in its initial Active state. $ref: '#/definitions/JobState' previousStateTransitionTime: type: string format: date-time title: The time at which the Job entered its previous state. description: This property is not set if the Job is in its initial Active state. priority: type: integer format: int32 title: The priority of the Job. description: 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. constraints: $ref: '#/definitions/JobConstraints' title: The execution constraints for the Job. jobManagerTask: $ref: '#/definitions/JobManagerTask' title: Details of a Job Manager Task to be launched when the Job is started. jobPreparationTask: $ref: '#/definitions/JobPreparationTask' title: The Job Preparation Task. description: The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. jobReleaseTask: $ref: '#/definitions/JobReleaseTask' title: The Job Release Task. description: The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. commonEnvironmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting_2' title: The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). description: Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. poolInfo: $ref: '#/definitions/PoolInformation' title: The Pool settings associated with the Job. onAllTasksComplete: title: The action the Batch service should take when all Tasks in the Job are in the completed state. description: The default is noaction. $ref: '#/definitions/OnAllTasksComplete' onTaskFailure: title: The action the Batch service should take when any Task in the Job fails. description: A Task is considered to 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. $ref: '#/definitions/OnTaskFailure' networkConfiguration: $ref: '#/definitions/JobNetworkConfiguration' title: The network configuration for the Job. metadata: type: array items: $ref: '#/definitions/MetadataItem_2' title: A list of name-value pairs associated with the Job as metadata. description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. executionInfo: $ref: '#/definitions/JobExecutionInformation' title: The execution information for the Job. stats: $ref: '#/definitions/JobStatistics' title: Resource usage statistics for the entire lifetime of the Job. description: This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. title: An Azure Batch Job. BatchTaskAddResult: type: object description: Result for a single Task added as part of an add Task collection operation. properties: status: $ref: '#/definitions/BatchTaskAddStatus' description: The status of the add Task request. taskId: type: string description: The ID of the Task for which this is the result. eTag: type: string description: The ETag of the Task, if the Task was successfully added. You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime. lastModified: type: string format: date-time description: The last modified time of the Task. location: type: string description: The URL of the Task, if the Task was successfully added. error: $ref: '#/definitions/BatchError' description: The error encountered while attempting to add the Task. required: - status - taskId BatchTaskGroup: type: object description: A collection of Azure Batch Tasks to add. properties: value: type: array description: The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks. items: $ref: '#/definitions/BatchTaskCreateContent' required: - value NameValuePair_2: properties: name: type: string title: The name in the name-value pair. value: type: string title: The value in the name-value pair. title: Represents a name-value pair. JobList: description: Job Collection. type: object properties: value: description: List of jobs. type: array items: $ref: '#/definitions/Job_3' nextLink: description: Link for the next set of jobs. type: string ServiceArtifactReferenceUpdate: type: object description: 'Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using ''latest'' image version.' properties: id: type: string description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} FilterFileDetails: description: Details of the filter files to be used for data transfer. required: - filterFileType - filterFilePath type: object properties: filterFileType: description: Type of the filter file. enum: - AzureBlob - AzureFile type: string x-ms-enum: name: FilterFileType modelAsExtensible: true values: - value: AzureBlob description: Filter file is of the type AzureBlob. - value: AzureFile description: Filter file is of the type AzureFiles. filterFilePath: description: Path of the file that contains the details of all items to transfer. type: string JobReleaseTask: properties: id: type: string title: A string that uniquely identifies the Job Release Task within the Job. description: The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). commandLine: type: string title: The command line of the Job Release Task. description: The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/TaskContainerSettings' title: The settings for the container under which the Job Release Task runs. description: When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array items: $ref: '#/definitions/ResourceFile_2' title: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. description: Files listed under this element are located in the Task's working directory. environmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting_2' title: A list of environment variable settings for the Job Release Task. maxWallClockTime: type: string format: duration title: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). retentionTime: type: string format: duration title: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents. description: The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted. userIdentity: $ref: '#/definitions/UserIdentity_2' title: The user identity under which the Job Release Task runs. description: If omitted, the Task runs as a non-administrative user unique to the Task. required: - commandLine title: A Job Release Task to run on Job completion on any Compute Node where the Job has run. description: 'The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job''s maximum wall clock time constraint is reached, and the Job is still active, or the Job''s Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool.' ErrorDetail: required: - code - message type: object properties: code: type: string message: type: string details: type: array items: $ref: '#/definitions/Details' target: type: string TaskSchedulingPolicy: properties: nodeFillType: type: string title: How Tasks are distributed across Compute Nodes in a Pool. description: If not specified, the default is spread. enum: - spread - pack x-ms-enum: name: ComputeNodeFillType modelAsString: false values: - value: spread description: Tasks should be assigned evenly across all Compute Nodes in the Pool. - value: pack description: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. required: - nodeFillType title: Specifies how Tasks should be distributed across Compute Nodes. MarkDevicesShippedRequest: description: The request body to provide the delivery package details of job required: - deliverToDcPackageDetails type: object properties: deliverToDcPackageDetails: $ref: '#/definitions/PackageCarrierInfo' description: Delivery package details OnAllTasksComplete: type: string title: The action the Batch service should take when all Tasks in the Job are in the completed state. enum: - noaction - terminatejob x-ms-enum: name: OnAllTasksComplete modelAsString: false values: - value: noaction description: Do nothing. The Job remains active unless terminated or disabled by some other means. name: noAction - value: terminatejob description: Terminate the Job. The Job's terminateReason is set to 'AllTasksComplete'. name: terminateJob AutoUserSpecification: type: object description: Specifies the options for the auto user that runs an Azure Batch Task. properties: scope: $ref: '#/definitions/AutoUserScope' description: The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks. elevationLevel: $ref: '#/definitions/ElevationLevel' description: The elevation level of the auto user. The default value is nonAdmin. JobDetails: description: Job details. required: - contactDetails - jobDetailsType type: object properties: jobStages: description: List of stages that run in the job. type: array items: $ref: '#/definitions/JobStages' readOnly: true contactDetails: $ref: '#/definitions/ContactDetails' description: Contact details for notification and shipping. shippingAddress: $ref: '#/definitions/ShippingAddress' description: Shipping address of the customer. deliveryPackage: $ref: '#/definitions/PackageShippingDetails' description: Delivery package shipping details. readOnly: true returnPackage: $ref: '#/definitions/PackageShippingDetails' description: Return package shipping details. readOnly: true dataImportDetails: description: Details of the data to be imported into azure. type: array items: $ref: '#/definitions/DataImportDetails' dataExportDetails: description: Details of the data to be exported from azure. type: array items: $ref: '#/definitions/DataExportDetails' jobDetailsType: description: Indicates the type of job details. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: ClassDiscriminator modelAsExtensible: false values: - value: DataBox description: Data Box orders. - value: DataBoxDisk description: Data Box Disk orders. - value: DataBoxHeavy description: Data Box Heavy orders. - value: DataBoxCustomerDisk description: Data Box Customer Disk orders. preferences: $ref: '#/definitions/Preferences' description: Preferences for the order. reverseShippingDetails: $ref: '#/definitions/ReverseShippingDetails' description: Optional Reverse Shipping details for order. copyLogDetails: description: List of copy log details. type: array items: $ref: '#/definitions/CopyLogDetails' readOnly: true reverseShipmentLabelSasKey: description: Shared access key to download the return shipment label type: string readOnly: true chainOfCustodySasKey: description: Shared access key to download the chain of custody logs type: string readOnly: true deviceErasureDetails: $ref: '#/definitions/DeviceErasureDetails' description: Holds device data erasure details readOnly: true keyEncryptionKey: $ref: '#/definitions/KeyEncryptionKey' description: Details about which key encryption type is being used. expectedDataSizeInTeraBytes: format: int32 description: The expected size of the data, which needs to be transferred in this job, in terabytes. type: integer actions: description: Available actions on the job. uniqueItems: false type: array items: enum: - None - MoveToCleanUpDevice - Resume - Restart - ReachOutToOperation type: string x-ms-enum: name: CustomerResolutionCode modelAsExtensible: true values: - value: None description: No Resolution Yet - value: MoveToCleanUpDevice description: Clean the device - value: Resume description: Resume the job to same stage - description: Restart whole action. value: Restart - description: Reach out to operation for further action. value: ReachOutToOperation readOnly: true lastMitigationActionOnJob: $ref: '#/definitions/LastMitigationActionOnJob' description: Last mitigation action performed on the job. readOnly: true datacenterAddress: $ref: '#/definitions/DatacenterAddressResponse' description: Datacenter address to ship to, for the given sku and storage location. readOnly: true dataCenterCode: description: DataCenter code. enum: - Invalid - BY2 - BY1 - ORK70 - AM2 - AMS20 - BY21 - BY24 - MWH01 - AMS06 - SSE90 - SYD03 - SYD23 - CBR20 - YTO20 - CWL20 - LON24 - BOM01 - BL20 - BL7 - SEL20 - TYO01 - BN1 - SN5 - CYS04 - TYO22 - YTO21 - YQB20 - FRA22 - MAA01 - CPQ02 - CPQ20 - SIN20 - HKG20 - SG2 - MEL23 - SEL21 - OSA20 - SHA03 - BJB - JNB22 - JNB21 - MNZ21 - SN8 - AUH20 - ZRH20 - PUS20 - AdHoc - CH1 - DSM05 - DUB07 - PNQ01 - SVG20 - OSA02 - OSA22 - PAR22 - BN7 - SN6 - BJS20 - BL24 - IDC5 - TYO23 - NTG20 - DXB23 - DSM11 - AMS25 - CPQ21 - OSA23 type: string readOnly: true x-ms-enum: name: DataCenterCode modelAsString: true values: - value: Invalid - value: BY2 - value: BY1 - value: ORK70 - value: AM2 - value: AMS20 - value: BY21 - value: BY24 - value: MWH01 - value: AMS06 - value: SSE90 - value: SYD03 - value: SYD23 - value: CBR20 - value: YTO20 - value: CWL20 - value: LON24 - value: BOM01 - value: BL20 - value: BL7 - value: SEL20 - value: TYO01 - value: BN1 - value: SN5 - value: CYS04 - value: TYO22 - value: YTO21 - value: YQB20 - value: FRA22 - value: MAA01 - value: CPQ02 - value: CPQ20 - value: SIN20 - value: HKG20 - value: SG2 - value: MEL23 - value: SEL21 - value: OSA20 - value: SHA03 - value: BJB - value: JNB22 - value: JNB21 - value: MNZ21 - value: SN8 - value: AUH20 - value: ZRH20 - value: PUS20 - value: AdHoc - value: CH1 - value: DSM05 - value: DUB07 - value: PNQ01 - value: SVG20 - value: OSA02 - value: OSA22 - value: PAR22 - value: BN7 - value: SN6 - value: BJS20 - value: BL24 - value: IDC5 - value: TYO23 - value: CPQ21 - value: NTG20 - value: DXB23 - value: DSM11 - value: OSA23 - value: AMS25 discriminator: jobDetailsType BaseModel: description: Represents the base class for all other ARM object models type: object properties: id: description: The path ID that uniquely identifies the object. type: string readOnly: true name: description: The name of the object. type: string readOnly: true type: description: The hierarchical type of the object. type: string readOnly: true kind: description: The Kind of the object. Currently only Series8000 is supported enum: - Series8000 type: string x-ms-enum: name: Kind modelAsString: false BatchJobDisableContent: type: object description: Parameters for disabling an Azure Batch Job. properties: disableTasks: $ref: '#/definitions/DisableBatchJobOption' description: What to do with active Tasks associated with the Job. required: - disableTasks OutputFileUploadCondition_2: type: string title: The conditions under which a Task output file or set of files should be uploaded. enum: - tasksuccess - taskfailure - taskcompletion x-ms-enum: name: OutputFileUploadCondition modelAsString: false values: - value: tasksuccess description: Upload the file(s) only after the Task process exits with an exit code of 0. name: taskSuccess - value: taskfailure description: Upload the file(s) only after the Task process exits with a nonzero exit code. name: taskFailure - value: taskcompletion description: Upload the file(s) after the Task process exits, no matter what the exit code was. name: taskCompletion OutputFileDestination: type: object description: The destination to which a file should be uploaded. properties: container: $ref: '#/definitions/OutputFileBlobContainerDestination' description: A location in Azure blob storage to which files are uploaded. UpdateInstallProgress: description: Progress details during installation of updates. type: object properties: percentComplete: format: int32 description: Percentage completed. type: integer readOnly: true numberOfUpdatesToInstall: format: int32 description: Number of updates to install. type: integer readOnly: true numberOfUpdatesInstalled: format: int32 description: Number of updates installed. type: integer readOnly: true DynamicVNetAssignmentScope: type: string description: DynamicVNetAssignmentScope enums enum: - none - job x-ms-enum: name: DynamicVNetAssignmentScope modelAsString: true values: - name: None value: none description: No dynamic VNet assignment is enabled. - name: Job value: job description: Dynamic VNet assignment is done per-job. JobNetworkConfiguration: properties: subnetId: type: string title: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. This will only work with a VirtualMachineConfiguration Pool. description: 'The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The ''MicrosoftAzureBatch'' service principal must have the ''Classic Virtual Machine Contributor'' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration' externalDocs: url: https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor description: Setting up RBAC for Azure Batch VNETs required: - subnetId title: The network configuration for the Job. JobErrorDetails_2: description: The job error details. Contains list of job error items. required: - code - message type: object properties: errorDetails: description: The error details. type: array items: $ref: '#/definitions/JobErrorItem_2' x-ms-identifiers: [] code: description: The error code intended for programmatic access. type: string message: description: The error message intended to describe the error in detail. type: string BatchJobPreparationAndReleaseTaskStatus: type: object description: The status of the Job Preparation and Job Release Tasks on a Compute Node. properties: poolId: type: string description: The ID of the Pool containing the Compute Node to which this entry refers. nodeId: type: string description: The ID of the Compute Node to which this entry refers. nodeUrl: type: string description: The URL of the Compute Node to which this entry refers. jobPreparationTaskExecutionInfo: $ref: '#/definitions/BatchJobPreparationTaskExecutionInfo' description: Information about the execution status of the Job Preparation Task on this Compute Node. jobReleaseTaskExecutionInfo: $ref: '#/definitions/BatchJobReleaseTaskExecutionInfo' description: Information about the execution status of the Job Release Task on this Compute Node. This property is set only if the Job Release Task has run on the Compute Node. JobStatus: properties: executionCount: type: integer readOnly: true description: Gets the number of times this job has executed. failureCount: type: integer readOnly: true description: Gets the number of times this job has failed. faultedCount: type: integer readOnly: true description: Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). lastExecutionTime: type: string format: date-time readOnly: true description: Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. nextExecutionTime: type: string format: date-time readOnly: true description: Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. UnencryptedCredentials: description: Unencrypted credentials for accessing device. type: object properties: jobName: description: Name of the job. type: string readOnly: true jobSecrets: $ref: '#/definitions/JobSecrets' description: Secrets related to this job. readOnly: true CloudErrorBody: description: An error response from the service. type: object properties: code: description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. type: string message: description: A message describing the error, intended to be suitable for display in a user interface. type: string details: description: A list of additional details about the error. type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-identifiers: [] x-ms-external: true AuthenticationTokenSettings_2: properties: access: type: array items: type: string x-nullable: false enum: - job x-ms-enum: name: AccessScope modelAsString: false values: - value: job description: Grants access to perform all operations on the Job containing the Task. title: The Batch resources to which the token grants access. description: The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task. title: The settings for an authentication token that the Task can use to perform Batch service operations. BatchError_2: properties: code: type: string title: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/ErrorMessage' title: A message describing the error, intended to be suitable for display in a user interface. values: type: array items: $ref: '#/definitions/BatchErrorDetail_2' title: A collection of key-value pairs containing additional details about the error. title: An error response received from the Azure Batch service. BatchError: type: object description: An error response received from the Azure Batch service. properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/BatchErrorMessage' description: A message describing the error, intended to be suitable for display in a user interface. values: type: array description: A collection of key-value pairs containing additional details about the error. items: $ref: '#/definitions/BatchErrorDetail' x-ms-identifiers: [] required: - code JobState_2: type: string description: Gets or set the job state. enum: - Enabled - Disabled - Faulted - Completed x-ms-enum: name: JobState modelAsString: false BatchTaskExecutionResult: type: string description: BatchTaskExecutionResult enums enum: - success - failure x-ms-enum: name: BatchTaskExecutionResult modelAsString: true values: - name: Success value: success description: The Task ran successfully. - name: Failure value: failure description: There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited. Job_4: description: The job. required: - status - percentComplete type: object allOf: - $ref: '#/definitions/BaseModel' properties: status: description: The current status of the job. enum: - Running - Succeeded - Failed - Canceled type: string x-ms-enum: name: JobStatus modelAsString: false startTime: format: date-time description: The UTC time at which the job was started. type: string endTime: format: date-time description: The UTC time at which the job completed. type: string percentComplete: format: int32 description: The percentage of the job that is already complete. type: integer error: $ref: '#/definitions/JobErrorDetails_2' description: The error details, if any, for the job. properties: $ref: '#/definitions/JobProperties_5' description: The properties of the job. x-ms-client-flatten: true LastMitigationActionOnJob: description: Last Mitigation Action Performed On Job type: object properties: actionDateTimeInUtc: format: date-time description: Action performed date time type: string isPerformedByCustomer: description: "Action performed by customer,\r\npossibility is that mitigation might happen by customer or service or by ops" type: boolean customerResolution: description: Resolution code provided by customer enum: - None - MoveToCleanUpDevice - Resume - Restart - ReachOutToOperation type: string x-ms-enum: name: CustomerResolutionCode modelAsExtensible: true values: - value: None description: No Resolution Yet - value: MoveToCleanUpDevice description: Clean the device - value: Resume description: Resume the job to same stage - description: Restart whole action. value: Restart - description: Reach out to operation for further action. value: ReachOutToOperation BatchSubtask: type: object description: Information about an Azure Batch subtask. properties: id: type: integer format: int32 description: The ID of the subtask. nodeInfo: $ref: '#/definitions/BatchNodeInfo' description: Information about the Compute Node on which the subtask ran. startTime: type: string format: date-time description: The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running. endTime: type: string format: date-time description: The time at which the subtask completed. This property is set only if the subtask is in the Completed state. exitCode: type: integer format: int32 description: The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/definitions/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. state: $ref: '#/definitions/BatchSubtaskState' description: The current state of the subtask. stateTransitionTime: type: string format: date-time description: The time at which the subtask entered its current state. previousState: $ref: '#/definitions/BatchSubtaskState' description: The previous state of the subtask. This property is not set if the subtask is in its initial running state. previousStateTransitionTime: type: string format: date-time description: The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state. result: $ref: '#/definitions/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Job_2: description: A device job. type: object properties: id: description: The path ID that uniquely identifies the object. type: string readOnly: true name: description: The name of the object. type: string readOnly: true type: description: The hierarchical type of the object. type: string readOnly: true status: description: The current status of the job. enum: - Invalid - Running - Succeeded - Failed - Canceled - Paused - Scheduled type: string readOnly: true x-ms-enum: name: JobStatus modelAsString: true startTime: format: date-time description: The UTC date and time at which the job started. type: string readOnly: true endTime: format: date-time description: The UTC date and time at which the job completed. type: string readOnly: true percentComplete: format: int32 description: The percentage of the job that is complete. type: integer readOnly: true error: $ref: '#/definitions/JobErrorDetails' description: The error details. readOnly: true properties: $ref: '#/definitions/JobProperties' description: The properties of the job. readOnly: true x-ms-client-flatten: true JobDefinition_2: properties: id: type: string readOnly: true description: Gets the job resource identifier. type: type: string readOnly: true description: Gets the job resource type. name: type: string readOnly: true description: Gets the job resource name. properties: $ref: '#/definitions/JobProperties_4' description: Gets or sets the job properties. UserAccount: type: object description: 'Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.' properties: name: type: string description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. password: type: string description: The password for the user Account. elevationLevel: $ref: '#/definitions/ElevationLevel' description: The elevation level of the user Account. The default value is nonAdmin. linuxUserConfiguration: $ref: '#/definitions/LinuxUserConfiguration' description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. windowsUserConfiguration: $ref: '#/definitions/WindowsUserConfiguration' description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. required: - name - password ExitCodeMapping: type: object description: 'How the Batch service should respond if a Task exits with a particular exit code.' properties: code: type: integer format: int32 description: A process exit code. exitOptions: $ref: '#/definitions/ExitOptions' description: How the Batch service should respond if the Task exits with this exit code. required: - code - exitOptions BatchTaskCountsResult: type: object description: The Task and TaskSlot counts for a Job. properties: taskCounts: $ref: '#/definitions/BatchTaskCounts' description: The number of Tasks per state. taskSlotCounts: $ref: '#/definitions/BatchTaskSlotCounts' description: The number of TaskSlots required by Tasks per state. required: - taskCounts - taskSlotCounts UpgradePolicyUpdate: type: object description: Describes an upgrade policy - automatic, manual, or rolling. properties: mode: $ref: '#/definitions/UpgradeMode' description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. automaticOsUpgradePolicy: $ref: '#/definitions/AutomaticOsUpgradePolicy' description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. x-ms-client-name: automaticOSUpgradePolicy rollingUpgradePolicy: $ref: '#/definitions/RollingUpgradePolicy' description: The configuration parameters used while performing a rolling upgrade. This property is only supported on Pools with the virtualMachineConfiguration property. BatchJobPreparationTaskExecutionInfo: type: object description: 'Contains information about the execution of a Job Preparation Task on a Compute Node.' properties: startTime: type: string format: date-time description: The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running. endTime: type: string format: date-time description: The time at which the Job Preparation Task completed. This property is set only if the Task is in the Completed state. state: $ref: '#/definitions/BatchJobPreparationTaskState' description: The current state of the Job Preparation Task on the Compute Node. taskRootDirectory: type: string description: The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files. taskRootDirectoryUrl: type: string description: The URL to the root directory of the Job Preparation Task on the Compute Node. exitCode: type: integer format: int32 description: The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated. containerInfo: $ref: '#/definitions/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 description: The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. lastRetryTime: type: string format: date-time description: The most recent time at which a retry of the Job Preparation Task started running. This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. result: $ref: '#/definitions/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - startTime - state - retryCount TransferConfiguration: description: Configuration for defining the transfer of data. required: - transferConfigurationType type: object properties: transferConfigurationType: description: Type of the configuration for transfer. enum: - TransferAll - TransferUsingFilter type: string x-ms-enum: name: TransferConfigurationType modelAsExtensible: true values: - value: TransferAll description: Transfer all the data. - value: TransferUsingFilter description: Transfer using filter. transferFilterDetails: description: Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. type: object properties: include: description: Details of the filtering the transfer of data. $ref: '#/definitions/TransferFilterDetails' transferAllDetails: description: Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll type: object properties: include: description: Details to transfer all data. $ref: '#/definitions/TransferAllDetails' BatchTaskSlotCounts: type: object description: The TaskSlot counts for a Job. properties: active: type: integer format: int32 description: The number of TaskSlots for active Tasks. running: type: integer format: int32 description: The number of TaskSlots for running Tasks. completed: type: integer format: int32 description: The number of TaskSlots for completed Tasks. succeeded: type: integer format: int32 description: The number of TaskSlots for succeeded Tasks. failed: type: integer format: int32 description: The number of TaskSlots for failed Tasks. required: - active - running - completed - succeeded - failed InboundNATPool_2: properties: name: type: string title: The name of the endpoint. description: The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. protocol: $ref: '#/definitions/InboundEndpointProtocol_2' title: The protocol of the endpoint. backendPort: type: integer format: int32 title: The port number on the Compute Node. description: This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. frontendPortRangeStart: type: integer format: int32 title: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. frontendPortRangeEnd: type: integer format: int32 title: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. description: Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. networkSecurityGroupRules: type: array title: A list of network security group rules that will be applied to the endpoint. description: The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. items: $ref: '#/definitions/NetworkSecurityGroupRule_2' required: - name - protocol - backendPort - frontendPortRangeStart - frontendPortRangeEnd title: A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally. BatchErrorDetail_2: properties: key: type: string title: An identifier specifying the meaning of the Value property. value: type: string title: The additional information included with the error response. title: An item of additional information included in an Azure Batch error response. PoolSpecification: properties: displayName: type: string title: The display name for the Pool. description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. vmSize: type: string title: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. description: For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). cloudServiceConfiguration: $ref: '#/definitions/CloudServiceConfiguration_2' title: The cloud service configuration for the Pool. description: This property must be specified if the Pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'. virtualMachineConfiguration: $ref: '#/definitions/VirtualMachineConfiguration_2' title: The virtual machine configuration for the Pool. description: This property must be specified if the Pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). taskSlotsPerNode: type: integer format: int32 title: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. description: The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. taskSchedulingPolicy: $ref: '#/definitions/TaskSchedulingPolicy' title: How Tasks are distributed across Compute Nodes in a Pool. description: If not specified, the default is spread. resizeTimeout: type: string format: duration title: The timeout for allocation of Compute Nodes to the Pool. description: This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). targetDedicatedNodes: type: integer format: int32 title: The desired number of dedicated Compute Nodes in the Pool. description: This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. targetLowPriorityNodes: type: integer format: int32 title: The desired number of low-priority Compute Nodes in the Pool. description: This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. enableAutoScale: type: boolean title: Whether the Pool size should automatically adjust over time. description: If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. autoScaleFormula: type: string title: The formula for the desired number of Compute Nodes in the Pool. description: This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. autoScaleEvaluationInterval: type: string format: duration title: The time interval at which to automatically adjust the Pool size according to the autoscale formula. description: The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). enableInterNodeCommunication: type: boolean title: Whether the Pool permits direct communication between Compute Nodes. description: Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. networkConfiguration: $ref: '#/definitions/NetworkConfiguration_2' title: The network configuration for the Pool. startTask: $ref: '#/definitions/StartTask' title: 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. certificateReferences: type: array items: $ref: '#/definitions/CertificateReference' title: A list of Certificates to be installed on each Compute Node in the Pool. description: 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. applicationPackageReferences: type: array items: $ref: '#/definitions/ApplicationPackageReference' title: The list of Packages to be installed on each Compute Node in the Pool. description: Changes to Package references affect all new 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 Package references on any given Pool. applicationLicenses: type: array items: type: string title: The list of application licenses the Batch service will make available on each Compute Node in the Pool. description: The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail. The permitted licenses available on the Pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the Pool. userAccounts: type: array items: $ref: '#/definitions/UserAccount_2' title: The list of user Accounts to be created on each Compute Node in the Pool. metadata: type: array items: $ref: '#/definitions/MetadataItem_2' title: A list of name-value pairs associated with the Pool as metadata. description: The Batch service does not assign any meaning to metadata; it is solely for the use of user code. mountConfiguration: type: array items: $ref: '#/definitions/MountConfiguration_2' title: A list of file systems to mount on each node in the pool. description: This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. required: - vmSize title: Specification for creating a new Pool. NFSMountConfiguration: properties: source: type: string title: The URI of the file system to mount. relativeMountPath: type: string title: The relative path on the compute node where the file system will be mounted description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string title: Additional command line options to pass to the mount command. description: These are 'net use' options in Windows and 'mount' options in Linux. required: - source - relativeMountPath title: Information used to connect to an NFS file system. ContactDetails: description: Contact Details. required: - contactName - phone - emailList type: object properties: contactName: description: Contact name of the person. type: string phone: description: Phone number of the contact person. type: string phoneExtension: description: Phone extension number of the contact person. type: string mobile: description: Mobile number of the contact person. type: string emailList: description: List of Email-ids to be notified about job progress. type: array items: type: string notificationPreference: description: Notification preference for a job stage. type: array items: $ref: '#/definitions/NotificationPreference' DiskEncryptionConfiguration: type: object description: 'The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute Gallery Image.' properties: targets: type: array description: The list of disk targets Batch Service will encrypt on the compute node. If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. items: $ref: '#/definitions/DiskEncryptionTarget' Job: description: The job definition. type: object properties: id: description: Unique ID of the job. type: string readOnly: true scheduledJobId: description: Id of the scheduled job definition that created this job. type: string displayName: description: Display name of the job. type: string description: description: Detailed description of the job. type: string group: description: The ID of the device group on which to execute the job. type: string batch: description: The batching configuration for the job. $ref: '#/definitions/JobBatch' cancellationThreshold: description: The cancellation threshold for the job. $ref: '#/definitions/JobCancellationThreshold' data: description: The capabilities being updated by the job and the values with which they are being updated. type: array items: $ref: '#/definitions/JobData' minItems: 1 start: description: The start time of the job type: string format: date-time readOnly: true end: description: The end time of the job type: string format: date-time readOnly: true progress: description: The progress statistics of the job. $ref: '#/definitions/JobProgress' readOnly: true status: description: Indicates whether the job is starting, running, etc. type: string readOnly: true organizations: description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon. type: array items: type: string maxItems: 1 minItems: 1 required: - group - data AutoUserSpecification_2: properties: scope: type: string title: The scope for the auto user description: The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks. enum: - task - pool x-ms-enum: name: AutoUserScope modelAsString: false values: - value: task description: Specifies that the service should create a new user for the Task. - value: pool description: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. elevationLevel: title: The elevation level of the auto user. description: The default value is nonAdmin. $ref: '#/definitions/ElevationLevel_2' title: Specifies the parameters for the auto user that runs a Task on the Batch service. JobProperties: description: The properties for the job. type: object properties: jobType: description: The type of the job. enum: - Invalid - ScanForUpdates - DownloadUpdates - InstallUpdates - RefreshShare - RefreshContainer - Backup - Restore - TriggerSupportPackage type: string readOnly: true x-ms-enum: name: JobType modelAsString: true currentStage: description: Current stage of the update operation. enum: - Unknown - Initial - ScanStarted - ScanComplete - ScanFailed - DownloadStarted - DownloadComplete - DownloadFailed - InstallStarted - InstallComplete - InstallFailed - RebootInitiated - Success - Failure - RescanStarted - RescanComplete - RescanFailed type: string readOnly: true x-ms-enum: name: UpdateOperationStage modelAsString: true downloadProgress: $ref: '#/definitions/UpdateDownloadProgress' description: The download progress. readOnly: true installProgress: $ref: '#/definitions/UpdateInstallProgress' description: The install progress. readOnly: true totalRefreshErrors: format: int32 description: Total number of errors encountered during the refresh process. type: integer readOnly: true errorManifestFile: description: Local share/remote container relative path to the error manifest file of the refresh. type: string readOnly: true refreshedEntityId: description: ARM ID of the entity that was refreshed. type: string readOnly: true folder: description: If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.) type: string ResourceFile_2: properties: autoStorageContainerName: type: string title: The storage container name in the auto storage Account. description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. storageContainerUrl: type: string title: The URL of the blob container within Azure Blob Storage. description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, or set the ACL for the container to allow public access.' httpUrl: type: string title: The URL of the file to download. description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.' blobPrefix: type: string title: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. filePath: type: string title: The location on the Compute Node to which to download the file(s), relative to the Task's working directory. description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). fileMode: type: string title: The file permission mode attribute in octal format. description: This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. title: A single file or multiple files to be downloaded to a Compute Node. IpAddressProvisioningType: type: string description: IPAddressProvisioningType enums enum: - batchmanaged - usermanaged - nopublicipaddresses x-ms-enum: name: IpAddressProvisioningType modelAsString: true values: - name: BatchManaged value: batchmanaged description: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. - name: UserManaged value: usermanaged description: Public IPs are provided by the user and will be used to provision the Compute Nodes. - name: NoPublicIpAddresses value: nopublicipaddresses description: No public IP Address will be created. ImageReference: type: object description: 'A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the '' List Supported Images '' operation.' properties: publisher: type: string description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. offer: type: string description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. sku: type: string description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. version: type: string description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. virtualMachineImageId: type: string description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. exactVersion: type: string description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. readOnly: true BatchNodeCommunicationMode: type: string description: BatchNodeCommunicationMode enums enum: - default - classic - simplified x-ms-enum: name: BatchNodeCommunicationMode modelAsString: true values: - name: Default value: default description: The node communication mode is automatically set by the Batch service. - name: Classic value: classic description: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. - name: Simplified value: simplified description: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. CachingType: type: string description: CachingType enums enum: - none - readonly - readwrite x-ms-enum: name: CachingType modelAsString: true values: - name: None value: none description: The caching mode for the disk is not enabled. - name: ReadOnly value: readonly description: The caching mode for the disk is read only. - name: ReadWrite value: readwrite description: The caching mode for the disk is read and write. BatchTaskFailureInfo: type: object description: Information about a Task failure. properties: category: $ref: '#/definitions/ErrorCategory' description: The category of the Task error. code: type: string description: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the Task error, intended to be suitable for display in a user interface. details: type: array description: A list of additional details related to the error. items: $ref: '#/definitions/NameValuePair' x-ms-identifiers: [] required: - category JobStages: description: Job stages. type: object properties: stageName: description: Name of the job stage. enum: - DeviceOrdered - DevicePrepared - Dispatched - Delivered - PickedUp - AtAzureDC - DataCopy - Completed - CompletedWithErrors - Cancelled - Failed_IssueReportedAtCustomer - Failed_IssueDetectedAtAzureDC - Aborted - CompletedWithWarnings - ReadyToDispatchFromAzureDC - ReadyToReceiveAtAzureDC - Created - ShippedToAzureDC - AwaitingShipmentDetails - PreparingToShipFromAzureDC - ShippedToCustomer type: string readOnly: true x-ms-enum: name: StageName modelAsString: true values: - value: DeviceOrdered description: An order has been created. - value: DevicePrepared description: A device has been prepared for the order. - value: Dispatched description: Device has been dispatched to the user of the order. - value: Delivered description: Device has been delivered to the user of the order. - value: PickedUp description: Device has been picked up from user and in transit to Azure datacenter. - value: AtAzureDC description: Device has been received at Azure datacenter from the user. - value: DataCopy description: Data copy from the device at Azure datacenter. - value: Completed description: Order has completed. - value: CompletedWithErrors description: Order has completed with errors. - value: Cancelled description: Order has been cancelled. - value: Failed_IssueReportedAtCustomer description: Order has failed due to issue reported by user. - value: Failed_IssueDetectedAtAzureDC description: Order has failed due to issue detected at Azure datacenter. - value: Aborted description: Order has been aborted. - value: CompletedWithWarnings description: Order has completed with warnings. - value: ReadyToDispatchFromAzureDC description: Device is ready to be handed to customer from Azure DC. - value: ReadyToReceiveAtAzureDC description: Device can be dropped off at Azure DC. - value: Created description: Job created by the customer. - value: ShippedToAzureDC description: User shipped the device to AzureDC. - value: AwaitingShipmentDetails description: Awaiting shipment details of device from customer. - value: PreparingToShipFromAzureDC description: Preparing the device to ship to customer. - value: ShippedToCustomer description: Shipped the device to customer. displayName: description: Display name of the job stage. type: string readOnly: true stageStatus: description: Status of the job stage. enum: - None - InProgress - Succeeded - Failed - Cancelled - Cancelling - SucceededWithErrors - WaitingForCustomerAction - SucceededWithWarnings - WaitingForCustomerActionForKek - WaitingForCustomerActionForCleanUp - CustomerActionPerformedForCleanUp - CustomerActionPerformed type: string readOnly: true x-ms-enum: name: StageStatus modelAsExtensible: true values: - value: None description: No status available yet. - value: InProgress description: Stage is in progress. - value: Succeeded description: Stage has succeeded. - value: Failed description: Stage has failed. - value: Cancelled description: Stage has been cancelled. - value: Cancelling description: Stage is cancelling. - value: SucceededWithErrors description: Stage has succeeded with errors. - value: WaitingForCustomerAction description: Stage is stuck until customer takes some action. - value: SucceededWithWarnings description: Stage has succeeded with warnings. - value: WaitingForCustomerActionForKek description: Stage is waiting for customer action for kek action items. - value: WaitingForCustomerActionForCleanUp description: Stage is waiting for customer action for clean up. - value: CustomerActionPerformedForCleanUp description: Stage has performed customer action for clean up. - value: CustomerActionPerformed description: Stage has performed customer action. stageTime: format: date-time description: Time for the job stage in UTC ISO 8601 format. type: string readOnly: true jobStageDetails: description: Job Stage Details type: object readOnly: true delayInformation: description: Delay information for the job stages. type: array items: $ref: '#/definitions/JobDelayDetails' readOnly: true x-ms-identifiers: [] JobResourceList: description: Job Resource Collection type: object properties: value: description: List of job resources. type: array items: $ref: '#/definitions/JobResource' nextLink: description: Link for the next set of job resources. type: string JobSchedulingError: properties: category: title: The category of the Job scheduling error. $ref: '#/definitions/ErrorCategory_2' code: type: string title: An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. message: type: string title: A message describing the Job scheduling error, intended to be suitable for display in a user interface. details: type: array items: $ref: '#/definitions/NameValuePair_2' title: A list of additional error details related to the scheduling error. required: - category title: An error encountered by the Batch service when scheduling a Job. OSDiskUpdate: type: object description: Settings for the operating system disk of the compute node (VM). properties: ephemeralOSDiskSettings: $ref: '#/definitions/DiffDiskSettings' description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). caching: $ref: '#/definitions/CachingType' description: 'Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.' diskSizeGB: type: integer format: int32 description: The initial disk size in GB when creating new OS disk. managedDisk: $ref: '#/definitions/ManagedDiskUpdate' description: The managed disk parameters. writeAcceleratorEnabled: type: boolean description: Specifies whether writeAccelerator should be enabled or disabled on the disk. NetworkConfiguration_2: properties: subnetId: type: string title: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. description: 'The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn''t have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The ''MicrosoftAzureBatch'' service principal must have the ''Classic Virtual Machine Contributor'' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks (''Microsoft.Network/virtualNetworks'') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For Pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration' externalDocs: url: https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor description: Setting up RBAC for Azure Batch VNETs dynamicVNetAssignmentScope: type: string title: The scope of dynamic vnet assignment. enum: - none - job x-ms-enum: name: DynamicVNetAssignmentScope modelAsString: false values: - value: none description: No dynamic VNet assignment is enabled. - value: job description: Dynamic VNet assignment is done per-job. endpointConfiguration: $ref: '#/definitions/PoolEndpointConfiguration' title: The configuration for endpoints on Compute Nodes in the Batch Pool. description: Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property. publicIPAddressConfiguration: $ref: '#/definitions/PublicIPAddressConfiguration' title: The Public IPAddress configuration for Compute Nodes in the Batch Pool. description: Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property. description: The network configuration for a Pool. UpgradeMode: type: string description: UpgradeMode enums enum: - automatic - manual - rolling x-ms-enum: name: UpgradeMode modelAsString: true values: - name: Automatic value: automatic description: TAll virtual machines in the scale set are automatically updated at the same time. - name: Manual value: manual description: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. - name: Rolling value: rolling description: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. TransportPreferences: description: Preferences related to the shipment logistics of the sku required: - preferredShipmentType type: object properties: preferredShipmentType: description: Indicates Shipment Logistics type that the customer preferred. enum: - CustomerManaged - MicrosoftManaged type: string x-ms-enum: name: TransportShipmentTypes modelAsExtensible: true values: - value: CustomerManaged description: Shipment Logistics is handled by the customer. - value: MicrosoftManaged description: Shipment Logistics is handled by Microsoft. isUpdated: description: Read only property which indicates whether transport preferences has been updated or not after device is prepared. type: boolean readOnly: true StorageAccountType_2: type: string title: The storage Account type for use in creating data disks. enum: - standard_lrs - premium_lrs x-ms-enum: name: StorageAccountType modelAsString: false values: - value: standard_lrs description: The data disk should use standard locally redundant storage. name: StandardLRS - value: premium_lrs description: The data disk should use premium locally redundant storage. name: PremiumLRS SecurityProfileUpdate: type: object description: Specifies the security profile settings for the virtual machine or virtual machine scale set. properties: encryptionAtHost: type: boolean description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. securityType: $ref: '#/definitions/SecurityTypes' description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. uefiSettings: $ref: '#/definitions/UefiSettings' description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ServiceBusMessage: properties: authentication: $ref: '#/definitions/ServiceBusAuthentication' description: Gets or sets the Service Bus authentication. brokeredMessageProperties: $ref: '#/definitions/ServiceBusBrokeredMessageProperties' description: Gets or sets the brokered message properties. customMessageProperties: type: object additionalProperties: type: string description: Gets or sets the custom message properties. message: type: string description: Gets or sets the message. namespace: type: string description: Gets or sets the namespace. transportType: type: string description: Gets or sets the transport type. enum: - NotSpecified - NetMessaging - AMQP x-ms-enum: name: ServiceBusTransportType modelAsString: false WindowsUserConfiguration_2: properties: loginMode: type: string title: The login mode for the user description: The default value for VirtualMachineConfiguration Pools is 'batch' and for CloudServiceConfiguration Pools is 'interactive'. enum: - batch - interactive x-ms-enum: name: LoginMode modelAsString: false values: - value: batch description: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. - value: interactive description: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. title: Properties used to create a user Account on a Windows Compute Node. JobState: type: string title: The state of the Job. enum: - active - disabling - disabled - enabling - terminating - completed - deleting x-ms-enum: name: JobState modelAsString: false values: - value: active description: The Job is available to have Tasks scheduled. - value: disabling description: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). - value: disabled description: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. - value: enabling description: A user has requested that the Job be enabled, but the enable operation is still in progress. - value: terminating description: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). - value: completed description: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. - value: deleting description: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). OSDisk: type: object description: Settings for the operating system disk of the compute node (VM). properties: ephemeralOSDiskSettings: $ref: '#/definitions/DiffDiskSettings' description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). caching: $ref: '#/definitions/CachingType' description: 'Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.' diskSizeGB: type: integer format: int32 description: The initial disk size in GB when creating new OS disk. managedDisk: $ref: '#/definitions/ManagedDisk' description: The managed disk parameters. writeAcceleratorEnabled: type: boolean description: Specifies whether writeAccelerator should be enabled or disabled on the disk. BatchTaskListResult: type: object description: The result of listing the Tasks in a Job. properties: value: type: array description: The list of Tasks. items: $ref: '#/definitions/BatchTask' odata.nextLink: type: string description: The URL to get the next set of results. ManagedDisk: type: object description: The managed disk parameters. properties: storageAccountType: $ref: '#/definitions/StorageAccountType' description: The storage account type for managed disk. required: - storageAccountType CifsMountConfiguration: type: object description: Information used to connect to a CIFS file system. properties: username: type: string description: The user to use for authentication against the CIFS file system. source: type: string description: The URI of the file system to mount. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. password: type: string description: The password to use for authentication against the CIFS file system. required: - username - source - relativeMountPath - password JobSecrets: description: The base class for the secrets required: - jobSecretsType type: object properties: jobSecretsType: description: Used to indicate what type of job secrets object. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: ClassDiscriminator modelAsExtensible: false values: - value: DataBox description: Data Box orders. - value: DataBoxDisk description: Data Box Disk orders. - value: DataBoxHeavy description: Data Box Heavy orders. - value: DataBoxCustomerDisk description: Data Box Customer Disk orders. dcAccessSecurityCode: $ref: '#/definitions/DcAccessSecurityCode' description: Dc Access Security Code for Customer Managed Shipping readOnly: true error: $ref: '#/definitions/CloudError_2' description: Error while fetching the secrets. readOnly: true discriminator: jobSecretsType BatchPoolInfo: type: object description: Specifies how a Job should be assigned to a Pool. properties: poolId: type: string description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. autoPoolSpecification: $ref: '#/definitions/BatchAutoPoolSpecification' description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. AffinityInfo: type: object description: 'A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.' properties: affinityId: type: string description: An opaque string representing the location of a Compute Node or a Task that has run previously. You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. required: - affinityId JobHistoryDefinitionProperties: properties: startTime: type: string format: date-time readOnly: true description: Gets the start time for this job. endTime: type: string format: date-time readOnly: true description: Gets the end time for this job. expectedExecutionTime: type: string format: date-time readOnly: true description: Gets the expected execution time for this job. actionName: type: string readOnly: true description: Gets the job history action name. enum: - MainAction - ErrorAction x-ms-enum: name: JobHistoryActionName modelAsString: false status: $ref: '#/definitions/JobExecutionStatus' readOnly: true description: Gets the job history status. message: type: string readOnly: true description: Gets the message for the job history. retryCount: type: integer readOnly: true description: Gets the retry count for job. repeatCount: type: integer readOnly: true description: Gets the repeat count for the job. RetryPolicy: properties: retryType: type: string description: Gets or sets the retry strategy to be used. enum: - None - Fixed x-ms-enum: name: RetryType modelAsString: false retryInterval: type: string format: duration description: Gets or sets the retry interval between retries, specify duration in ISO 8601 format. retryCount: type: integer description: Gets or sets the number of times a retry should be attempted. BlobFilterDetails: description: Filter details to transfer Azure Blobs type: object properties: blobPrefixList: description: Prefix list of the Azure blobs to be transferred. type: array items: type: string blobPathList: description: List of full path of the blobs to be transferred. type: array items: type: string containerList: description: List of blob containers to be transferred. type: array items: type: string ElevationLevel: type: string description: ElevationLevel enums enum: - nonadmin - admin x-ms-enum: name: ElevationLevel modelAsString: true values: - name: NonAdmin value: nonadmin description: The user is a standard user without elevated access. - name: Admin value: admin description: The user is a user with elevated access and operates with full Administrator permissions. BatchNodeInfo: type: object description: Information about the Compute Node on which a Task ran. properties: affinityId: type: string description: An identifier for the Node on which the Task ran, which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. nodeUrl: type: string description: The URL of the Compute Node on which the Task ran. poolId: type: string description: The ID of the Pool on which the Task ran. nodeId: type: string description: The ID of the Compute Node on which the Task ran. taskRootDirectory: type: string description: The root directory of the Task on the Compute Node. taskRootDirectoryUrl: type: string description: The URL to the root directory of the Task on the Compute Node. BatchNodeFile: type: object description: Information about a file or directory on a Compute Node. properties: name: type: string description: The file path. url: type: string description: The URL of the file. isDirectory: type: boolean description: Whether the object represents a directory. properties: $ref: '#/definitions/FileProperties' description: The file properties. StorageAccountType: type: string description: StorageAccountType enums enum: - standard_lrs - premium_lrs - standardssd_lrs x-ms-enum: name: StorageAccountType modelAsString: true values: - name: StandardLRS value: standard_lrs description: The data disk should use standard locally redundant storage. - name: PremiumLRS value: premium_lrs description: The data disk should use premium locally redundant storage. - name: StandardSSDLRS value: standardssd_lrs description: The data disk / OS disk should use standard SSD locally redundant storage. BatchTaskConstraints: type: object description: Execution constraints to apply to a Task. properties: maxWallClockTime: type: string format: duration description: The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. If this is not specified, there is no time limit on how long the Task may run. retentionTime: type: string format: duration description: The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted. maxTaskRetryCount: type: integer format: int32 description: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries). ResourceFile: type: object description: A single file or multiple files to be downloaded to a Compute Node. properties: autoStorageContainerName: type: string description: The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. storageContainerUrl: type: string description: 'The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access.' httpUrl: type: string description: 'The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.' blobPrefix: type: string description: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. filePath: type: string description: The location on the Compute Node to which to download the file(s), relative to the Task's working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). fileMode: type: string description: The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. identityReference: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ExitOptions: type: object description: Specifies how the Batch service responds to a particular exit condition. properties: jobAction: $ref: '#/definitions/BatchJobAction' description: An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'. The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). dependencyAction: $ref: '#/definitions/DependencyAction' description: An action that the Batch service performs on Tasks that depend on this Task. Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks. DmsBaseObject: description: Base class for all objects under DataManager Service type: object properties: name: description: Name of the object. type: string readOnly: true id: description: Id of the object. type: string readOnly: true type: description: Type of the object. type: string readOnly: true BatchJobTerminateContent: type: object description: Parameters for terminating an Azure Batch Job. properties: terminateReason: type: string description: The text you want to appear as the Job's TerminationReason. The default is 'UserTerminate'. x-ms-client-name: terminationReason BatchJobNetworkConfiguration: type: object description: The network configuration for the Job. properties: subnetId: type: string description: 'The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. This will only work with a VirtualMachineConfiguration Pool. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The ''MicrosoftAzureBatch'' service principal must have the ''Classic Virtual Machine Contributor'' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.' required: - subnetId UefiSettings: type: object description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. properties: secureBootEnabled: type: boolean description: Specifies whether secure boot should be enabled on the virtual machine. vTpmEnabled: type: boolean description: Specifies whether vTPM should be enabled on the virtual machine. BatchJobExecutionInfo: type: object description: Contains information about the execution of a Job in the Azure Batch service. properties: startTime: type: string format: date-time description: The start time of the Job. This is the time at which the Job was created. endTime: type: string format: date-time description: The completion time of the Job. This property is set only if the Job is in the completed state. poolId: type: string description: The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool. schedulingError: $ref: '#/definitions/BatchJobSchedulingError' description: Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job. terminateReason: type: string description: 'A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job''s onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job''s onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the ''Terminate a Job'' operation.' x-ms-client-name: terminationReason required: - startTime JobErrorAction: properties: type: type: string description: Gets or sets the job error action type. enum: - Http - Https - StorageQueue - ServiceBusQueue - ServiceBusTopic x-ms-enum: name: JobActionType modelAsString: false request: $ref: '#/definitions/HttpRequest' description: Gets or sets the http requests. queueMessage: $ref: '#/definitions/StorageQueueMessage' description: Gets or sets the storage queue message. serviceBusQueueMessage: $ref: '#/definitions/ServiceBusQueueMessage' description: Gets or sets the service bus queue message. serviceBusTopicMessage: $ref: '#/definitions/ServiceBusTopicMessage' description: Gets or sets the service bus topic message. retryPolicy: $ref: '#/definitions/RetryPolicy' description: Gets or sets the retry policy. LinuxUserConfiguration_2: properties: uid: type: integer format: int32 title: The user ID of the user Account. description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. gid: type: integer format: int32 title: The group ID for the user Account. description: The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. sshPrivateKey: type: string title: The SSH private key for the user Account. description: The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). title: Properties used to create a user Account on a Linux Compute Node. ErrorDetails_2: description: Error Details type: object properties: errorMessage: description: Error message. type: string errorCode: format: int32 description: Error code. type: integer recommendedAction: description: Recommended action for the error. type: string exceptionMessage: description: Contains the non localized exception message type: string OutputFile: type: object description: On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure. properties: filePattern: type: string description: 'A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\*.txt matches any file that does not start in ''.'' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied.' destination: $ref: '#/definitions/OutputFileDestination' description: The destination for the output file(s). uploadOptions: $ref: '#/definitions/OutputFileUploadConfig' description: Additional options for the upload operation, including under what conditions to perform the upload. required: - filePattern - destination - uploadOptions ShipmentPickUpRequest: description: Shipment pick up request details. required: - startTime - endTime - shipmentLocation type: object properties: startTime: format: date-time description: Minimum date after which the pick up should commence, this must be in local time of pick up area. type: string endTime: format: date-time description: Maximum date before which the pick up should commence, this must be in local time of pick up area. type: string shipmentLocation: description: Shipment Location in the pickup place. Eg.front desk type: string OnTaskFailure: type: string title: The action the Batch service should take when any Task in the Job fails. description: A Task is considered to 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. enum: - noaction - performexitoptionsjobaction x-ms-enum: name: OnTaskFailure modelAsString: false values: - value: noaction description: Do nothing. The Job remains active unless terminated or disabled by some other means. name: noAction - value: performexitoptionsjobaction description: Take the action associated with the Task exit condition in the Task's exitConditions collection. (This may still result in no action being taken, if that is what the Task specifies.) name: performExitOptionsJobAction BatchJobPreparationTaskState: type: string description: BatchJobPreparationTaskState enums enum: - running - completed x-ms-enum: name: BatchJobPreparationTaskState modelAsString: true values: - name: Running value: running description: The Task is currently running (including retrying). - name: Completed value: completed description: The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures). BatchPoolEndpointConfigurationUpdate: type: object description: The endpoint configuration for a Pool. properties: inboundNATPools: type: array description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. items: $ref: '#/definitions/InboundNATPool' x-ms-client-name: inboundNatPools x-ms-identifiers: [] UserAssignedProperties: description: User assigned identity properties. type: object properties: resourceId: description: Arm resource id for user assigned identity to be used to fetch MSI token. type: string JobResourceUpdateParameter: description: The JobResourceUpdateParameter. type: object properties: properties: $ref: '#/definitions/UpdateJobProperties' description: Properties of a job to be updated. x-ms-client-flatten: true tags: description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). type: object additionalProperties: type: string identity: $ref: '#/definitions/ResourceIdentity' description: Msi identity of the resource Job_3: description: Data service job. required: - status - startTime - properties type: object allOf: - $ref: '#/definitions/DmsBaseObject' properties: status: description: Status of the job. enum: - None - InProgress - Succeeded - WaitingForAction - Failed - Cancelled - Cancelling type: string x-ms-enum: name: JobStatus modelAsString: false startTime: format: date-time description: Time at which the job was started in UTC ISO 8601 format. type: string endTime: format: date-time description: Time at which the job ended in UTC ISO 8601 format. type: string properties: $ref: '#/definitions/JobProperties_3' description: Job properties. x-ms-client-flatten: true error: $ref: '#/definitions/Error_2' description: Top level error for the job. OutputFileBlobContainerDestination: type: object description: Specifies a file upload destination within an Azure blob storage container. properties: path: type: string description: The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name. containerUrl: type: string description: The URL of the container within Azure Blob Storage to which to upload the file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. identityReference: $ref: '#/definitions/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container. uploadHeaders: type: array description: 'A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types.' items: $ref: '#/definitions/HttpHeader' x-ms-identifiers: [] required: - containerUrl BatchTaskContainerSettingsUpdate: type: object description: The container settings for a Task. properties: containerRunOptions: type: string description: Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string description: The Image to use to create the container in which the Task will run. 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. registry: $ref: '#/definitions/ContainerRegistry' description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. workingDirectory: $ref: '#/definitions/ContainerWorkingDirectory' description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ContainerType: type: string description: ContainerType enums enum: - dockerCompatible - criCompatible x-ms-enum: name: ContainerType modelAsString: true values: - name: DockerCompatible value: dockerCompatible description: A Docker compatible container technology will be used to launch the containers. - name: CriCompatible value: criCompatible description: A CRI based technology will be used to launch the containers. SecurityProfile: type: object description: Specifies the security profile settings for the virtual machine or virtual machine scale set. properties: encryptionAtHost: type: boolean description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. securityType: $ref: '#/definitions/SecurityTypes' description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. uefiSettings: $ref: '#/definitions/UefiSettings' description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. required: - encryptionAtHost - securityType - uefiSettings NetworkSecurityGroupRule: type: object description: A network security group rule to apply to an inbound endpoint. properties: priority: type: integer format: int32 description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. access: $ref: '#/definitions/NetworkSecurityGroupRuleAccess' description: The action that should be taken for a specified IP address, subnet range or tag. sourceAddressPrefix: type: string description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. sourcePortRanges: type: array description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. items: type: string required: - priority - access - sourceAddressPrefix MetadataItem_2: properties: name: type: string title: The name of the metadata item. value: type: string title: The value of the metadata item. required: - name - value title: A name-value pair associated with a Batch service resource. description: The Batch service does not assign any meaning to this metadata; it is solely for the use of user code. OutputFileDestination_2: properties: container: title: A location in Azure blob storage to which files are uploaded. $ref: '#/definitions/OutputFileBlobContainerDestination_2' title: The destination to which a file should be uploaded. JobDetails_2: description: Job details. type: object properties: jobStages: description: List of stages that ran in the job type: array items: $ref: '#/definitions/JobStages_2' jobDefinition: $ref: '#/definitions/JobDefinition' description: JobDefinition at the time of the run errorDetails: description: Error details for failure. This is optional. type: array items: $ref: '#/definitions/ErrorDetails_2' itemDetailsLink: description: Item Details Link to download files or see details type: string ErrorDetails: description: The detail information of the error. type: object properties: code: type: string description: Error code. message: type: string description: Error message details. requestId: type: string description: Correlation Id for current request. time: type: string format: date-time-rfc1123 description: The time that error request failed. required: - code - message DiskEncryptionTarget: type: string description: DiskEncryptionTarget enums enum: - osdisk - temporarydisk x-ms-enum: name: DiskEncryptionTarget modelAsString: true values: - name: OsDisk value: osdisk description: The OS Disk on the compute node is encrypted. - name: TemporaryDisk value: temporarydisk description: The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time. BatchTaskExecutionInfo: type: object description: Information about the execution of a Task. properties: startTime: type: string format: date-time description: The time at which the Task started running. 'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state. endTime: type: string format: date-time description: The time at which the Task completed. This property is set only if the Task is in the Completed state. exitCode: type: integer format: int32 description: The exit code of the program specified on the Task command line. This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/definitions/BatchTaskContainerExecutionInfo' description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/BatchTaskFailureInfo' description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 description: The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. lastRetryTime: type: string format: date-time description: The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. requeueCount: type: integer format: int32 description: The number of times the Task has been requeued by the Batch service as the result of a user request. When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons. lastRequeueTime: type: string format: date-time description: The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero. result: $ref: '#/definitions/BatchTaskExecutionResult' description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - retryCount - requeueCount BatchSubtaskState: type: string description: BatchSubtaskState enums enum: - preparing - running - completed x-ms-enum: name: BatchSubtaskState modelAsString: true values: - name: Preparing value: preparing description: The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. - name: Running value: running description: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing. - name: Completed value: completed description: The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated. ResourceIdentity: description: Msi identity details of the resource type: object properties: type: description: Identity type type: string default: None principalId: description: Service Principal Id backing the Msi type: string readOnly: true tenantId: description: Home Tenant Id type: string readOnly: true userAssignedIdentities: description: User Assigned Identities type: object additionalProperties: $ref: '#/definitions/UserAssignedIdentity' ImageReference_2: properties: publisher: type: string title: The publisher of the Azure Virtual Machines Marketplace Image. description: For example, Canonical or MicrosoftWindowsServer. offer: type: string title: The offer type of the Azure Virtual Machines Marketplace Image. description: For example, UbuntuServer or WindowsServer. sku: type: string title: The SKU of the Azure Virtual Machines Marketplace Image. description: For example, 18.04-LTS or 2019-Datacenter. version: type: string title: The version of the Azure Virtual Machines Marketplace Image. description: A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. virtualMachineImageId: type: string title: The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. description: This property is mutually exclusive with other ImageReference properties. The Shared Image Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. title: A reference to an Azure Virtual Machines Marketplace Image or a Shared Image Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation. AzureFileShareConfiguration_2: properties: accountName: type: string title: The Azure Storage account name. azureFileUrl: type: string title: The Azure Files URL. description: This is of the form 'https://{account}.file.core.windows.net/'. accountKey: type: string title: The Azure Storage account key. relativeMountPath: type: string title: The relative path on the compute node where the file system will be mounted description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string title: Additional command line options to pass to the mount command. description: These are 'net use' options in Windows and 'mount' options in Linux. required: - accountName - azureFileUrl - accountKey - relativeMountPath title: Information used to connect to an Azure Fileshare. ServiceBusBrokeredMessageProperties: properties: contentType: type: string description: Gets or sets the content type. correlationId: type: string description: Gets or sets the correlation ID. forcePersistence: type: boolean description: Gets or sets the force persistence. label: type: string description: Gets or sets the label. messageId: type: string description: Gets or sets the message ID. partitionKey: type: string description: Gets or sets the partition key. replyTo: type: string description: Gets or sets the reply to. replyToSessionId: type: string description: Gets or sets the reply to session ID. scheduledEnqueueTimeUtc: type: string format: date-time description: Gets or sets the scheduled enqueue time UTC. sessionId: type: string description: Gets or sets the session ID. timeToLive: type: string format: duration description: Gets or sets the time to live. to: type: string description: Gets or sets the to. viaPartitionKey: type: string description: Gets or sets the via partition key. NotificationPreference: description: Notification preference for a job stage. required: - stageName - sendNotification type: object properties: stageName: description: Name of the stage. enum: - DevicePrepared - Dispatched - Delivered - PickedUp - AtAzureDC - DataCopy - Created - ShippedToCustomer type: string x-ms-enum: name: NotificationStageName modelAsString: true values: - value: DevicePrepared description: Notification at device prepared stage. - value: Dispatched description: Notification at device dispatched stage. - value: Delivered description: Notification at device delivered stage. - value: PickedUp description: Notification at device picked up from user stage. - value: AtAzureDC description: Notification at device received at Azure datacenter stage. - value: DataCopy description: Notification at data copy started stage. - value: Created description: Notification at job created stage. - value: ShippedToCustomer description: Notification at shipped devices to customer stage. sendNotification: description: Notification is required or not. type: boolean default: true UserIdentity_2: properties: username: type: string x-ms-client-name: userName title: The name of the user identity under which the Task is run. description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. autoUser: $ref: '#/definitions/AutoUserSpecification_2' title: The auto user under which the Task is run. description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. title: The definition of the user identity under which the Task is run. description: Specify either the userName or autoUser property, but not both. BatchJobListResult: type: object description: The result of listing the Jobs in an Account. properties: value: type: array description: The list of Jobs. items: $ref: '#/definitions/BatchJob' odata.nextLink: type: string description: The URL to get the next set of results. JobDefinitionProperties: description: Job Definition required: - dataSourceId - dataSinkId - state type: object properties: dataSourceId: description: Data Source Id associated to the job definition. type: string dataSinkId: description: Data Sink Id associated to the job definition. type: string schedules: description: Schedule for running the job definition type: array items: $ref: '#/definitions/Schedule' state: description: State of the job definition. enum: - Disabled - Enabled - Supported type: string x-ms-enum: name: State modelAsString: false lastModifiedTime: format: date-time description: Last modified time of the job definition. type: string runLocation: description: This is the preferred geo location for the job to run. enum: - none - australiaeast - australiasoutheast - brazilsouth - canadacentral - canadaeast - centralindia - centralus - eastasia - eastus - eastus2 - japaneast - japanwest - koreacentral - koreasouth - southeastasia - southcentralus - southindia - northcentralus - northeurope - uksouth - ukwest - westcentralus - westeurope - westindia - westus - westus2 type: string x-ms-enum: name: RunLocation modelAsString: false userConfirmation: description: Enum to detect if user confirmation is required. If not passed will default to NotRequired. default: NotRequired enum: - NotRequired - Required type: string x-ms-enum: name: UserConfirmation modelAsString: false dataServiceInput: description: A generic json used differently by each data service type. type: object customerSecrets: description: List of customer secrets containing a key identifier and key value. The key identifier is a way for the specific data source to understand the key. Value contains customer secret encrypted by the encryptionKeys. type: array items: $ref: '#/definitions/CustomerSecret' PublicIpAddressConfiguration: type: object description: The public IP Address configuration of the networking configuration of a Pool. properties: provision: $ref: '#/definitions/IpAddressProvisioningType' description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. x-ms-client-name: IpAddressProvisioningType ipAddressIds: type: array description: 'The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.' items: type: string PackageShippingDetails: description: package shipping details type: object properties: trackingUrl: description: Url where shipment can be tracked. type: string readOnly: true carrierName: description: Name of the carrier. type: string readOnly: true trackingId: description: Tracking Id of shipment. type: string readOnly: true DiffDiskPlacement: type: string description: AccessDiffDiskPlacementScope enums enum: - cachedisk x-ms-enum: name: DiffDiskPlacement modelAsString: true values: - name: CacheDisk value: cachedisk description: The Ephemeral OS Disk is stored on the VM cache. BatchTaskCounts: type: object description: The Task counts for a Job. properties: active: type: integer format: int32 description: The number of Tasks in the active state. running: type: integer format: int32 description: The number of Tasks in the running or preparing state. completed: type: integer format: int32 description: The number of Tasks in the completed state. succeeded: type: integer format: int32 description: The number of Tasks which succeeded. A Task succeeds if its result (found in the executionInfo property) is 'success'. failed: type: integer format: int32 description: The number of Tasks which failed. A Task fails if its result (found in the executionInfo property) is 'failure'. required: - active - running - completed - succeeded - failed JobExecutionStatus: type: string description: Gets the job execution status. enum: - Completed - Failed - Postponed x-ms-enum: name: JobExecutionStatus modelAsString: false DatacenterAddressResponse: description: Datacenter address for given storage location. required: - datacenterAddressType type: object properties: datacenterAddressType: description: Data center address type enum: - DatacenterAddressLocation - DatacenterAddressInstruction type: string x-ms-enum: name: DatacenterAddressType modelAsExtensible: false values: - value: DatacenterAddressLocation description: Data center address location. - value: DatacenterAddressInstruction description: Data center address instruction. supportedCarriersForReturnShipment: description: List of supported carriers for return shipment. uniqueItems: false type: array items: type: string readOnly: true dataCenterAzureLocation: description: Azure Location where the Data Center serves primarily. type: string readOnly: true discriminator: datacenterAddressType ContainerConfiguration_2: properties: type: type: string title: The container technology to be used. enum: - dockerCompatible x-ms-enum: name: ContainerType modelAsString: false values: - value: dockerCompatible description: A Docker compatible container technology will be used to launch the containers. containerImageNames: type: array items: type: string title: The collection of container Image names. description: This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. containerRegistries: type: array items: $ref: '#/definitions/ContainerRegistry_2' title: Additional private registries from which containers can be pulled. description: If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. required: - type title: The configuration for container-enabled Pools. VMExtension: type: object description: The configuration for virtual machine extensions. properties: name: type: string description: The name of the virtual machine extension. publisher: type: string description: The name of the extension handler publisher. type: type: string description: The type of the extension. typeHandlerVersion: type: string description: The version of script handler. autoUpgradeMinorVersion: type: boolean description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. enableAutomaticUpgrade: type: boolean description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. settings: type: object description: JSON formatted public settings for the extension. additionalProperties: type: string protectedSettings: type: object description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. additionalProperties: type: string provisionAfterExtensions: type: array description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. items: type: string required: - name - publisher - type DisableBatchJobOption: type: string description: DisableBatchJobOption enums enum: - requeue - terminate - wait x-ms-enum: name: DisableBatchJobOption modelAsString: true values: - name: Requeue value: requeue description: Terminate running Tasks and requeue them. The Tasks will run again when the Job is enabled. - name: Terminate value: terminate description: Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. - name: Wait value: wait description: Allow currently running Tasks to complete. DataExportDetails: description: Details of the data to be used for exporting data from azure. required: - transferConfiguration - accountDetails type: object properties: transferConfiguration: $ref: '#/definitions/TransferConfiguration' description: Configuration for the data transfer. logCollectionLevel: description: Level of the logs to be collected. enum: - Error - Verbose type: string x-ms-enum: name: LogCollectionLevel modelAsExtensible: true values: - value: Error description: Only Errors will be collected in the logs. - value: Verbose description: Verbose logging (includes Errors, CRC, size information and others). default: Error accountDetails: $ref: '#/definitions/DataAccountDetails' description: Account details of the data to be transferred BatchTaskCreateContent: type: object description: Parameters for creating an Azure Batch Task. properties: id: type: string description: A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a Job that differ only by case). displayName: type: string description: A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. exitConditions: $ref: '#/definitions/ExitConditions' description: How the Batch service should respond when the Task completes. commandLine: type: string description: The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/BatchTaskContainerSettings' description: The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] outputFiles: type: array description: A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. items: $ref: '#/definitions/OutputFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the Task. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] affinityInfo: $ref: '#/definitions/AffinityInfo' description: A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. constraints: $ref: '#/definitions/BatchTaskConstraints' description: The execution constraints that apply to this Task. If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days. requiredSlots: type: integer format: int32 description: The number of scheduling slots that the Task required to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. multiInstanceSettings: $ref: '#/definitions/MultiInstanceSettings' description: An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task. dependsOn: $ref: '#/definitions/BatchTaskDependencies' description: The Tasks that this Task depends on. This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. If the Job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob. applicationPackageReferences: type: array description: A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails. items: $ref: '#/definitions/BatchApplicationPackageReference' x-ms-identifiers: [] authenticationTokenSettings: $ref: '#/definitions/AuthenticationTokenSettings' description: The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. required: - id - commandLine JobExecutionInformation: properties: startTime: type: string format: date-time title: The start time of the Job. description: This is the time at which the Job was created. endTime: type: string format: date-time title: The completion time of the Job. description: This property is set only if the Job is in the completed state. poolId: type: string title: The ID of the Pool to which this Job is assigned. description: This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool. schedulingError: $ref: '#/definitions/JobSchedulingError' title: Details of any error encountered by the service in starting the Job. description: This property is not set if there was no error starting the Job. terminateReason: type: string title: A string describing the reason the Job ended. description: 'This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job''s onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job''s onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the ''Terminate a Job'' operation.' required: - startTime title: Contains information about the execution of a Job in the Azure Batch service. CancellationReason: description: Reason for cancellation. required: - reason type: object properties: reason: description: Reason for cancellation. type: string NetworkSecurityGroupRule_2: properties: priority: type: integer format: int32 title: The priority for this rule. description: Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. access: type: string title: The action that should be taken for a specified IP address, subnet range or tag. enum: - allow - deny x-ms-enum: name: NetworkSecurityGroupRuleAccess modelAsString: false values: - value: allow description: Allow access. - value: deny description: Deny access. sourceAddressPrefix: type: string title: The source address prefix or tag to match for the rule. description: Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. sourcePortRanges: type: array items: type: string title: The source port ranges to match for the rule. description: Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. required: - priority - access - sourceAddressPrefix title: A network security group rule to apply to an inbound endpoint. OutputFileUploadOptions: properties: uploadCondition: title: The conditions under which the Task output file or set of files should be uploaded. description: The default is taskcompletion. $ref: '#/definitions/OutputFileUploadCondition_2' required: - uploadCondition title: Details about an output file upload operation, including under what conditions to perform the upload. ReverseShippingDetails: description: Reverse Shipping Address and contact details for a job. type: object properties: contactDetails: $ref: '#/definitions/ContactInfo' shippingAddress: $ref: '#/definitions/ShippingAddress' isUpdated: description: "A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared.\r\nRead only field" type: boolean readOnly: true NetworkSecurityGroupRuleAccess: type: string description: NetworkSecurityGroupRuleAccess enums enum: - allow - deny x-ms-enum: name: NetworkSecurityGroupRuleAccess modelAsString: true values: - name: Allow value: allow description: Allow access. - name: Deny value: deny description: Deny access. DataDisk_2: properties: lun: type: integer format: int32 title: The logical unit number. description: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. caching: $ref: '#/definitions/CachingType_2' title: The type of caching to be enabled for the data disks. description: 'The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.' diskSizeGB: type: integer format: int32 title: The initial disk size in gigabytes. storageAccountType: title: The storage Account type to be used for the data disk. description: If omitted, the default is "standard_lrs". $ref: '#/definitions/StorageAccountType_2' required: - lun - diskSizeGB title: Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them. MitigateJobRequest: description: The Mitigate Job captured from request body for Mitigate API type: object properties: customerResolutionCode: description: Resolution code for the job enum: - None - MoveToCleanUpDevice - Resume - Restart - ReachOutToOperation type: string x-ms-enum: name: CustomerResolutionCode modelAsExtensible: true values: - value: None description: No Resolution Yet - value: MoveToCleanUpDevice description: Clean the device - value: Resume description: Resume the job to same stage - description: Restart whole action. value: Restart - description: Reach out to operation for further action. value: ReachOutToOperation serialNumberCustomerResolutionMap: description: Serial number and the customer resolution code corresponding to each serial number type: object additionalProperties: format: int32 description: Available customer resolution codes on a job enum: - None - MoveToCleanUpDevice - Resume - Restart - ReachOutToOperation type: string x-ms-enum: name: CustomerResolutionCode modelAsExtensible: true values: - value: None description: No Resolution Yet - value: MoveToCleanUpDevice description: Clean the device - value: Resume description: Resume the job - value: Restart description: Restart whole action - value: ReachOutToOperation description: Reach out to operation for further action EnvironmentSetting: type: object description: An environment variable to be set on a Task process. properties: name: type: string description: The name of the environment variable. value: type: string description: The value of the environment variable. required: - name JobRecurrence: properties: frequency: type: string description: Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). enum: - Minute - Hour - Day - Week - Month x-ms-enum: name: RecurrenceFrequency modelAsString: false interval: type: integer description: Gets or sets the interval between retries. count: type: integer description: Gets or sets the maximum number of times that the job should run. endTime: type: string format: date-time description: Gets or sets the time at which the job will complete. schedule: $ref: '#/definitions/JobRecurrenceSchedule' BatchCertificateReference: type: object description: 'A reference to a Certificate to be installed on Compute Nodes in a Pool. Warning: This object 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.' properties: thumbprint: type: string description: The thumbprint of the Certificate. thumbprintAlgorithm: type: string description: The algorithm with which the thumbprint is associated. This must be sha1. storeLocation: $ref: '#/definitions/BatchCertificateStoreLocation' description: The location of the Certificate store on the Compute Node into which to install the Certificate. The default value is currentuser. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). 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. storeName: type: string description: 'The name of the Certificate store on the Compute Node into which to install the Certificate. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.' visibility: type: array description: Which user Accounts on the Compute Node should have access to the private data of the Certificate. You can specify more than one visibility in this collection. The default is all Accounts. items: $ref: '#/definitions/BatchCertificateVisibility' required: - thumbprint - thumbprintAlgorithm BatchErrorMessage: type: object description: An error message received in an Azure Batch error response. properties: lang: type: string description: The language code of the error message. value: type: string description: The text of the message. AzureBlobFileSystemConfiguration_2: properties: accountName: type: string title: The Azure Storage Account name. containerName: type: string title: The Azure Blob Storage Container name. accountKey: type: string title: The Azure Storage Account key. description: This property is mutually exclusive with sasKey and one must be specified. sasKey: type: string title: The Azure Storage SAS token. description: This property is mutually exclusive with accountKey and one must be specified. blobfuseOptions: type: string title: Additional command line options to pass to the mount command. description: These are 'net use' options in Windows and 'mount' options in Linux. relativeMountPath: type: string title: The relative path on the compute node where the file system will be mounted description: All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. required: - accountName - containerName - relativeMountPath title: Information used to connect to an Azure Storage Container using Blobfuse. BatchJobCreateContent: type: object description: Parameters for creating an Azure Batch Job. properties: id: type: string description: A string that uniquely identifies the Job within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). displayName: type: string description: The display name for the Job. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. usesTaskDependencies: type: boolean description: Whether Tasks in the Job can define dependencies on each other. The default is false. priority: type: integer format: int32 description: The priority of the Job. 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. allowTaskPreemption: type: boolean description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. maxParallelTasks: type: integer format: int32 description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. default: -1 constraints: $ref: '#/definitions/BatchJobConstraints' description: The execution constraints for the Job. jobManagerTask: $ref: '#/definitions/BatchJobManagerTask' description: Details of a Job Manager Task to be launched when the Job is started. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job. 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. The Job Manager Task's typical purpose is to control and/or monitor Job execution, for example by deciding what additional Tasks to run, determining when the work is complete, etc. (However, a Job Manager Task is not restricted to these activities - it is a fully-fledged Task in the system and perform whatever actions are required for the Job.) For example, a Job Manager Task might download a file specified as a parameter, analyze the contents of that file and submit additional Tasks based on those contents. jobPreparationTask: $ref: '#/definitions/BatchJobPreparationTask' description: The Job Preparation Task. 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. jobReleaseTask: $ref: '#/definitions/BatchJobReleaseTask' description: The Job Release Task. 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 Nodes that have run the Job Preparation Task. The primary purpose of the Job Release Task is to undo changes to Compute 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. commonEnvironmentSettings: type: array description: The list of common environment variable settings. These environment variables are set for all Tasks in the Job (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. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] poolInfo: $ref: '#/definitions/BatchPoolInfo' description: The Pool on which the Batch service runs the Job's Tasks. onAllTasksComplete: $ref: '#/definitions/OnAllBatchTasksComplete' description: The action the Batch service should take when all Tasks in the Job 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. onTaskFailure: $ref: '#/definitions/OnBatchTaskFailure' description: The action the Batch service should take when any Task in the Job fails. A Task is considered to 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. networkConfiguration: $ref: '#/definitions/BatchJobNetworkConfiguration' description: The network configuration for the Job. metadata: type: array description: A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/definitions/MetadataItem' x-ms-identifiers: [] required: - id - poolInfo JobBatch: description: The job batch definition. type: object properties: type: description: Whether batching is done on a specified number of devices or a percentage of the total devices. type: string enum: - number - percentage x-ms-enum: name: JobBatchType modelAsString: false values: - value: number name: Number description: Job Batching based on number of devices. - value: percentage name: Percentage description: Job Batching based percentage of total applied devices. value: description: The number or percentage of devices on which batching is done. type: number required: - type - value ExitCodeRangeMapping: type: object description: 'A range of exit codes and how the Batch service should respond to exit codes within that range.' properties: start: type: integer format: int32 description: The first exit code in the range. end: type: integer format: int32 description: The last exit code in the range. exitOptions: $ref: '#/definitions/ExitOptions' description: How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive). required: - start - end - exitOptions BatchJobState: type: string description: BatchJobState enums enum: - active - disabling - disabled - enabling - terminating - completed - deleting x-ms-enum: name: BatchJobState modelAsString: true values: - name: Active value: active description: The Job is available to have Tasks scheduled. - name: Disabling value: disabling description: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). - name: Disabled value: disabled description: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. - name: Enabling value: enabling description: A user has requested that the Job be enabled, but the enable operation is still in progress. - name: Terminating value: terminating description: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). - name: Completed value: completed description: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. - name: Deleting value: deleting description: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). NameValuePair: type: object description: Represents a name-value pair. properties: name: type: string description: The name in the name-value pair. value: type: string description: The value in the name-value pair. ApiError: required: - error type: object properties: error: $ref: '#/definitions/ErrorDetail' NfsMountConfiguration: type: object description: Information used to connect to an NFS file system. properties: source: type: string description: The URI of the file system to mount. relativeMountPath: type: string description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. mountOptions: type: string description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. required: - source - relativeMountPath BatchTask: type: object description: 'Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.' properties: id: type: string description: A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. readOnly: true displayName: type: string description: A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. readOnly: true url: type: string description: The URL of the Task. readOnly: true eTag: type: string description: The ETag of the Task. This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime. readOnly: true lastModified: type: string format: date-time description: The last modified time of the Task. readOnly: true creationTime: type: string format: date-time description: The creation time of the Task. readOnly: true exitConditions: $ref: '#/definitions/ExitConditions' description: How the Batch service should respond when the Task completes. readOnly: true state: $ref: '#/definitions/BatchTaskState' description: The current state of the Task. readOnly: true stateTransitionTime: type: string format: date-time description: The time at which the Task entered its current state. readOnly: true previousState: $ref: '#/definitions/BatchTaskState' description: The previous state of the Task. This property is not set if the Task is in its initial Active state. readOnly: true previousStateTransitionTime: type: string format: date-time description: The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state. readOnly: true commandLine: type: string description: The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). readOnly: true containerSettings: $ref: '#/definitions/BatchTaskContainerSettings' description: The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. readOnly: true resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. items: $ref: '#/definitions/ResourceFile' readOnly: true x-ms-identifiers: [] outputFiles: type: array description: A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. items: $ref: '#/definitions/OutputFile' readOnly: true x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the Task. items: $ref: '#/definitions/EnvironmentSetting' readOnly: true x-ms-identifiers: [] affinityInfo: $ref: '#/definitions/AffinityInfo' description: A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. readOnly: true constraints: $ref: '#/definitions/BatchTaskConstraints' description: The execution constraints that apply to this Task. requiredSlots: type: integer format: int32 description: The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. readOnly: true userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. readOnly: true executionInfo: $ref: '#/definitions/BatchTaskExecutionInfo' description: Information about the execution of the Task. readOnly: true nodeInfo: $ref: '#/definitions/BatchNodeInfo' description: Information about the Compute Node on which the Task ran. readOnly: true multiInstanceSettings: $ref: '#/definitions/MultiInstanceSettings' description: An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task. readOnly: true stats: $ref: '#/definitions/BatchTaskStatistics' description: Resource usage statistics for the Task. readOnly: true dependsOn: $ref: '#/definitions/BatchTaskDependencies' description: The Tasks that this Task depends on. This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. readOnly: true applicationPackageReferences: type: array description: A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails. items: $ref: '#/definitions/BatchApplicationPackageReference' readOnly: true x-ms-identifiers: [] authenticationTokenSettings: $ref: '#/definitions/AuthenticationTokenSettings' description: The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. readOnly: true BatchTaskState: type: string description: BatchTaskState enums enum: - active - preparing - running - completed x-ms-enum: name: BatchTaskState modelAsString: true values: - name: Active value: active description: The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run. - name: Preparing value: preparing description: The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. - name: Running value: running description: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing. - name: Completed value: completed description: The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated. BatchTaskIdRange: type: object description: 'The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks ''9'', ''10'', ''11'' and ''12''.' properties: start: type: integer format: int32 description: The first Task ID in the range. end: type: integer format: int32 description: The last Task ID in the range. required: - start - end Sku: description: The Sku. required: - name type: object properties: name: description: The sku name. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk type: string x-ms-enum: name: SkuName modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk. displayName: description: The display name of the sku. type: string family: description: The sku family. type: string model: description: The display name of the sku. enum: - DataBox - DataBoxDisk - DataBoxHeavy - DataBoxCustomerDisk - DataBoxV2x100 - DataBoxV2x500 type: string x-ms-enum: name: ModelNames modelAsExtensible: true values: - value: DataBox description: Data Box. - value: DataBoxDisk description: Data Box Disk. - value: DataBoxHeavy description: Data Box Heavy. - value: DataBoxCustomerDisk description: Data Box Customer Disk - value: DataBoxV2x100 description: Data Box V2 100TB. - value: DataBoxV2x500 description: Data Box V2 500TB. ContainerRegistry_2: properties: registryServer: type: string title: The registry URL. description: If omitted, the default is "docker.io". username: type: string x-ms-client-name: userName title: The user name to log into the registry server. password: type: string title: The password to log into the registry server. required: - username - password title: A private container registry. OutputFileUploadCondition: type: string description: OutputFileUploadCondition enums enum: - tasksuccess - taskfailure - taskcompletion x-ms-enum: name: OutputFileUploadCondition modelAsString: true values: - name: TaskSuccess value: tasksuccess description: Upload the file(s) only after the Task process exits with an exit code of 0. - name: TaskFailure value: taskfailure description: Upload the file(s) only after the Task process exits with a nonzero exit code. - name: TaskCompletion value: taskcompletion description: Upload the file(s) after the Task process exits, no matter what the exit code was. JobDeliveryInfo: description: Additional delivery info. type: object properties: scheduledDateTime: format: date-time description: Scheduled date time. type: string BatchTaskSchedulingPolicyUpdate: type: object description: Specifies how Tasks should be distributed across Compute Nodes. properties: nodeFillType: $ref: '#/definitions/BatchNodeFillType' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. OnBatchTaskFailure: type: string description: OnTaskFailure enums enum: - noaction - performexitoptionsjobaction x-ms-enum: name: OnBatchTaskFailure modelAsString: true values: - name: NoAction value: noaction description: Do nothing. The Job remains active unless terminated or disabled by some other means. - name: PerformExitOptionsJobAction value: performexitoptionsjobaction description: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. OutputFileBlobContainerDestination_2: properties: path: type: string title: The destination blob or virtual directory within the Azure Storage container. description: If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name. containerUrl: type: string title: The URL of the container within Azure Blob Storage to which to upload the file(s). description: The URL must include a Shared Access Signature (SAS) granting write permissions to the container. required: - containerUrl title: Specifies a file upload destination within an Azure blob storage container. JobErrorItem_2: description: The job error items. required: - code - message type: object properties: recommendations: description: The recommended actions. type: array items: type: string code: description: The error code intended for programmatic access. type: string message: description: The error message intended to describe the error in detail. type: string BatchJobReleaseTask: type: object description: 'A Job Release Task to run on Job completion on any Compute Node where the Job has run. The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job''s maximum wall clock time constraint is reached, and the Job is still active, or the Job''s Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool.' properties: id: type: string description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). commandLine: type: string description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/BatchTaskContainerSettings' description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array description: A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory. items: $ref: '#/definitions/ResourceFile' x-ms-identifiers: [] environmentSettings: type: array description: A list of environment variable settings for the Job Release Task. items: $ref: '#/definitions/EnvironmentSetting' x-ms-identifiers: [] maxWallClockTime: type: string format: duration description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). retentionTime: type: string format: duration description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted. userIdentity: $ref: '#/definitions/UserIdentity' description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. required: - commandLine AuthenticationTokenSettings: type: object description: 'The settings for an authentication token that the Task can use to perform Batch service operations.' properties: access: type: array description: The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task. items: $ref: '#/definitions/AccessScope' OnAllBatchTasksComplete: type: string description: The action the Batch service should take when all Tasks in the Job are in the completed state. enum: - noaction - terminatejob x-ms-enum: name: OnAllBatchTasksComplete modelAsString: true values: - name: NoAction value: noaction description: Do nothing. The Job remains active unless terminated or disabled by some other means. - name: TerminateJob value: terminatejob description: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. InboundNATPool: type: object description: 'A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.' properties: name: type: string description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. protocol: $ref: '#/definitions/InboundEndpointProtocol' description: The protocol of the endpoint. backendPort: type: integer format: int32 description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. frontendPortRangeStart: type: integer format: int32 description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. frontendPortRangeEnd: type: integer format: int32 description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. networkSecurityGroupRules: type: array description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. items: $ref: '#/definitions/NetworkSecurityGroupRule' x-ms-identifiers: [] required: - name - protocol - backendPort - frontendPortRangeStart - frontendPortRangeEnd UserAssignedIdentity: description: Class defining User assigned identity details. type: object properties: principalId: description: The principal id of user assigned identity. type: string readOnly: true clientId: description: The client id of user assigned identity. type: string readOnly: true BatchApplicationPackageReference: type: object description: A reference to an Package to be deployed to Compute Nodes. properties: applicationId: type: string description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). version: type: string description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. required: - applicationId UpdateDownloadProgress: description: Details about the download progress of update. type: object properties: downloadPhase: description: The download phase. enum: - Unknown - Initializing - Downloading - Verifying type: string readOnly: true x-ms-enum: name: DownloadPhase modelAsString: true percentComplete: format: int32 description: Percentage of completion. type: integer readOnly: true totalBytesToDownload: format: double description: Total bytes to download. type: number readOnly: true totalBytesDownloaded: format: double description: Total bytes downloaded. type: number readOnly: true numberOfUpdatesToDownload: format: int32 description: Number of updates to download. type: integer readOnly: true numberOfUpdatesDownloaded: format: int32 description: Number of updates downloaded. type: integer readOnly: true AutomaticOsUpgradePolicy: type: object description: The configuration parameters used for performing automatic OS upgrade. properties: disableAutomaticRollback: type: boolean description: Whether OS image rollback feature should be disabled. enableAutomaticOsUpgrade: type: boolean description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. x-ms-client-name: enableAutomaticOSUpgrade useRollingUpgradePolicy: type: boolean description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. osRollingUpgradeDeferral: type: boolean description: Defer OS upgrades on the TVMs if they are running tasks. OutputFileUploadConfig: type: object description: 'Options for an output file upload operation, including under what conditions to perform the upload.' properties: uploadCondition: $ref: '#/definitions/OutputFileUploadCondition' description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. required: - uploadCondition BatchPoolLifetimeOption: type: string description: BatchPoolLifetimeOption enums enum: - jobschedule - job x-ms-enum: name: BatchPoolLifetimeOption modelAsString: true values: - name: JobSchedule value: jobschedule description: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. - name: Job value: job description: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. PoolEndpointConfiguration: properties: inboundNATPools: type: array items: $ref: '#/definitions/InboundNATPool_2' title: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. description: The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. required: - inboundNATPools title: The endpoint configuration for a Pool. BatchAutoPoolSpecificationUpdate: type: object description: 'Specifies characteristics for a temporary ''auto pool''. The Batch service will create this auto Pool when the Job is submitted.' properties: autoPoolIdPrefix: type: string description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. poolLifetimeOption: $ref: '#/definitions/BatchPoolLifetimeOption' description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. keepAlive: type: boolean description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. pool: $ref: '#/definitions/BatchPoolSpecificationUpdate' description: The Pool specification for the auto Pool. InboundEndpointProtocol: type: string description: InboundEndpointProtocol enums enum: - tcp - udp x-ms-enum: name: InboundEndpointProtocol modelAsString: true values: - name: Tcp value: tcp description: Use TCP for the endpoint. - name: Udp value: udp description: Use UDP for the endpoint. JobProperties_4: properties: startTime: type: string format: date-time description: Gets or sets the job start time. action: $ref: '#/definitions/JobAction' description: Gets or sets the job action. recurrence: $ref: '#/definitions/JobRecurrence' description: Gets or sets the job recurrence. state: $ref: '#/definitions/JobState_2' description: Gets or set the job state. status: $ref: '#/definitions/JobStatus' readOnly: true description: Gets the job status. JobDeviceStatusCollection: description: The paged results of job device statuses. type: object properties: value: description: The collection of job device statuses. type: array items: $ref: '#/definitions/JobDeviceStatus' nextLink: description: URL to get the next page of job device statuses. type: string required: - value BatchJobAction: type: string description: BatchJobAction enums enum: - none - disable - terminate x-ms-enum: name: BatchJobAction modelAsString: true values: - name: None value: none description: Take no action. - name: Disable value: disable description: Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks value of requeue. - name: Terminate value: terminate description: Terminate the Job. The terminationReason in the Job's executionInfo is set to "TaskFailed". AzureFileFilterDetails: description: Filter details to transfer Azure files type: object properties: filePrefixList: description: Prefix list of the Azure files to be transferred. type: array items: type: string filePathList: description: List of full path of the files to be transferred. type: array items: type: string fileShareList: description: List of file shares to be transferred. type: array items: type: string TaskConstraints: properties: maxWallClockTime: type: string format: duration title: The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. description: If this is not specified, there is no time limit on how long the Task may run. retentionTime: type: string format: duration title: The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. description: The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted. maxTaskRetryCount: type: integer format: int32 title: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. description: Note that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit. title: Execution constraints to apply to a Task. IPAddressProvisioningType: type: string title: The provisioning type for Public IP Addresses for the Pool. enum: - batchmanaged - usermanaged - nopublicipaddresses x-ms-enum: name: IPAddressProvisioningType modelAsString: false values: - value: batchmanaged description: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. name: batchManaged - value: usermanaged description: Public IPs are provided by the user and will be used to provision the Compute Nodes. name: userManaged - value: nopublicipaddresses description: No public IP Address will be created. name: noPublicIPAddresses parameters: apiVersionParameter_2: name: api-version in: query description: The API Version required: true type: string ApiVersion: name: api-version in: query description: Client Api Version. required: true type: string resourceGroupNameParameter: name: resourceGroupName in: path description: The resource group name. required: true type: string x-ms-parameter-location: method SubscriptionId: name: subscriptionId in: path description: The subscription Id. required: true type: string subscriptionIdParameter: name: subscriptionId in: path description: The subscription ID. required: true type: string ApiVersionParameter: name: api-version in: query required: true type: string description: Client API Version. apiVersionParameter_4: name: api-version in: query description: The api version required: true type: string x-ms-skip-url-encoding: true jobNameParameter: name: jobName in: path description: The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only required: true type: string maxLength: 24 minLength: 3 pattern: ^[-\w\.]+$ x-ms-parameter-location: method resourceGroupNameParameter_2: name: resourceGroupName in: path description: The Resource Group Name required: true type: string x-ms-parameter-location: method Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion subscriptionIdParameter_4: name: subscriptionId in: path description: The subscription id required: true type: string x-ms-skip-url-encoding: true deviceNameParameter: name: deviceName in: path description: The device name required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: true apiVersion: name: api-version description: The API version. in: query required: true type: string dataManagerNameParameter: name: dataManagerName in: path description: The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only required: true type: string maxLength: 24 minLength: 3 pattern: ^[-\w\.]+$ x-ms-parameter-location: method managerNameParameter: name: managerName in: path description: The manager name required: true type: string maxLength: 50 minLength: 2 x-ms-parameter-location: method x-ms-skip-url-encoding: true apiVersionParameter_3: name: api-version in: query description: The API Version required: true type: string resourceGroupNameParameter_3: name: resourceGroupName in: path description: The Resource Group Name required: true type: string x-ms-parameter-location: method Version: in: query name: api-version description: The version of the API being called. x-ms-parameter-location: client type: string required: true subscriptionIdParameter_2: name: subscriptionId in: path description: The Subscription Id required: true type: string VaultName: name: vaultName in: path description: The name of the recovery services vault. required: true type: string x-ms-parameter-location: method subscriptionId: name: subscriptionId description: The subscription id. in: path required: true type: string resourceGroupNameParameter_4: name: resourceGroupName in: path description: The resource group name required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: true ResourceGroupName: name: resourceGroupName in: path description: The name of the resource group where the recovery services vault is present. required: true type: string x-ms-parameter-location: method subscriptionIdParameter_3: name: subscriptionId in: path description: The Subscription Id required: true type: string JobId: in: path name: jobId description: Unique ID of the job. x-ms-parameter-location: method type: string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$ required: true apiVersionParameter: name: api-version in: query description: The API version. required: true type: string x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'