Microsoft Azure Jobs API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Jobs API
tags:
- name: Jobs
paths:
  /jobs:
    get:
      operationId: microsoftAzureBatchListjobs
      summary: Microsoft Azure Lists All Of The Jobs In The Specified Account
      description: Lists all of the Jobs in the specified Account.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: maxresults
        in: query
        description: 'The maximum number of items to return in the response. A maximum of 1000

          applications can be returned.'
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
          maximum: 1000
          minimum: 1
      - name: $filter
        in: query
        description: 'An OData $filter clause. For more information on constructing this filter, see

          https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.'
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: An OData $select clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: An OData $expand clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Job list:
          $ref: ./examples/JobList.json
      x-ms-pageable:
        nextLinkName: odata.nextLink
      tags:
      - Jobs
    post:
      operationId: microsoftAzureBatchCreatejob
      summary: Microsoft Azure Creates A Job To The Specified Account
      description: 'The Batch service supports two ways to control the work done as part of a Job.<br>In the first approach, the user specifies a Job Manager Task. The Batch service<br>launches this Task when it is ready to start the Job. The Job Manager Task<br>controls all other Tasks that run under this Job, by using the Task APIs. In<br>the second approach, the user directly controls the execution of Tasks under an<br>active Job, by using the Task APIs. Also note: when naming Jobs, avoid<br>including sensitive information such as user names or secret project names.<br>This information may appear in telemetry logs accessible to Microsoft Support<br>engineers.'
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Creates a basic job:
          $ref: ./examples/JobCreate_Basic.json
        Creates a complex job:
          $ref: ./examples/JobCreate_Complex.json
      tags:
      - Jobs
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchJobCreateContent'
        description: The Job to be created.
        required: true
  /jobs/{jobId}:
    get:
      operationId: microsoftAzureBatchGetjob
      summary: Microsoft Azure Gets Information About The Specified Job
      description: Gets information about the specified Job.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: jobId
        in: path
        description: The ID of the Job.
        required: true
        schema:
          type: string
      - name: $select
        in: query
        description: An OData $select clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: An OData $expand clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJob'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Job get:
          $ref: ./examples/JobGet.json
      tags:
      - Jobs
    put:
      operationId: microsoftAzureBatchReplacejob
      summary: Microsoft Azure Updates The Properties Of The Specified Job
      description: This fully replaces all the updatable properties of the Job. For example, if<br>the Job has constraints associated with it and if constraints is not specified<br>with this request, then the Batch service will remove the existing constraints.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: jobId
        in: path
        description: The ID of the Job whose properties you want to update.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Job update:
          $ref: ./examples/JobUpdate.json
      tags:
      - Jobs
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchJob'
        description: A job with updated properties
        required: true
    patch:
      operationId: microsoftAzureBatchUpdatejob
      summary: Microsoft Azure Updates The Properties Of The Specified Job
      description: This replaces only the Job properties specified in the request. For example, if<br>the Job has constraints, and a request does not specify the constraints<br>element, then the Job keeps the existing constraints.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: jobId
        in: path
        description: The ID of the Job whose properties you want to update.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Job patch:
          $ref: ./examples/JobPatch.json
      tags:
      - Jobs
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchJobUpdateContent'
        description: The options to use for updating the Job.
        required: true
    delete:
      operationId: microsoftAzureBatchDeletejob
      summary: Microsoft Azure Deletes A Job
      description: Deleting a Job also deletes all Tasks that are part of that Job, and all Job<br>statistics. This also overrides the retention period for Task data; that is, if<br>the Job contains Tasks which are still retained on Compute Nodes, the Batch<br>services deletes those Tasks' working directories and all their contents.  When<br>a Delete Job request is received, the Batch service sets the Job to the<br>deleting state. All update operations on a Job that is in deleting state will<br>fail with status code 409 (Conflict), with additional information indicating<br>that the Job is being deleted.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a GUID with no decoration

          such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
        required: false
        x-ms-client-name: clientRequestId
        schema:
          type: string
      - name: return-client-request-id
        in: header
        description: Whether the server should return the client-request-id in the response.
        required: false
        x-ms-client-name: returnClientRequestId
        schema:
          type: boolean
          default: false
      - name: ocp-date
        in: header
        description: 'The time the request was issued. Client libraries typically set this to the

          current system clock time; set it explicitly if you are calling the REST API

          directly.'
        required: false
        x-ms-client-name: ocpdate
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Modified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          been modified since the specified time.'
        required: false
        x-ms-client-name: ifModifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Unmodified-Since
        in: header
        description: 'A timestamp indicating the last modified time of the resource known to the

          client. The operation will be performed only if the resource on the service has

          not been modified since the specified time.'
        required: false
        x-ms-client-name: ifUnmodifiedSince
        schema:
          type: string
          format: date-time-rfc7231
      - name: If-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service exactly matches the value specified by the client.'
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 'An ETag value associated with the version of the resource known to the client.

          The operation will be performed only if the resource''s current ETag on the

          service does not match the value specified by the client.'
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: jobId
        in: path
        description: The ID of the Job to delete.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        Delete Job:
          $ref: ./examples/JobDelete.json
      tags:
      - Jobs
  /jobs/{jobId}/addtaskcollection:
    post:
      operationId: microsoftAzureBatchCreatetaskcollection
      summary: Microsoft Azure Adds A Collection Of Tasks To The Specified Job
      description: Note that each Task must have a unique ID. The Batch service may not return the<br>results for each Task in the same order the Tasks were submitted in this<br>request. If the server times out or the connection is closed during the<br>request, the request may have been partially or fully processed, or not at all.<br>In such cases, the user should re-issue the request. Note that it is up to the<br>user to correctly handle failures when re-issuing a reque

# --- truncated at 32 KB (649 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-jobs-api-openapi.yml