Microsoft Azure Azure Batch — Jobs

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Azure Batch — Jobs
  description: 'Microsoft Azure Azure Batch — Jobs. 24 operations. Lead operation: Microsoft Azure Lists All Of The Jobs In
    The Specified Account. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Jobs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: azure-batch-jobs
    baseUri: ''
    description: Microsoft Azure Azure Batch — Jobs business capability. Self-contained, no shared references.
    resources:
    - name: jobs
      path: /jobs
      operations:
      - name: microsoftazurebatchlistjobs
        method: GET
        description: Microsoft Azure Lists All Of The Jobs In The Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000
        - name: $filter
          in: query
          type: string
          description: An OData $filter clause. For more information on constructing this filter, see
        - name: $select
          in: query
          type: array
          description: An OData $select clause.
        - name: $expand
          in: query
          type: array
          description: An OData $expand clause.
      - name: microsoftazurebatchcreatejob
        method: POST
        description: Microsoft Azure Creates A Job To The Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: job
          in: body
          type: string
          description: The Job to be created.
          required: true
    - name: jobs-jobId
      path: /jobs/{jobId}
      operations:
      - name: microsoftazurebatchgetjob
        method: GET
        description: Microsoft Azure Gets Information About The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job.
          required: true
        - name: $select
          in: query
          type: array
          description: An OData $select clause.
        - name: $expand
          in: query
          type: array
          description: An OData $expand clause.
      - name: microsoftazurebatchreplacejob
        method: PUT
        description: Microsoft Azure Updates The Properties Of The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job whose properties you want to update.
          required: true
        - name: job
          in: body
          type: string
          description: A job with updated properties
          required: true
      - name: microsoftazurebatchupdatejob
        method: PATCH
        description: Microsoft Azure Updates The Properties Of The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job whose properties you want to update.
          required: true
        - name: job
          in: body
          type: string
          description: The options to use for updating the Job.
          required: true
      - name: microsoftazurebatchdeletejob
        method: DELETE
        description: Microsoft Azure Deletes A Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to delete.
          required: true
    - name: jobs-jobId-addtaskcollection
      path: /jobs/{jobId}/addtaskcollection
      operations:
      - name: microsoftazurebatchcreatetaskcollection
        method: POST
        description: Microsoft Azure Adds A Collection Of Tasks To The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to which the Task collection is to be added.
          required: true
        - name: taskCollection
          in: body
          type: string
          description: The Tasks to be added.
          required: true
    - name: jobs-jobId-disable
      path: /jobs/{jobId}/disable
      operations:
      - name: microsoftazurebatchdisablejob
        method: POST
        description: Microsoft Azure Disables The Specified Job, Preventing New Tasks From Running
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to disable.
          required: true
        - name: content
          in: body
          type: string
          description: The options to use for disabling the Job.
          required: true
    - name: jobs-jobId-enable
      path: /jobs/{jobId}/enable
      operations:
      - name: microsoftazurebatchenablejob
        method: POST
        description: Microsoft Azure Enables The Specified Job, Allowing New Tasks To Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to enable.
          required: true
    - name: jobs-jobId-jobpreparationandreleasetaskstatus
      path: /jobs/{jobId}/jobpreparationandreleasetaskstatus
      operations:
      - name: microsoftazurebatchlistjobpreparationandreleasetaskstatus
        method: GET
        description: Microsoft Azure Lists The Execution Status Of The Job Preparation And Job Release Task For The
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000
        - name: jobId
          in: path
          type: string
          description: The ID of the Job.
          required: true
        - name: $filter
          in: query
          type: string
          description: An OData $filter clause. For more information on constructing this filter, see
        - name: $select
          in: query
          type: array
          description: An OData $select clause.
    - name: jobs-jobId-taskcounts
      path: /jobs/{jobId}/taskcounts
      operations:
      - name: microsoftazurebatchgetjobtaskcounts
        method: GET
        description: Microsoft Azure Gets The Task Counts For The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: jobId
          in: path
          type: string
          description: The ID of the Job.
          required: true
    - name: jobs-jobId-tasks
      path: /jobs/{jobId}/tasks
      operations:
      - name: microsoftazurebatchlisttasks
        method: GET
        description: Microsoft Azure Lists All Of The Tasks That Are Associated With The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000
        - name: jobId
          in: path
          type: string
          description: The ID of the Job.
          required: true
        - name: $filter
          in: query
          type: string
          description: An OData $filter clause. For more information on constructing this filter, see
        - name: $select
          in: query
          type: array
          description: An OData $select clause.
        - name: $expand
          in: query
          type: array
          description: An OData $expand clause.
      - name: microsoftazurebatchcreatetask
        method: POST
        description: Microsoft Azure Creates A Task To The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to which the Task is to be created.
          required: true
        - name: task
          in: body
          type: string
          description: The Task to be created.
          required: true
    - name: jobs-jobId-tasks-taskId
      path: /jobs/{jobId}/tasks/{taskId}
      operations:
      - name: microsoftazurebatchgettask
        method: GET
        description: Microsoft Azure Gets Information About The Specified Task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job that contains the Task.
          required: true
        - name: taskId
          in: path
          type: string
          description: The ID of the Task to get information about.
          required: true
        - name: $select
          in: query
          type: array
          description: An OData $select clause.
        - name: $expand
          in: query
          type: array
          description: An OData $expand clause.
      - name: microsoftazurebatchreplacetask
        method: PUT
        description: Microsoft Azure Put Jobs Jobid Tasks Taskid
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job containing the Task.
          required: true
        - name: taskId
          in: path
          type: string
          description: The ID of the Task to update.
          required: true
        - name: task
          in: body
          type: string
          description: The Task to update.
          required: true
      - name: microsoftazurebatchdeletetask
        method: DELETE
        description: Microsoft Azure Deletes A Task From The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: If-Modified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Unmodified-Since
          in: header
          type: string
          description: A timestamp indicating the last modified time of the resource known to the
        - name: If-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: If-None-Match
          in: header
          type: string
          description: An ETag value associated with the version of the resource known to the client.
        - name: jobId
          in: path
          type: string
          description: The ID of the Job from which to delete the Task.
          required: true
        - name: taskId
          in: path
          type: string
          description: The ID of the Task to delete.
          required: true
    - name: jobs-jobId-tasks-taskId-files
      path: /jobs/{jobId}/tasks/{taskId}/files
      operations:
      - name: microsoftazurebatchlisttaskfiles
        method: GET
        description: Microsoft Azure Lists The Files In A Task S Directory On Its Compute Node
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: timeOut
          in: query
          type: integer
          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 us
        - name: client-request-id
          in: header
          type: string
          description: The caller-generated request identity, in the form of a GUID with no decoration
        - name: return-client-request-id
          in: header
          type: boolean
          description: Whether the server should return the client-request-id in the response.
        - name: ocp-date
          in: header
          type: string
          description: The time the request was issued. Client libraries typically set this to the
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000
        - name: jobId
          in: path
          type: string
          description: The ID of the Job that contains the Task.
          required: true
        - name: taskId
          in: path
          type: string
          description: The ID of the Task whose files you want to list.
          required: true
        - name: $filter
          in: query
          type: string
          description: An OData $filter clause. For more information on constructing this filter, see
        - name: recursive
          in: query
          type: boolean
          description: Whether to list children 

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/capabilities/azure-batch-jobs.yaml