swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Tasks API description: Provides access to task resources. schemes: - https tags: - description: Provides access to task resources. name: Tasks paths: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks: get: produces: - application/json parameters: - $ref: '#/parameters/FilterParameter' - $ref: '#/parameters/SkipParameter' - $ref: '#/parameters/MaxPageSizeParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkspaceNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/TaskPageResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' tags: - Tasks operationId: microsoftAzureTasksList summary: Microsoft Azure Retrieve A List Of Tasks For The Provided Search Parameters x-ms-examples: Tasks: $ref: ./examples/Tasks_List.json x-ms-pageable: itemName: content nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}: get: produces: - application/json parameters: - $ref: '#/parameters/TaskIdParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkspaceNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/TaskResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' tags: - Tasks operationId: microsoftAzureTasksGet summary: Microsoft Azure Retrieve A Task By Taskid x-ms-examples: Tasks: $ref: ./examples/Tasks_Get.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}:cancel: post: produces: - application/json parameters: - $ref: '#/parameters/TaskIdParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkspaceNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/TaskResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' tags: - Tasks operationId: microsoftAzureTasksCancel summary: Microsoft Azure Cancel A Task By Taskid x-ms-examples: Tasks: $ref: ./examples/Tasks_Cancel.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}:download: post: produces: - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - application/json parameters: - $ref: '#/parameters/TaskIdParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkspaceNameParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: format: binary type: string default: description: Error schema: $ref: '#/definitions/ErrorResponse' tags: - Tasks operationId: microsoftAzureTasksDownload summary: Microsoft Azure Download Task Data For The Provided Taskid x-ms-examples: Tasks: $ref: ./examples/Tasks_Download.json description: Needs a more full description created. /jobs/{jobId}/tasks: post: tags: - Tasks operationId: microsoftAzureTaskAdd x-ms-examples: Add a basic task: $ref: ./examples/TaskAdd_Basic.json Add a task with exit conditions: $ref: ./examples/TaskAdd_ExitConditions.json Add a task with container settings: $ref: ./examples/TaskAdd_ContainerSettings.json Add a task with extra slot requirement: $ref: ./examples/TaskAdd_RequiredSlots.json summary: Microsoft Azure Adds A Task To The Specified Job description: The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job to which the Task is to be added. - name: task in: body description: The Task to be added. required: true schema: $ref: '#/definitions/TaskAddParameter' - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '201': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' get: tags: - Tasks x-ms-pageable: nextLinkName: odata.nextLink operationId: microsoftAzureTaskList x-ms-examples: Task list: $ref: ./examples/TaskList.json summary: Microsoft Azure Lists All Of The Tasks That Are Associated With The Specified Job description: For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job. - name: $filter in: query required: false type: string description: An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. x-ms-parameter-grouping: postfix: Options - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: $expand in: query required: false type: string description: An OData $expand clause. x-ms-parameter-grouping: postfix: Options - name: maxresults x-ms-client-name: maxResults default: 1000 minimum: 1 maximum: 1000 in: query required: false type: integer format: int32 description: The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the list of Tasks. schema: $ref: '#/definitions/CloudTaskListResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /jobs/{jobId}/addtaskcollection: post: tags: - Tasks operationId: microsoftAzureTaskAddcollection x-ms-examples: Add a basic collection of tasks: $ref: ./examples/TaskAddCollection_Basic.json Add a complex collection of tasks: $ref: ./examples/TaskAddCollection_Complex.json summary: Microsoft Azure Adds A Collection Of Tasks To The Specified Job description: Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job to which the Task collection is to be added. - name: taskCollection in: body description: The Tasks to be added. required: true schema: $ref: '#/definitions/TaskAddCollectionParameter' - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string schema: $ref: '#/definitions/TaskAddCollectionResult' description: A response containing the results of the add Task collection operation. default: description: Unexpected error schema: $ref: '#/definitions/BatchError' /jobs/{jobId}/tasks/{taskId}: delete: tags: - Tasks operationId: microsoftAzureTaskDelete x-ms-examples: Task delete: $ref: ./examples/TaskDelete.json summary: Microsoft Azure Deletes A Task From The Specified Job description: When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job from which to delete the Task. - name: taskId in: path required: true type: string description: The ID of the Task to delete. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - name: If-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-None-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-Modified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - name: If-Unmodified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' get: tags: - Tasks operationId: microsoftAzureTaskGet x-ms-examples: Task get: $ref: ./examples/TaskGet.json summary: Microsoft Azure Gets Information About The Specified Task description: For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job that contains the Task. - name: taskId in: path required: true type: string description: The ID of the Task to get information about. - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: $expand in: query required: false type: string description: An OData $expand clause. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - name: If-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-None-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-Modified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - name: If-Unmodified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: A response containing the Task. schema: $ref: '#/definitions/CloudTask' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' put: tags: - Tasks operationId: microsoftAzureTaskUpdate x-ms-examples: Task update: $ref: ./examples/TaskUpdate.json description: Updates the properties of the specified Task. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job containing the Task. - name: taskId in: path required: true type: string description: The ID of the Task to update. - name: taskUpdateParameter in: body required: true schema: $ref: '#/definitions/TaskUpdateParameter' description: The parameters for the request. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - name: If-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-None-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-Modified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - name: If-Unmodified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' summary: Microsoft Azure Put Jobs Jobid Tasks Taskid /jobs/{jobId}/tasks/{taskId}/subtasksinfo: get: tags: - Tasks operationId: microsoftAzureTaskListsubtasks x-ms-examples: Task list subtasks: $ref: ./examples/TaskListSubtasks.json summary: Microsoft Azure Lists All Of The Subtasks That Are Associated With The Specified Multi Instance Task description: If the Task is not a multi-instance Task then this returns an empty collection. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job. - name: taskId in: path required: true type: string description: The ID of the Task. - name: $select in: query required: false type: string description: An OData $select clause. x-ms-parameter-grouping: postfix: Options - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '200': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 description: A response containing the list of subtasks. schema: $ref: '#/definitions/CloudTaskListSubtasksResult' default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /jobs/{jobId}/tasks/{taskId}/terminate: post: tags: - Tasks operationId: microsoftAzureTaskTerminate x-ms-examples: Task terminate: $ref: ./examples/TaskTerminate.json summary: Microsoft Azure Terminates The Specified Task description: When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background. x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job containing the Task. - name: taskId in: path required: true type: string description: The ID of the Task to terminate. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - name: If-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-None-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-Modified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - name: If-Unmodified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '204': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /jobs/{jobId}/tasks/{taskId}/reactivate: post: tags: - Tasks operationId: microsoftAzureTaskReactivate x-ms-examples: Task reactivate: $ref: ./examples/TaskReactivate.json summary: Microsoft Azure Reactivates A Task, Allowing It To Run Again Even If Its Retry Count Has Been Exhausted description: Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting). x-ms-request-id: request-id parameters: - name: jobId in: path required: true type: string description: The ID of the Job containing the Task. - name: taskId in: path required: true type: string description: The ID of the Task to reactivate. - name: timeout in: query required: false type: integer format: int32 default: 30 description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. x-ms-parameter-grouping: postfix: Options - name: client-request-id in: header required: false type: string format: uuid description: The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. x-ms-parameter-grouping: postfix: Options x-ms-client-request-id: true - name: return-client-request-id default: false in: header required: false type: boolean description: Whether the server should return the client-request-id in the response. x-ms-parameter-grouping: postfix: Options - name: ocp-date in: header required: false type: string format: date-time-rfc1123 description: The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. x-ms-parameter-grouping: postfix: Options - name: If-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-None-Match in: header required: false type: string 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. x-ms-parameter-grouping: postfix: Options - name: If-Modified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - name: If-Unmodified-Since in: header required: false type: string format: date-time-rfc1123 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. x-ms-parameter-grouping: postfix: Options - $ref: '#/parameters/ApiVersionParameter' responses: '204': headers: client-request-id: description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. type: string format: uuid request-id: description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. type: string format: uuid ETag: description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. type: string Last-Modified: description: The time at which the resource was last modified. type: string format: date-time-rfc1123 DataServiceId: description: The OData ID of the resource to which the request applied. type: string description: The request to the Batch service was successful. default: description: The error from the Batch service. schema: $ref: '#/definitions/BatchError' /tasks: get: operationId: microsoftAzureTasksListtask tags: - Tasks description: Retrieve a list of tasks for the provided search parameters. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - $ref: '#/parameters/Azure.Core.FilterQueryParameter' - $ref: '#/parameters/OrderByParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedTask' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Tasks_ListTask: $ref: ./examples/Tasks_ListTask_MaximumSet_Gen.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Tasks /tasks/{taskId}: get: operationId: microsoftAzureTasksGettask tags: - Tasks description: Retrieve a task by taskId. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: taskId in: path description: The unique identifier of the task. required: true type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Task' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Tasks_GetTask: $ref: ./examples/Tasks_GetTask_MaximumSet_Gen.json summary: Microsoft Azure Get Tasks Taskid /tasks/{taskId}:cancel: post: operationId: microsoftAzureTasksCanceltask tags: - Tasks description: Cancel a task by taskId. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: taskId in: path description: The unique identifier of the task. required: true type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Task' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Tasks_CancelTask: $ref: ./examples/Tasks_CancelTask_MaximumSet_Gen.json summary: Microsoft Azure Post Tasks Taskid:cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}/tasks/{taskId} : get: tags: - Tasks description: Returns a task in the given workspace. operationId: microsoftAzureTasksGetbyworkspace parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/WorkspaceNameParameter' - $ref: '#/parameters/TaskIdParameter_2' responses: '200': description: Task details. schema: $ref: '#/definitions/TaskResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Tasks: $ref: ./examples/Tasks_GetByWorkspace.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Tasks Taskid definitions: ErrorMessage: properties: lang: type: string title: The language code of the error message value: type: string title: The text of the message. title: An error message received in an Azure Batch error response. ErrorDetail: description: This is the top-level error object whose code matches the x-ms-error-code response header properties: code: description: This is one of a server-defined set of error codes. type: string details: description: This is an array of details about specific errors that led to this reported error. items: $ref: '#/definitions/ErrorDetail' type: array innererror: $ref: '#/definitions/InnerError' message: description: This is a human-readable representation of the error. type: string target: description: This is the error target. type: string required: - code - message type: object UserIdentity: properties: username: type: string x-ms-client-name: userName title: The name of the user identity under which the Task is run. description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. autoUser: $ref: '#/definitions/AutoUserSpecification' title: The auto user under which the Task is run. description: The userName and autoUser properties are mutually exclusive; you must specify one but not both. title: The definition of the user identity under which the Task is run. description: Specify either the userName or autoUser property, but not both. TaskAddCollectionParameter: properties: value: type: array items: $ref: '#/definitions/TaskAddParameter' maxItems: 100 title: The collection of Tasks to add. The maximum count of Tasks is 100. description: The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks. required: - value title: A collection of Azure Batch Tasks to add. ApplicationPackageReference: properties: applicationId: type: string title: The ID of the application to deploy. version: type: string title: The version of the application to deploy. If omitted, the default version is deployed. description: If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. required: - applicationId title: A reference to an Package to be deployed to Compute Nodes. OutputFileUploadCondition: type: string title: The conditions under which a Task output file or set of files should be uploaded. enum: - tasksuccess - taskfailure - taskcompletion x-ms-enum: name: OutputFileUploadCondition modelAsString: false values: - value: tasksuccess description: Upload the file(s) only after the Task process exits with an exit code of 0. name: taskSuccess - value: taskfailure description: Upload the file(s) only after the Task process exits with a nonzero exit code. name: taskFailure - value: taskcompletion description: Upload the file(s) after the Task process exits, no matter what the exit code was. name: taskCompletion TaskStatistics: properties: url: type: string title: The URL of the statistics. startTime: type: string format: date-time title: The start time of the time range covered by the statistics. lastUpdateTime: type: string format: date-time title: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. userCPUTime: type: string format: duration title: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. kernelCPUTime: type: string format: duration title: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. wallClockTime: type: string format: duration title: The total wall clock time of the Task. description: The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If the Task was retried, this includes the wall clock time of all the Task retries. readIOps: type: integer format: int64 title: The total number of disk read operations made by the Task. writeIOps: type: integer format: int64 title: The total number of disk write operations made by the Task. readIOGiB: type: number format: double title: The total gibibytes read from disk by the Task. writeIOGiB: type: number format: double title: The total gibibytes written to disk by the Task. waitTime: type: string format: duration title: The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) required: - url - startTime - lastUpdateTime - userCPUTime - kernelCPUTime - wallClockTime - readIOps - writeIOps - readIOGiB - writeIOGiB - waitTime title: Resource usage statistics for a Task. TaskResponse: properties: completedAt: format: date-time type: string id: type: string lastPolledAt: format: date-time type: string phase: enum: - running - polling - complete type: string x-ms-enum: modelAsString: true name: taskResponsePhase reason: type: string startedAt: format: date-time type: string state: enum: - pending - running - paused - complete - incomplete - failed - warning type: string x-ms-enum: modelAsString: true name: taskResponseState type: object TaskState_2: type: string description: The state the task is in. enum: - pending - running - paused - complete - incomplete - failed - warning x-ms-enum: name: TaskState modelAsString: true Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message TaskPageResponse: properties: content: items: $ref: '#/definitions/TaskResponse' type: array first: type: boolean last: type: boolean nextLink: type: string number: format: int32 type: integer numberOfElements: format: int32 type: integer size: format: int32 type: integer totalElements: format: int64 type: integer totalPages: format: int32 type: integer type: object TaskContainerSettings: properties: containerRunOptions: type: string title: Additional options to the container create command. description: These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. imageName: type: string title: The Image to use to create the container in which the Task will run. description: This is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default. registry: $ref: '#/definitions/ContainerRegistry' title: The private registry which contains the container Image. description: This setting can be omitted if was already provided at Pool creation. workingDirectory: type: string title: The location of the container Task working directory. description: The default is 'taskWorkingDirectory'. enum: - taskWorkingDirectory - containerImageDefault x-ms-enum: name: ContainerWorkingDirectory modelAsString: false values: - value: taskWorkingDirectory description: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. - value: containerImageDefault description: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. required: - imageName title: The container settings for a Task. CloudTaskListResult: properties: value: type: array items: $ref: '#/definitions/CloudTask' title: The list of Tasks. odata.nextLink: type: string title: The URL to get the next set of results. title: The result of listing the Tasks in a Job. OutputFileUploadOptions: properties: uploadCondition: title: The conditions under which the Task output file or set of files should be uploaded. description: The default is taskcompletion. $ref: '#/definitions/OutputFileUploadCondition' required: - uploadCondition title: Details about an output file upload operation, including under what conditions to perform the upload. TaskResourceProperties: description: Task properties. type: object properties: startedAt: description: The time the task started type: string completedAt: description: The time the task completed type: string lastPolledAt: description: The last time the task was polled type: string state: description: the state the task is in type: string phase: description: the phase the task is in type: string reason: description: The reason the task was moved into its current state, if the task wasn't completed. type: string metadata: description: The reason the task was moved into its current state, if the task wasn't completed. type: object allOf: - $ref: '#/definitions/ResourceBaseProperties' TaskAddResult: properties: status: type: string title: The status of the add Task request. enum: - success - clienterror - servererror x-ms-enum: name: TaskAddStatus modelAsString: false values: - value: success description: The Task was added successfully. - value: clienterror description: The Task failed to add due to a client error and should not be retried without modifying the request as appropriate. name: clientError - value: servererror description: Task failed to add due to a server error and can be retried without modification. name: serverError taskId: type: string title: The ID of the Task for which this is the result. eTag: type: string title: The ETag of the Task, if the Task was successfully added. description: You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime. lastModified: type: string format: date-time title: The last modified time of the Task. location: type: string title: The URL of the Task, if the Task was successfully added. error: $ref: '#/definitions/BatchError' title: The error encountered while attempting to add the Task. required: - status - taskId title: Result for a single Task added as part of an add Task collection operation. Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error OutputFile: properties: filePattern: type: string title: A pattern indicating which file(s) to upload. description: 'Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\*.txt matches any file that does not start in ''.'' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied.' destination: title: The destination for the output file(s). $ref: '#/definitions/OutputFileDestination' uploadOptions: title: Additional options for the upload operation, including under what conditions to perform the upload. $ref: '#/definitions/OutputFileUploadOptions' required: - filePattern - destination - uploadOptions title: A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process. description: On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure. AutoUserSpecification: properties: scope: type: string title: The scope for the auto user description: The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks. enum: - task - pool x-ms-enum: name: AutoUserScope modelAsString: false values: - value: task description: Specifies that the service should create a new user for the Task. - value: pool description: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. elevationLevel: title: The elevation level of the auto user. description: The default value is nonAdmin. $ref: '#/definitions/ElevationLevel' title: Specifies the parameters for the auto user that runs a Task on the Batch service. SubtaskInformation: properties: id: type: integer format: int32 title: The ID of the subtask. nodeInfo: $ref: '#/definitions/ComputeNodeInformation' title: Information about the Compute Node on which the subtask ran. startTime: type: string format: date-time title: The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running. endTime: type: string format: date-time title: The time at which the subtask completed. description: This property is set only if the subtask is in the Completed state. exitCode: type: integer format: int32 title: The exit code of the program specified on the subtask command line. description: This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/definitions/TaskContainerExecutionInformation' title: Information about the container under which the Task is executing. description: This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/TaskFailureInformation' title: Information describing the Task failure, if any. description: This property is set only if the Task is in the completed state and encountered a failure. state: title: The current state of the subtask. $ref: '#/definitions/SubtaskState' stateTransitionTime: type: string format: date-time title: The time at which the subtask entered its current state. previousState: title: The previous state of the subtask. description: This property is not set if the subtask is in its initial running state. $ref: '#/definitions/SubtaskState' previousStateTransitionTime: type: string format: date-time title: The time at which the subtask entered its previous state. description: This property is not set if the subtask is in its initial running state. result: $ref: '#/definitions/TaskExecutionResult' title: The result of the Task execution. description: If the value is 'failed', then the details of the failure can be found in the failureInfo property. title: Information about an Azure Batch subtask. BatchError: properties: code: type: string title: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/ErrorMessage' title: A message describing the error, intended to be suitable for display in a user interface. values: type: array items: $ref: '#/definitions/BatchErrorDetail' title: A collection of key-value pairs containing additional details about the error. title: An error response received from the Azure Batch service. Task: type: object properties: id: type: string description: The unique identifier of the task. readOnly: true startedAt: type: string format: date-time description: The time the task started. completedAt: type: string format: date-time description: The time the task completed. lastPolledAt: type: string format: date-time description: The last time the status of the task was updated. state: $ref: '#/definitions/TaskState_2' description: The state the task is in. phase: $ref: '#/definitions/TaskPhase' description: The phase the task is in. reason: type: string description: The reason the task was moved into its current state, if the task wasn't completed. metadata: type: object description: Attributes unique to the task. This differs by task type. additionalProperties: {} required: - id ContainerRegistry: properties: registryServer: type: string title: The registry URL. description: If omitted, the default is "docker.io". username: type: string x-ms-client-name: userName title: The user name to log into the registry server. password: type: string title: The password to log into the registry server. required: - username - password title: A private container registry. AuthenticationTokenSettings: properties: access: type: array items: type: string x-nullable: false enum: - job x-ms-enum: name: AccessScope modelAsString: false values: - value: job description: Grants access to perform all operations on the Job containing the Task. title: The Batch resources to which the token grants access. description: The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task. title: The settings for an authentication token that the Task can use to perform Batch service operations. CloudTaskListSubtasksResult: properties: value: type: array items: $ref: '#/definitions/SubtaskInformation' title: The list of subtasks. title: The result of listing the subtasks of a Task. MultiInstanceSettings: properties: numberOfInstances: type: integer format: int32 title: The number of Compute Nodes required by the Task. description: If omitted, the default is 1. coordinationCommandLine: type: string title: The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command. description: A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages. commonResourceFiles: type: array items: $ref: '#/definitions/ResourceFile' title: A list of files that the Batch service will download before running the coordination command line. description: The difference between common resource files and Task resource files is that common resource files are downloaded for all subtasks including the primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. required: - coordinationCommandLine title: Settings which specify how to run a multi-instance Task. description: Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit. EnvironmentSetting: properties: name: type: string title: The name of the environment variable. value: type: string title: The value of the environment variable. required: - name title: An environment variable to be set on a Task process. ComputeNodeInformation: properties: affinityId: type: string title: An identifier for the Node on which the Task ran, which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. nodeUrl: type: string title: 'The URL of the Compute Node on which the Task ran. ' poolId: type: string title: The ID of the Pool on which the Task ran. nodeId: type: string title: The ID of the Compute Node on which the Task ran. taskRootDirectory: type: string title: The root directory of the Task on the Compute Node. taskRootDirectoryUrl: type: string title: The URL to the root directory of the Task on the Compute Node. title: Information about the Compute Node on which a Task ran. OutputFileDestination: properties: container: title: A location in Azure blob storage to which files are uploaded. $ref: '#/definitions/OutputFileBlobContainerDestination' title: The destination to which a file should be uploaded. CloudTask: properties: id: type: string title: A string that uniquely identifies the Task within the Job. description: The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. displayName: type: string title: A display name for the Task. description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. url: type: string title: The URL of the Task. eTag: type: string title: The ETag of the Task. description: This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime. lastModified: type: string format: date-time title: The last modified time of the Task. creationTime: type: string format: date-time title: The creation time of the Task. exitConditions: $ref: '#/definitions/ExitConditions' description: How the Batch service should respond when the Task completes. state: title: The current state of the Task. $ref: '#/definitions/TaskState' stateTransitionTime: type: string format: date-time title: The time at which the Task entered its current state. previousState: title: The previous state of the Task. description: This property is not set if the Task is in its initial Active state. $ref: '#/definitions/TaskState' previousStateTransitionTime: type: string format: date-time title: The time at which the Task entered its previous state. description: This property is not set if the Task is in its initial Active state. commandLine: type: string title: The command line of the Task. description: For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/TaskContainerSettings' title: The settings for the container under which the Task runs. description: If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. resourceFiles: type: array items: $ref: '#/definitions/ResourceFile' title: A list of files that the Batch service will download to the Compute Node before running the command line. description: For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. outputFiles: type: array items: $ref: '#/definitions/OutputFile' title: A list of files that the Batch service will upload from the Compute Node after running the command line. description: For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. environmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting' title: A list of environment variable settings for the Task. affinityInfo: $ref: '#/definitions/AffinityInformation' title: A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. constraints: $ref: '#/definitions/TaskConstraints' title: The execution constraints that apply to this Task. requiredSlots: type: integer format: int32 title: The number of scheduling slots that the Task requires to run. description: The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. userIdentity: $ref: '#/definitions/UserIdentity' title: The user identity under which the Task runs. description: If omitted, the Task runs as a non-administrative user unique to the Task. executionInfo: $ref: '#/definitions/TaskExecutionInformation' title: Information about the execution of the Task. nodeInfo: $ref: '#/definitions/ComputeNodeInformation' title: Information about the Compute Node on which the Task ran. multiInstanceSettings: $ref: '#/definitions/MultiInstanceSettings' title: An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task. stats: $ref: '#/definitions/TaskStatistics' title: Resource usage statistics for the Task. dependsOn: $ref: '#/definitions/TaskDependencies' title: The Tasks that this Task depends on. description: This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. applicationPackageReferences: type: array items: $ref: '#/definitions/ApplicationPackageReference' title: A list of Packages that the Batch service will deploy to the Compute Node before running the command line. description: Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails. authenticationTokenSettings: title: The settings for an authentication token that the Task can use to perform Batch service operations. description: If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. $ref: '#/definitions/AuthenticationTokenSettings' title: An Azure Batch Task. 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. ElevationLevel: type: string title: The elevation level of the user. enum: - nonadmin - admin x-ms-enum: name: ElevationLevel modelAsString: false values: - value: nonadmin description: The user is a standard user without elevated access. name: nonAdmin - value: admin description: The user is a user with elevated access and operates with full Administrator permissions. ExitConditions: properties: exitCodes: type: array items: $ref: '#/definitions/ExitCodeMapping' title: A list of individual Task exit codes and how the Batch service should respond to them. exitCodeRanges: type: array items: $ref: '#/definitions/ExitCodeRangeMapping' title: A list of Task exit code ranges and how the Batch service should respond to them. preProcessingError: $ref: '#/definitions/ExitOptions' title: How the Batch service should respond if the Task fails to start due to an error. fileUploadError: $ref: '#/definitions/ExitOptions' title: How the Batch service should respond if a file upload error occurs. description: If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence. default: $ref: '#/definitions/ExitOptions' title: How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties. description: This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection. title: Specifies how the Batch service should respond when the Task completes. SubtaskState: type: string title: The state of the subtask. enum: - preparing - running - completed x-ms-enum: name: SubtaskState modelAsString: false values: - value: preparing description: The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. - value: running description: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing. - value: completed description: The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated. TaskIdRange: properties: start: type: integer format: int32 title: The first Task ID in the range. end: type: integer format: int32 title: The last Task ID in the range. title: A range of Task IDs that a Task can depend on. All Tasks with IDs in the range must complete successfully before the dependent Task can be scheduled. description: The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'. required: - start - end TaskUpdateParameter: properties: constraints: $ref: '#/definitions/TaskConstraints' title: Constraints that apply to this Task. description: If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks. title: The set of changes to be made to a Task. TaskAddCollectionResult: properties: value: type: array items: $ref: '#/definitions/TaskAddResult' title: The results of the add Task collection operation. title: The result of adding a collection of Tasks to a Job. Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. TaskFailureInformation: properties: category: title: The category of the Task error. $ref: '#/definitions/ErrorCategory' code: type: string title: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. message: type: string title: A message describing the Task error, intended to be suitable for display in a user interface. details: type: array items: $ref: '#/definitions/NameValuePair' title: A list of additional details related to the error. required: - category title: Information about a Task failure. TaskAddParameter: properties: id: type: string title: A string that uniquely identifies the Task within the Job. description: The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a Job that differ only by case). displayName: type: string title: A display name for the Task. description: The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. commandLine: type: string title: The command line of the Task. description: For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). containerSettings: $ref: '#/definitions/TaskContainerSettings' title: The settings for the container under which the Task runs. description: If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. exitConditions: $ref: '#/definitions/ExitConditions' description: How the Batch service should respond when the Task completes. resourceFiles: type: array items: $ref: '#/definitions/ResourceFile' title: A list of files that the Batch service will download to the Compute Node before running the command line. description: For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. outputFiles: type: array items: $ref: '#/definitions/OutputFile' title: A list of files that the Batch service will upload from the Compute Node after running the command line. description: For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. environmentSettings: type: array items: $ref: '#/definitions/EnvironmentSetting' title: A list of environment variable settings for the Task. affinityInfo: $ref: '#/definitions/AffinityInformation' title: A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. constraints: $ref: '#/definitions/TaskConstraints' title: The execution constraints that apply to this Task. description: If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days. requiredSlots: type: integer format: int32 title: The number of scheduling slots that the Task required to run. description: The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. userIdentity: $ref: '#/definitions/UserIdentity' title: The user identity under which the Task runs. description: If omitted, the Task runs as a non-administrative user unique to the Task. multiInstanceSettings: $ref: '#/definitions/MultiInstanceSettings' title: An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task. dependsOn: $ref: '#/definitions/TaskDependencies' title: The Tasks that this Task depends on. description: This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. If the Job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob. applicationPackageReferences: type: array items: $ref: '#/definitions/ApplicationPackageReference' title: A list of Packages that the Batch service will deploy to the Compute Node before running the command line. description: Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails. authenticationTokenSettings: title: The settings for an authentication token that the Task can use to perform Batch service operations. description: If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. $ref: '#/definitions/AuthenticationTokenSettings' required: - id - commandLine title: An Azure Batch Task to add. 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. AffinityInformation: properties: affinityId: type: string title: An opaque string representing the location of a Compute Node or a Task that has run previously. description: You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. required: - affinityId title: A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task. TaskState: type: string title: The state of the Task. enum: - active - preparing - running - completed x-ms-enum: name: TaskState modelAsString: false values: - value: active description: The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run. - value: preparing description: The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. - value: running description: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing. - value: completed description: The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated. ResourceFile: properties: autoStorageContainerName: type: string title: The storage container name in the auto storage Account. description: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. storageContainerUrl: type: string title: The URL of the blob container within Azure Blob Storage. description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, or set the ACL for the container to allow public access.' httpUrl: type: string title: The URL of the file to download. description: 'The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.' blobPrefix: type: string title: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. description: The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. filePath: type: string title: The location on the Compute Node to which to download the file(s), relative to the Task's working directory. description: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). fileMode: type: string title: The file permission mode attribute in octal format. description: This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. title: A single file or multiple files to be downloaded to a Compute Node. PagedTask: type: object description: Paged collection of Task items properties: value: type: array description: The Task items on this page items: $ref: '#/definitions/Task' nextLink: type: string format: uri description: The link to the next page of items totalElements: type: integer format: int64 description: The total number of items available in the full result set. required: - value TaskExecutionResult: type: string title: The result of Task execution. enum: - success - failure x-ms-enum: name: TaskExecutionResult modelAsString: false values: - value: success description: The Task ran successfully. name: success - value: failure description: There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited. name: failure TaskDependencies: properties: taskIds: type: array items: type: string title: The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent Task can be scheduled. description: The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using Task ID ranges instead. taskIdRanges: type: array items: $ref: '#/definitions/TaskIdRange' title: The list of Task ID ranges that this Task depends on. All Tasks in all ranges must complete successfully before the dependent Task can be scheduled. title: Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled. TaskContainerExecutionInformation: properties: containerId: type: string title: The ID of the container. state: type: string title: The state of the container. description: This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect". error: type: string title: Detailed error information about the container. description: This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect". title: Contains information about the container which a Task is executing. TaskPhase: type: string description: The phase the task is in. enum: - running - polling - complete x-ms-enum: name: TaskPhase modelAsString: true ErrorResponse: properties: error: $ref: '#/definitions/ErrorDetail' required: - error type: object ExitCodeMapping: properties: code: type: integer format: int32 title: A process exit code. exitOptions: $ref: '#/definitions/ExitOptions' title: How the Batch service should respond if the Task exits with this exit code. title: How the Batch service should respond if a Task exits with a particular exit code. required: - code - exitOptions OutputFileBlobContainerDestination: properties: path: type: string title: The destination blob or virtual directory within the Azure Storage container. description: If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name. containerUrl: type: string title: The URL of the container within Azure Blob Storage to which to upload the file(s). description: The URL must include a Shared Access Signature (SAS) granting write permissions to the container. required: - containerUrl title: Specifies a file upload destination within an Azure blob storage container. ErrorCategory: type: string title: The category of the error. enum: - usererror - servererror x-ms-enum: name: ErrorCategory modelAsString: false values: - value: usererror description: The error is due to a user issue, such as misconfiguration. name: userError - value: servererror description: The error is due to an internal server issue. name: serverError ResourceBaseProperties: description: Resource base properties. type: object properties: provisioningState: description: Resource provisioning state. $ref: '#/definitions/ResourceState' readOnly: true ExitCodeRangeMapping: properties: start: type: integer format: int32 title: The first exit code in the range. end: type: integer format: int32 title: The last exit code in the range. exitOptions: $ref: '#/definitions/ExitOptions' title: How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive). title: A range of exit codes and how the Batch service should respond to exit codes within that range. required: - start - end - exitOptions TaskResource: type: object description: Task details properties: properties: description: Task properties $ref: '#/definitions/TaskResourceProperties' x-ms-client-flatten: true allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource x-ms-azure-resource: true ExitOptions: properties: jobAction: type: string title: An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'. description: The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). enum: - none - disable - terminate x-ms-enum: name: JobAction modelAsString: false values: - value: none description: Take no action. - value: disable description: Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks value of requeue. - value: terminate description: Terminate the Job. The terminateReason in the Job's executionInfo is set to "TaskFailed". dependencyAction: type: string title: An action that the Batch service performs on Tasks that depend on this Task. description: Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks. enum: - satisfy - block x-ms-enum: name: DependencyAction modelAsString: false values: - value: satisfy description: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. - value: block description: Blocks tasks waiting on this task, preventing them from being scheduled. title: Specifies how the Batch service responds to a particular exit condition. ResourceState: description: Resources provisioning states. enum: - NotSpecified - Accepted - Creating - Succeeded - Failed - Canceled - ProvisioningResources - InstallingApplication - ConfiguringApplication - MigratingApplicationData - RunningValidations - CreatingArtifacts - DeletingArtifacts type: string x-ms-enum: name: ResourceState modelAsString: true NameValuePair: properties: name: type: string title: The name in the name-value pair. value: type: string title: The value in the name-value pair. title: Represents a name-value pair. TaskConstraints: properties: maxWallClockTime: type: string format: duration title: The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. description: If this is not specified, there is no time limit on how long the Task may run. retentionTime: type: string format: duration title: The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. description: The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted. maxTaskRetryCount: type: integer format: int32 title: The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. description: Note that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit. title: Execution constraints to apply to a Task. InnerError: description: This is an object containing more specific information than the current object about the error. properties: code: description: This is a more specific error code than was provided by the containing error.. type: string type: object TaskExecutionInformation: properties: startTime: type: string format: date-time title: The time at which the Task started running. description: '''Running'' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state.' endTime: type: string format: date-time title: The time at which the Task completed. description: This property is set only if the Task is in the Completed state. exitCode: type: integer format: int32 title: The exit code of the program specified on the Task command line. description: This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code. containerInfo: $ref: '#/definitions/TaskContainerExecutionInformation' title: Information about the container under which the Task is executing. description: This property is set only if the Task runs in a container context. failureInfo: $ref: '#/definitions/TaskFailureInformation' title: Information describing the Task failure, if any. description: This property is set only if the Task is in the completed state and encountered a failure. retryCount: type: integer format: int32 title: The number of times the Task has been retried by the Batch service. description: Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. lastRetryTime: type: string format: date-time title: The most recent time at which a retry of the Task started running. description: This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. requeueCount: type: integer format: int32 title: The number of times the Task has been requeued by the Batch service as the result of a user request. description: When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons. lastRequeueTime: type: string format: date-time title: The most recent time at which the Task has been requeued by the Batch service as the result of a user request. description: This property is set only if the requeueCount is nonzero. result: $ref: '#/definitions/TaskExecutionResult' title: The result of the Task execution. description: If the value is 'failed', then the details of the failure can be found in the failureInfo property. required: - requeueCount - retryCount title: Information about the execution of a Task. BatchErrorDetail: properties: key: type: string title: An identifier specifying the meaning of the Value property. value: type: string title: The additional information included with the error response. title: An item of additional information included in an Azure Batch error response. parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client API Version. TaskIdParameter_2: name: taskId in: path required: true type: string description: The id of the Task. x-ms-parameter-location: method TaskIdParameter: in: path name: taskId required: true type: string x-ms-parameter-location: method FilterParameter: description: An expression on the resource type that selects the resources to be returned. in: query name: filter required: false type: string x-ms-parameter-location: method Azure.Core.FilterQueryParameter: name: filter in: query description: Filter the result list using the given expression. required: false type: string x-ms-parameter-location: method Azure.Core.MaxPageSizeQueryParameter: name: maxpagesize in: query description: The maximum number of result items per page. required: false type: integer format: int32 x-ms-parameter-location: method MaxPageSizeParameter: default: 20 description: An offset into the collection of the first resource to be returned. format: int32 in: query name: maxpagesize required: false type: integer x-ms-parameter-location: method Azure.Core.SkipQueryParameter: name: skip in: query description: The number of result items to skip. required: false type: integer format: int32 default: 0 x-ms-parameter-location: method WorkspaceNameParameter: description: The name of the Workspace. in: path name: workspaceName required: true type: string x-ms-parameter-location: method SkipParameter: default: 0 description: An offset into the collection of the first resource to be returned. format: int32 in: query name: skip required: false type: integer x-ms-parameter-location: method OrderByParameter: name: orderby in: query description: A list of expressions that specify the order of the returned resources. required: false type: string x-ms-parameter-location: method Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'