openapi: 3.2.0 info: title: Azure Batch Job Schedules API version: '2025-06-01' description: Azure Batch provides Cloud-scale job scheduling and compute management. x-typespec-generated: - emitter: '@azure-tools/typespec-autorest' security: - OAuth2Auth: - https://batch.core.windows.net//.default tags: - name: Job Schedules paths: /jobschedules: get: operationId: JobSchedules_ListJobSchedules tags: - Job Schedules summary: Lists all of the Job Schedules in the specified Account description: Lists all of the Job Schedules in the specified Account. parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 schema: type: integer format: int32 default: 1000 maximum: 1000 minimum: 1 - name: $filter in: query description: 'An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.' required: false schema: type: string - name: $select in: query description: An OData $select clause. required: false style: form explode: false schema: type: array items: type: string - name: $expand in: query description: An OData $expand clause. required: false style: form explode: false schema: type: array items: type: string responses: '200': description: The request has succeeded. headers: 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJobScheduleListResult' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule list: $ref: ./examples/JobSchedules_ListJobSchedules.json x-ms-pageable: nextLinkName: odata.nextLink post: operationId: JobSchedules_CreateJobSchedule tags: - Job Schedules summary: Creates a Job Schedule to the specified Account description: Creates a Job Schedule to the specified Account. parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 responses: '201': description: The request has succeeded and a new resource has been created as a result. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Creates a basic JobSchedule: $ref: ./examples/JobSchedules_CreateJobSchedule_Basic.json Creates a complex JobScheduleAdd: $ref: ./examples/JobSchedules_CreateJobSchedule_Complex.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchJobScheduleCreateOptions' description: The Job Schedule to be created. required: true /jobschedules/{jobScheduleId}: get: operationId: JobSchedules_GetJobSchedule tags: - Job Schedules description: Gets information about the specified Job Schedule. parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule to get. required: true schema: type: string - name: $select in: query description: An OData $select clause. required: false style: form explode: false schema: type: array items: type: string - name: $expand in: query description: An OData $expand clause. required: false style: form explode: false schema: type: array items: type: string responses: '200': description: The request has succeeded. headers: 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJobSchedule' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule get: $ref: ./examples/JobSchedules_GetJobSchedule.json summary: Job schedules get job schedule x-summary-source: derived put: operationId: JobSchedules_ReplaceJobSchedule tags: - Job Schedules summary: Updates the properties of the specified Job Schedule description: 'This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.' parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule to update. required: true schema: type: string responses: '200': description: The request has succeeded. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule patch: $ref: ./examples/JobSchedules_ReplaceJobSchedule.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchJobSchedule' description: A Job Schedule with updated properties required: true patch: operationId: JobSchedules_UpdateJobSchedule tags: - Job Schedules summary: Updates the properties of the specified Job Schedule description: 'This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.' parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule to update. required: true schema: type: string responses: '200': description: The request has succeeded. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule update: $ref: ./examples/JobSchedules_UpdateJobSchedule.json requestBody: content: application/json; odata=minimalmetadata: schema: $ref: '#/components/schemas/BatchJobScheduleUpdateOptions' description: The options to use for updating the Job Schedule. required: true delete: operationId: JobSchedules_DeleteJobSchedule tags: - Job Schedules summary: Deletes a Job Schedule from the specified Account description: 'When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.' parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule to delete. required: true schema: type: string - name: force in: query description: If true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. The default value is false. required: false schema: type: boolean responses: '202': description: The request has been accepted for processing, but processing has not yet completed. 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. schema: type: string 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. schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule delete: $ref: ./examples/JobSchedules_DeleteJobSchedule.json head: operationId: JobSchedules_JobScheduleExists tags: - Job Schedules summary: Checks the specified Job Schedule exists description: Checks the specified Job Schedule exists. parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule which you want to check. required: true schema: type: string responses: '200': description: The request has succeeded. headers: 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string '404': description: The server cannot find the requested resource. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: Check Job Schedule Exists: $ref: ./examples/JobSchedules_JobScheduleExists.json /jobschedules/{jobScheduleId}/disable: post: operationId: JobSchedules_DisableJobSchedule tags: - Job Schedules summary: Disables a Job Schedule description: No new Jobs will be created until the Job Schedule is enabled again. parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule to disable. required: true schema: type: string responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule disable: $ref: ./examples/JobSchedules_DisableJobSchedule.json /jobschedules/{jobScheduleId}/enable: post: operationId: JobSchedules_EnableJobSchedule tags: - Job Schedules summary: Enables a Job Schedule description: Enables a Job Schedule. parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule to enable. required: true schema: type: string responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule enable: $ref: ./examples/JobSchedules_EnableJobSchedule.json /jobschedules/{jobScheduleId}/terminate: post: operationId: JobSchedules_TerminateJobSchedule tags: - Job Schedules summary: Terminates a Job Schedule description: Terminates a Job Schedule. parameters: - $ref: '#/components/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 schema: type: integer format: int32 - 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 x-ms-client-name: clientRequestId schema: type: string - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false x-ms-client-name: returnClientRequestId schema: type: boolean default: false - 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 x-ms-client-name: ocpdate schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifModifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifUnmodifiedSince schema: type: string format: date-time-rfc7231 - 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 x-ms-client-name: ifMatch schema: type: string - 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 x-ms-client-name: ifNoneMatch schema: type: string - name: jobScheduleId in: path description: The ID of the Job Schedule to terminates. required: true schema: type: string - name: force in: query description: If true, the server will terminate the JobSchedule even if the corresponding nodes have not fully processed the termination. The default value is false. required: false schema: type: boolean responses: '202': description: The request has been accepted for processing, but processing has not yet completed. headers: DataServiceId: description: The OData ID of the resource to which the request applied. schema: type: string 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. schema: type: string Last-Modified: description: The time at which the resource was last modified. schema: type: string format: date-time-rfc7231 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. schema: type: string 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. schema: type: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/BatchError' x-ms-examples: JobSchedule terminate: $ref: ./examples/JobSchedules_TerminateJobSchedule.json components: schemas: BatchMetadataItem: 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 BatchJobSchedule: type: object description: 'A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.' properties: id: type: string description: A string that uniquely identifies the schedule within the Account. readOnly: true displayName: type: string description: The display name for the schedule. readOnly: true url: type: string format: uri description: The URL of the Job Schedule. readOnly: true eTag: $ref: '#/components/schemas/Azure.Core.eTag' description: The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime. readOnly: true lastModified: type: string format: date-time description: The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state. readOnly: true creationTime: type: string format: date-time description: The creation time of the Job Schedule. readOnly: true state: $ref: '#/components/schemas/BatchJobScheduleState' description: The current state of the Job Schedule. readOnly: true stateTransitionTime: type: string format: date-time description: The time at which the Job Schedule entered the current state. readOnly: true previousState: $ref: '#/components/schemas/BatchJobScheduleState' description: The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. readOnly: true previousStateTransitionTime: type: string format: date-time description: The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state. readOnly: true schedule: $ref: '#/components/schemas/BatchJobScheduleConfiguration' description: The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. jobSpecification: $ref: '#/components/schemas/BatchJobSpecification' description: The details of the Jobs to be created on this schedule. executionInfo: $ref: '#/components/schemas/BatchJobScheduleExecutionInfo' description: Information about Jobs that have been and will be run under this schedule. readOnly: true metadata: type: array description: A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/components/schemas/BatchMetadataItem' stats: $ref: '#/components/schemas/BatchJobScheduleStatistics' description: The lifetime resource usage statistics for the Job Schedule. 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 x-ms-client-name: jobScheduleStatistics required: - id - url - eTag - lastModified - creationTime - state - stateTransitionTime - jobSpecification - executionInfo UpgradePolicy: type: object description: Describes an upgrade policy - automatic, manual, or rolling. properties: mode: $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/RollingUpgradePolicy' description: The configuration parameters used while performing a rolling upgrade. required: - mode 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. 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 ManagedDisk: type: object description: The managed disk parameters. properties: diskEncryptionSet: $ref: '#/components/schemas/DiskEncryptionSetParameters' description: Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. storageAccountType: $ref: '#/components/schemas/StorageAccountType' description: The storage account type for managed disk. securityProfile: $ref: '#/components/schemas/BatchVmDiskSecurityProfile' description: Specifies the security profile settings for the managed disk. HostEndpointSettings: type: object description: Specifies particular host endpoint settings. properties: inVMAccessControlProfileReferenceId: type: string description: Specifies the reference to the InVMAccessControlProfileVersion resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}. x-ms-client-name: inVmAccessControlProfileReferenceId mode: $ref: '#/components/schemas/HostEndpointSettingsModeTypes' description: Specifies the access control policy execution mode. 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: '#/components/schemas/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. WindowsUserConfiguration: type: object description: Properties used to create a user Account on a Windows Compute Node. properties: loginMode: $ref: '#/components/schemas/LoginMode' description: The login mode for the user. The default is 'batch'. 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. 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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/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: '#/components/schemas/ResourceFile' environmentSettings: type: array description: A list of environment variable settings for the Job Preparation Task. items: $ref: '#/components/schemas/EnvironmentSetting' constraints: $ref: '#/components/schemas/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: '#/components/schemas/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 BatchContainerConfigurationUpdate: type: object description: The configuration for container-enabled Pools. properties: type: $ref: '#/components/schemas/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: '#/components/schemas/ContainerRegistryReference' BatchJobManagerTaskUpdate: 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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/BatchTaskContainerSettingsUpdate' 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: '#/components/schemas/ResourceFile' 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: '#/components/schemas/OutputFile' environmentSettings: type: array description: A list of environment variable settings for the Job Manager Task. items: $ref: '#/components/schemas/EnvironmentSetting' constraints: $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/BatchApplicationPackageReference' allowLowPriorityNode: type: boolean description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ProxyAgentSettings: type: object description: Specifies ProxyAgent settings while creating the virtual machine. properties: enabled: type: boolean description: Specifies whether Metadata Security Protocol feature should be enabled on the virtual machine or virtual machine scale set. Default is False. imds: $ref: '#/components/schemas/HostEndpointSettings' description: Settings for the IMDS endpoint. wireServer: $ref: '#/components/schemas/HostEndpointSettings' description: Settings for the WireServer endpoint. UpgradePolicyUpdate: type: object description: Describes an upgrade policy - automatic, manual, or rolling. properties: mode: $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/RollingUpgradePolicy' description: The configuration parameters used while performing a rolling upgrade. BatchJobScheduleState: type: string description: BatchJobScheduleState enums enum: - active - completed - disabled - terminating - deleting x-ms-enum: name: BatchJobScheduleState modelAsString: true values: - name: Active value: active description: The Job Schedule is active and will create Jobs as per its schedule. - name: Completed value: completed description: The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly. - name: Disabled value: disabled description: The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run. - name: Terminating value: terminating description: The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active. - name: Deleting value: deleting description: The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. 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: '#/components/schemas/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 DiskEncryptionSetParameters: type: object description: The ARM resource id of the disk encryption set. properties: id: type: string format: arm-id description: The ARM resource id of the disk encryption set. The resource must be in the same subscription as the Batch account. 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: '#/components/schemas/BatchInboundNatPool' x-ms-client-name: inboundNatPools required: - inboundNATPools 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://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). virtualMachineConfiguration: $ref: '#/components/schemas/VirtualMachineConfiguration' description: The virtual machine configuration for the Pool. This property must be specified. 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: '#/components/schemas/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). The time duration is specified in ISO 8601 format. 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). The time duration is specified in ISO 8601 format. 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: '#/components/schemas/NetworkConfiguration' description: The network configuration for the Pool. startTask: $ref: '#/components/schemas/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. 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: '#/components/schemas/BatchApplicationPackageReference' userAccounts: type: array description: The list of user Accounts to be created on each Compute Node in the Pool. items: $ref: '#/components/schemas/UserAccount' 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: '#/components/schemas/BatchMetadataItem' 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: '#/components/schemas/MountConfiguration' upgradePolicy: $ref: '#/components/schemas/UpgradePolicy' description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. required: - vmSize 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: '#/components/schemas/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. BatchJobSpecificationUpdate: type: object description: Specifies details of the Jobs to be created on a schedule. properties: priority: type: integer format: int32 description: The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API. allowTaskPreemption: type: boolean description: Whether Tasks in this job can be preempted by other high priority jobs. (This property is not available by default. Please contact support for more information) 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. (This property is not available by default. Please contact support for more information) 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. displayName: type: string description: The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024. usesTaskDependencies: type: boolean description: Whether Tasks in the Job can define dependencies on each other. The default is false. onAllTasksComplete: $ref: '#/components/schemas/BatchAllTasksCompleteMode' description: The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. x-ms-client-name: allTasksCompleteMode onTaskFailure: $ref: '#/components/schemas/BatchTaskFailureMode' description: The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. x-ms-client-name: taskFailureMode networkConfiguration: $ref: '#/components/schemas/BatchJobNetworkConfigurationUpdate' description: (This property is not available by default. Please contact support for more information) The network configuration for the Job. constraints: $ref: '#/components/schemas/BatchJobConstraints' description: The execution constraints for Jobs created under this schedule. jobManagerTask: $ref: '#/components/schemas/BatchJobManagerTaskUpdate' description: The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. jobPreparationTask: $ref: '#/components/schemas/BatchJobPreparationTaskUpdate' description: The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node. jobReleaseTask: $ref: '#/components/schemas/BatchJobReleaseTaskUpdate' description: The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task. commonEnvironmentSettings: type: array description: A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. items: $ref: '#/components/schemas/EnvironmentSetting' poolInfo: $ref: '#/components/schemas/BatchPoolInfoUpdate' description: The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. metadata: type: array description: A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/components/schemas/BatchMetadataItem' DiskCustomerManagedKey: type: object description: The Customer Managed Key reference to encrypt the Disk. properties: identityReference: $ref: '#/components/schemas/BatchPoolIdentityReference' description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. keyUrl: type: string description: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. rotationToLatestKeyVersionEnabled: type: boolean description: Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. BatchJobReleaseTaskUpdate: 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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/BatchTaskContainerSettingsUpdate' 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: '#/components/schemas/ResourceFile' environmentSettings: type: array description: A list of environment variable settings for the Job Release Task. items: $ref: '#/components/schemas/EnvironmentSetting' 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). The time duration is specified in ISO 8601 format. 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. The time duration is specified in ISO 8601 format. userIdentity: $ref: '#/components/schemas/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. 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 format: password description: The password to use for authentication against the CIFS file system. x-ms-secret: true required: - username - source - relativeMountPath - password BatchDiffDiskSettings: type: object description: 'Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).' properties: placement: $ref: '#/components/schemas/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://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. AzureFileShareConfiguration: type: object description: Information used to connect to an Azure Fileshare. properties: accountName: type: string description: The Azure Storage account name. accountKey: type: string format: password description: The Azure Storage account key. x-ms-secret: true azureFileUrl: type: string format: uri description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. 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 - accountKey - azureFileUrl - relativeMountPath BatchJobNetworkConfigurationUpdate: type: object description: (This property is not available by default. Please contact support for more information) 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. 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://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.' skipWithdrawFromVNet: type: boolean description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. x-ms-client-name: skipWithdrawFromVnet 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. 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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/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: '#/components/schemas/ResourceFile' environmentSettings: type: array description: A list of environment variable settings for the StartTask. items: $ref: '#/components/schemas/EnvironmentSetting' userIdentity: $ref: '#/components/schemas/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 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. The time duration is specified in ISO 8601 format. 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. The time duration is specified in ISO 8601 format. 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). 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. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. proxyAgentSettings: $ref: '#/components/schemas/ProxyAgentSettings' description: Specifies ProxyAgent settings while creating the virtual machine. securityType: $ref: '#/components/schemas/SecurityTypes' description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. uefiSettings: $ref: '#/components/schemas/BatchUefiSettings' 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. 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. HostEndpointSettingsModeTypes: type: string description: HostEndpointSettingsModeTypes enums enum: - Audit - Enforce x-ms-enum: name: HostEndpointSettingsModeTypes modelAsString: true values: - name: Audit value: Audit description: In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. - name: Enforce value: Enforce description: Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. ContainerHostDataPath: type: string description: The paths which will be mounted to container task's container. enum: - Shared - Startup - VfsMounts - Task - JobPrep - Applications x-ms-enum: name: ContainerHostDataPath modelAsString: true values: - name: Shared value: Shared description: The path for multi-instances task to shared their files. - name: Startup value: Startup description: The path for start task. - name: VfsMounts value: VfsMounts description: The path contains all virtual file systems are mounted on this node. - name: Task value: Task description: The task path. - name: JobPrep value: JobPrep description: The job-prep task path. - name: Applications value: Applications description: The applications path. 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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/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: '#/components/schemas/ResourceFile' environmentSettings: type: array description: A list of environment variable settings for the Job Release Task. items: $ref: '#/components/schemas/EnvironmentSetting' 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). The time duration is specified in ISO 8601 format. 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. The time duration is specified in ISO 8601 format. userIdentity: $ref: '#/components/schemas/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 SecurityEncryptionTypes: type: string description: SecurityEncryptionTypes enums enum: - DiskWithVMGuestState - NonPersistedTPM - VMGuestStateOnly x-ms-enum: name: SecurityEncryptionTypes modelAsString: true values: - name: DiskWithVMGuestState value: DiskWithVMGuestState description: EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. - name: NonPersistedTPM value: NonPersistedTPM description: EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. - name: VMGuestStateOnly value: VMGuestStateOnly description: EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. 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: '#/components/schemas/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: '#/components/schemas/BatchPoolSpecificationUpdate' description: The Pool specification for the auto Pool. 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. 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 is 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. 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. VirtualMachineConfigurationUpdate: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.' properties: imageReference: $ref: '#/components/schemas/BatchVmImageReference' 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: '#/components/schemas/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://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. items: $ref: '#/components/schemas/DataDisk' 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: '#/components/schemas/BatchContainerConfigurationUpdate' 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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/VMExtension' osDisk: $ref: '#/components/schemas/BatchOsDisk' description: Settings for the operating system disk of the Virtual Machine. x-ms-client-name: OsDisk securityProfile: $ref: '#/components/schemas/SecurityProfile' description: Specifies the security profile settings for the virtual machine or virtual machine scale set. serviceArtifactReference: $ref: '#/components/schemas/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} 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. 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: '#/components/schemas/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: '#/components/schemas/BatchErrorDetail' 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. OutputFileUploadConfig: type: object description: 'Options for an output file upload operation, including under what conditions to perform the upload.' properties: uploadCondition: $ref: '#/components/schemas/OutputFileUploadCondition' description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. required: - uploadCondition 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: '#/components/schemas/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: '#/components/schemas/BatchPoolSpecification' description: The Pool specification for the auto Pool. required: - poolLifetimeOption 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 format: password description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. x-ms-secret: true sasKey: type: string format: password description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. x-ms-secret: true 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: '#/components/schemas/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 BatchJobScheduleUpdateOptions: type: object description: Parameters for updating an Azure Batch Job Schedule. properties: schedule: $ref: '#/components/schemas/BatchJobScheduleConfiguration' description: The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. If you do not specify this element, the existing schedule is left unchanged. jobSpecification: $ref: '#/components/schemas/BatchJobSpecificationUpdate' description: The details of the Jobs to be created on this schedule. Updates affect only Jobs that are started after the update has taken place. Any currently active Job continues with the older specification. metadata: type: array description: A list of name-value pairs associated with the Job Schedule as metadata. If you do not specify this element, existing metadata is left unchanged. items: $ref: '#/components/schemas/BatchMetadataItem' IPFamily: type: string description: The IP families used to specify IP versions available to the pool. enum: - IPv4 - IPv6 x-ms-enum: name: IPFamily modelAsString: true values: - name: IPv4 value: IPv4 description: IPv4 is available to the pool. - name: IPv6 value: IPv6 description: IPv6 is available to the pool. BatchInboundNatPool: 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: '#/components/schemas/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 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: '#/components/schemas/NetworkSecurityGroupRule' required: - name - protocol - backendPort - frontendPortRangeStart - frontendPortRangeEnd BatchVmImageReference: 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 format: arm-id 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://learn.microsoft.com/azure/batch/nodes-and-pools#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 sharedGalleryImageId: type: string description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. communityGalleryImageId: type: string description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. 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: '#/components/schemas/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 managedDisk: $ref: '#/components/schemas/ManagedDisk' description: The managed disk parameters. required: - lun - diskSizeGB BatchTaskSchedulingPolicy: type: object description: Specifies how Tasks should be distributed across Compute Nodes. properties: jobDefaultOrder: type: string description: The order for scheduling tasks from different jobs with the same priority. If not specified, the default is none. default: none enum: - none - creationtime x-ms-enum: name: BatchJobDefaultOrder modelAsString: true values: - name: None value: none description: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. - name: CreationTime value: creationtime description: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. nodeFillType: $ref: '#/components/schemas/BatchNodeFillType' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. required: - nodeFillType 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. 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 BatchTaskSchedulingPolicyUpdate: type: object description: Specifies how Tasks should be distributed across Compute Nodes. properties: jobDefaultOrder: type: string description: The order for scheduling tasks from different jobs with the same priority. If not specified, the default is none. default: none enum: - none - creationtime x-ms-enum: name: BatchJobDefaultOrder modelAsString: true values: - name: None value: none description: Tasks should be scheduled uniformly from all equal-priority jobs for the pool. - name: CreationTime value: creationtime description: If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. nodeFillType: $ref: '#/components/schemas/BatchNodeFillType' description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. DiffDiskPlacement: type: string description: Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool. This property can be used by user in the request to choose which location the operating system should be in. 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://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements 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. 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 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://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). virtualMachineConfiguration: $ref: '#/components/schemas/VirtualMachineConfigurationUpdate' description: The virtual machine configuration for the Pool. This property must be specified. 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: '#/components/schemas/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). The time duration is specified in ISO 8601 format. 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). The time duration is specified in ISO 8601 format. 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: '#/components/schemas/NetworkConfigurationUpdate' description: The network configuration for the Pool. startTask: $ref: '#/components/schemas/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. 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: '#/components/schemas/BatchApplicationPackageReference' userAccounts: type: array description: The list of user Accounts to be created on each Compute Node in the Pool. items: $ref: '#/components/schemas/UserAccount' 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: '#/components/schemas/BatchMetadataItem' 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: '#/components/schemas/MountConfiguration' upgradePolicy: $ref: '#/components/schemas/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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/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: '#/components/schemas/ResourceFile' 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: '#/components/schemas/OutputFile' environmentSettings: type: array description: A list of environment variable settings for the Job Manager Task. items: $ref: '#/components/schemas/EnvironmentSetting' constraints: $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/BatchApplicationPackageReference' 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 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. 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. 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 format: uri 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: '#/components/schemas/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://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.' items: $ref: '#/components/schemas/OutputFileUploadHeader' required: - containerUrl OutputFileDestination: type: object description: The destination to which a file should be uploaded. properties: container: $ref: '#/components/schemas/OutputFileBlobContainerDestination' description: A location in Azure blob storage to which files are uploaded. 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 format: password 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). x-ms-secret: true RecentBatchJob: type: object description: Information about the most recent Job to run under the Job Schedule. properties: id: type: string description: The ID of the Job. url: type: string format: uri description: The URL of the Job. VirtualMachineConfiguration: type: object description: 'The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.' properties: imageReference: $ref: '#/components/schemas/BatchVmImageReference' 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: '#/components/schemas/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://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. items: $ref: '#/components/schemas/DataDisk' 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: '#/components/schemas/BatchContainerConfiguration' 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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/VMExtension' osDisk: $ref: '#/components/schemas/BatchOsDisk' description: Settings for the operating system disk of the Virtual Machine. x-ms-client-name: OsDisk securityProfile: $ref: '#/components/schemas/SecurityProfile' description: Specifies the security profile settings for the virtual machine or virtual machine scale set. serviceArtifactReference: $ref: '#/components/schemas/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 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 - confidentialvm x-ms-enum: name: SecurityTypes modelAsString: true values: - name: trustedLaunch value: trustedLaunch description: Trusted launch protects against advanced and persistent attack techniques. - name: confidentialVM value: confidentialvm description: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. 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 BatchJobSpecification: type: object description: Specifies details of the Jobs to be created on a schedule. properties: priority: type: integer format: int32 description: The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API. allowTaskPreemption: type: boolean description: Whether Tasks in this job can be preempted by other high priority jobs. (This property is not available by default. Please contact support for more information) 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. (This property is not available by default. Please contact support for more information) 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. displayName: type: string description: The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024. usesTaskDependencies: type: boolean description: Whether Tasks in the Job can define dependencies on each other. The default is false. onAllTasksComplete: $ref: '#/components/schemas/BatchAllTasksCompleteMode' description: The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. x-ms-client-name: allTasksCompleteMode onTaskFailure: $ref: '#/components/schemas/BatchTaskFailureMode' description: The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. x-ms-client-name: taskFailureMode networkConfiguration: $ref: '#/components/schemas/BatchJobNetworkConfiguration' description: (This property is not available by default. Please contact support for more information) The network configuration for the Job. constraints: $ref: '#/components/schemas/BatchJobConstraints' description: The execution constraints for Jobs created under this schedule. jobManagerTask: $ref: '#/components/schemas/BatchJobManagerTask' description: The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. jobPreparationTask: $ref: '#/components/schemas/BatchJobPreparationTask' description: The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node. jobReleaseTask: $ref: '#/components/schemas/BatchJobReleaseTask' description: The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task. commonEnvironmentSettings: type: array description: A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. items: $ref: '#/components/schemas/EnvironmentSetting' poolInfo: $ref: '#/components/schemas/BatchPoolInfo' description: The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. metadata: type: array description: A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/components/schemas/BatchMetadataItem' required: - poolInfo BatchUefiSettings: 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. 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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/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: '#/components/schemas/ResourceFile' environmentSettings: type: array description: A list of environment variable settings for the StartTask. items: $ref: '#/components/schemas/EnvironmentSetting' userIdentity: $ref: '#/components/schemas/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. 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. Azure.Core.eTag: type: string description: 'The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed. It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34".' 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. The time duration is specified in ISO 8601 format. 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). 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: customerManagedKey: $ref: '#/components/schemas/DiskCustomerManagedKey' description: The Customer Managed Key reference to encrypt the OS Disk. Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. targets: type: array description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. items: $ref: '#/components/schemas/DiskEncryptionTarget' BatchVmDiskSecurityProfile: type: object description: 'Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs.' properties: securityEncryptionType: $ref: '#/components/schemas/SecurityEncryptionTypes' description: 'Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs.' 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. UpgradeMode: type: string description: UpgradeMode enums enum: - automatic - manual - rolling x-ms-enum: name: UpgradeMode modelAsString: true values: - name: Automatic value: automatic description: All 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. MountConfiguration: type: object description: The file system to mount on each node. properties: azureBlobFileSystemConfiguration: $ref: '#/components/schemas/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: '#/components/schemas/NfsMountConfiguration' description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. cifsMountConfiguration: $ref: '#/components/schemas/CifsMountConfiguration' description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. azureFileShareConfiguration: $ref: '#/components/schemas/AzureFileShareConfiguration' description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. BatchContainerConfiguration: type: object description: The configuration for container-enabled Pools. properties: type: $ref: '#/components/schemas/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: '#/components/schemas/ContainerRegistryReference' required: - type BatchAllTasksCompleteMode: 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: BatchAllTasksCompleteMode 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'. ContainerRegistryReference: type: object description: A private container registry. properties: username: type: string description: The user name to log into the registry server. password: type: string format: password description: The password to log into the registry server. x-ms-secret: true registryServer: type: string format: uri description: The registry URL. If omitted, the default is "docker.io". identityReference: $ref: '#/components/schemas/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. 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 format: arm-id description: The ARM resource id of the user assigned identity. 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. 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/rest/api/batchservice/pools/create-pool#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. 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: '#/components/schemas/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. BatchPoolIdentityReference: type: object description: The reference of one of the pool identities to encrypt Disk. This identity will be used to access the key vault. properties: resourceId: type: string format: arm-id description: The ARM resource id of the user assigned identity. This reference must be included in the pool identities. IPTag: type: object description: Contains the IP tag associated with the public IP address. properties: ipTagType: type: string description: 'The IP Tag type. Example: FirstPartyUsage.' tag: type: string description: 'The value of the IP tag associated with the public IP. Example: SQL.' BatchJobScheduleExecutionInfo: type: object description: 'Contains information about Jobs that have been and will be run under a Job Schedule.' properties: nextRunTime: type: string format: date-time description: The next time at which a Job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then. recentJob: $ref: '#/components/schemas/RecentBatchJob' description: Information about the most recent Job under the Job Schedule. This property is present only if the at least one Job has run under the schedule. endTime: type: string format: date-time description: The time at which the schedule ended. This property is set only if the Job Schedule is in the completed state. ContainerHostBatchBindMountEntry: type: object description: The entry of path and mount mode you want to mount into task container. properties: source: $ref: '#/components/schemas/ContainerHostDataPath' description: The path which be mounted to container customer can select. isReadOnly: type: boolean description: Mount this source path as read-only mode or not. Default value is false (read/write mode). For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. 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: '#/components/schemas/BatchInboundNatPool' x-ms-client-name: inboundNatPools 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. BatchJobScheduleStatistics: type: object description: Resource usage statistics for a Job Schedule. properties: url: type: string format: uri 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 all Jobs created under the schedule. The time duration is specified in ISO 8601 format. 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 all Jobs created under the schedule. The time duration is specified in ISO 8601 format. x-ms-client-name: kernelCpuTime wallClockTime: type: string format: duration description: The total wall clock time of all the Tasks in all the Jobs created under the schedule. 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. The time duration is specified in ISO 8601 format. readIOps: type: string format: int64 description: The total number of disk read operations made by all Tasks in all Jobs created under the schedule. x-ms-client-name: readIops writeIOps: type: string format: int64 description: The total number of disk write operations made by all Tasks in all Jobs created under the schedule. x-ms-client-name: writeIops readIOGiB: type: number format: float description: The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. x-ms-client-name: readIoGiB writeIOGiB: type: number format: float description: The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. x-ms-client-name: writeIoGiB numSucceededTasks: type: string format: int64 description: The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0. x-ms-client-name: succeededTasksCount numFailedTasks: type: string format: int64 description: The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0. x-ms-client-name: failedTasksCount numTaskRetries: type: string format: int64 description: The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. x-ms-client-name: taskRetriesCount waitTime: type: string format: duration description: The total wait time of all Tasks in all Jobs created under the schedule. 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. The time duration is specified in ISO 8601 format. required: - url - startTime - lastUpdateTime - userCPUTime - kernelCPUTime - wallClockTime - readIOps - writeIOps - readIOGiB - writeIOGiB - numSucceededTasks - numFailedTasks - numTaskRetries - waitTime BatchOsDisk: type: object description: Settings for the operating system disk of the compute node (VM). properties: ephemeralOSDiskSettings: $ref: '#/components/schemas/BatchDiffDiskSettings' description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). caching: $ref: '#/components/schemas/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: '#/components/schemas/ManagedDisk' description: The managed disk parameters. writeAcceleratorEnabled: type: boolean description: Specifies whether writeAccelerator should be enabled or disabled on the disk. 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. 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. Only ARM virtual networks (''Microsoft.Network/virtualNetworks'') 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, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration' dynamicVNetAssignmentScope: $ref: '#/components/schemas/DynamicVNetAssignmentScope' description: The scope of dynamic vnet assignment. x-ms-client-name: dynamicVnetAssignmentScope endpointConfiguration: $ref: '#/components/schemas/BatchPoolEndpointConfiguration' description: The configuration for endpoints on Compute Nodes in the Batch Pool. publicIPAddressConfiguration: $ref: '#/components/schemas/BatchPublicIpAddressConfiguration' description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. 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.' 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: '#/components/schemas/OutputFileDestination' description: The destination for the output file(s). uploadOptions: $ref: '#/components/schemas/OutputFileUploadConfig' description: Additional options for the upload operation, including under what conditions to perform the upload. required: - filePattern - destination - uploadOptions 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. Only ARM virtual networks (''Microsoft.Network/virtualNetworks'') 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, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration' dynamicVNetAssignmentScope: $ref: '#/components/schemas/DynamicVNetAssignmentScope' description: The scope of dynamic vnet assignment. x-ms-client-name: dynamicVnetAssignmentScope endpointConfiguration: $ref: '#/components/schemas/BatchPoolEndpointConfigurationUpdate' description: The configuration for endpoints on Compute Nodes in the Batch Pool. publicIPAddressConfiguration: $ref: '#/components/schemas/BatchPublicIpAddressConfiguration' description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. 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.' 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} BatchJobNetworkConfiguration: type: object description: (This property is not available by default. Please contact support for more information) 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. 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://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.' skipWithdrawFromVNet: type: boolean description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. x-ms-client-name: skipWithdrawFromVnet required: - subnetId 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 format: uri 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 format: uri 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: '#/components/schemas/BatchNodeIdentityReference' description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. 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 BatchJobScheduleListResult: type: object description: The result of listing the Job Schedules in an Account. properties: value: type: array description: The list of Job Schedules. items: $ref: '#/components/schemas/BatchJobSchedule' odata.nextLink: type: string format: uri description: The URL to get the next set of results. BatchPublicIpAddressConfiguration: type: object description: The public IP Address configuration of the networking configuration of a Pool. properties: provision: $ref: '#/components/schemas/IpAddressProvisioningType' description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. x-ms-client-name: IpAddressProvisioningType ipFamilies: type: array description: The IP families used to specify IP versions available to the pool. IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. items: $ref: '#/components/schemas/IPFamily' 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 format: arm-id description: A type definition that refers the id to an Azure Resource Manager resource. ipTags: type: array description: A list of IP tags associated with the public IP addresses of the Pool. IP tags are used to categorize and filter public IP addresses for billing and management purposes. items: $ref: '#/components/schemas/IPTag' AutoUserSpecification: type: object description: Specifies the options for the auto user that runs an Azure Batch Task. properties: scope: $ref: '#/components/schemas/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. elevationLevel: $ref: '#/components/schemas/ElevationLevel' description: The elevation level of the auto user. The default value is nonAdmin. BatchJobScheduleCreateOptions: type: object description: Parameters for creating an Azure Batch Job Schedule properties: id: type: string description: A string that uniquely identifies the schedule 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 schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. schedule: $ref: '#/components/schemas/BatchJobScheduleConfiguration' description: The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. jobSpecification: $ref: '#/components/schemas/BatchJobSpecification' description: The details of the Jobs to be created on this schedule. metadata: type: array description: A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. items: $ref: '#/components/schemas/BatchMetadataItem' required: - id - schedule - jobSpecification 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: '#/components/schemas/ContainerRegistryReference' description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. workingDirectory: $ref: '#/components/schemas/ContainerWorkingDirectory' description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. containerHostBatchBindMounts: type: array description: The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. items: $ref: '#/components/schemas/ContainerHostBatchBindMountEntry' required: - imageName 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: '#/components/schemas/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. 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. 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: '#/components/schemas/ContainerRegistryReference' description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. workingDirectory: $ref: '#/components/schemas/ContainerWorkingDirectory' description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. containerHostBatchBindMounts: type: array description: The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. items: $ref: '#/components/schemas/ContainerHostBatchBindMountEntry' 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 format: password description: The password for the user Account. x-ms-secret: true elevationLevel: $ref: '#/components/schemas/ElevationLevel' description: The elevation level of the user Account. The default value is nonAdmin. linuxUserConfiguration: $ref: '#/components/schemas/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: '#/components/schemas/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 BatchJobScheduleConfiguration: type: object description: 'The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.' properties: doNotRunUntil: type: string format: date-time description: The earliest time at which any Job may be created under this Job Schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately. doNotRunAfter: type: string format: date-time description: A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active Job under this Job Schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it. startWindow: type: string format: duration description: The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created. If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). The time duration is specified in ISO 8601 format. recurrenceInterval: type: string format: duration description: 'The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time. Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). The time duration is specified in ISO 8601 format.' 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. 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. BatchJobPreparationTaskUpdate: 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://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/components/schemas/BatchTaskContainerSettingsUpdate' 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: '#/components/schemas/ResourceFile' environmentSettings: type: array description: A list of environment variable settings for the Job Preparation Task. items: $ref: '#/components/schemas/EnvironmentSetting' constraints: $ref: '#/components/schemas/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: '#/components/schemas/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. BatchTaskFailureMode: type: string description: TaskFailure enums enum: - noaction - performexitoptionsjobaction x-ms-enum: name: BatchTaskFailureMode 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'. OutputFileUploadHeader: 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 parameters: Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true x-ms-parameter-location: method x-ms-client-name: apiVersion schema: type: string minLength: 1 securitySchemes: OAuth2Auth: type: oauth2 flows: implicit: scopes: https://batch.core.windows.net//.default: '' authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - name: endpoint in: path description: 'Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).' required: true type: string format: uri x-ms-skip-url-encoding: true