Microsoft Azure BatchService — Jobs

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure BatchService — Jobs
  description: 'Microsoft Azure BatchService — Jobs. 13 operations. Lead operation: Microsoft Azure Adds A Job To 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: batchservice-jobs
    baseUri: ''
    description: Microsoft Azure BatchService — Jobs business capability. Self-contained, no shared references.
    resources:
    - name: jobs
      path: /jobs
      operations:
      - name: microsoftazurejobadd
        method: POST
        description: Microsoft Azure Adds A Job To The Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: job
          in: body
          type: string
          description: The Job to be added.
          required: true
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
      - name: microsoftazurejoblist
        method: GET
        description: Microsoft Azure Lists All Of The Jobs In The Specified Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: $filter
          in: query
          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#lis
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: $expand
          in: query
          type: string
          description: An OData $expand clause.
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000 Jobs can be returned.
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
    - name: jobs-jobId
      path: /jobs/{jobId}
      operations:
      - name: microsoftazurejobdelete
        method: DELETE
        description: Microsoft Azure Deletes A Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to delete.
          required: true
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
        - name: If-Match
          in: header
          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 servic
        - name: If-None-Match
          in: header
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
      - name: microsoftazurejobget
        method: GET
        description: Microsoft Azure Gets Information About The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job.
          required: true
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: $expand
          in: query
          type: string
          description: An OData $expand clause.
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
        - name: If-Match
          in: header
          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 servic
        - name: If-None-Match
          in: header
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
      - name: microsoftazurejobpatch
        method: PATCH
        description: Microsoft Azure Updates The Properties Of The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job whose properties you want to update.
          required: true
        - name: jobPatchParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
        - name: If-Match
          in: header
          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 servic
        - name: If-None-Match
          in: header
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
      - name: microsoftazurejobupdate
        method: PUT
        description: Microsoft Azure Updates The Properties Of The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job whose properties you want to update.
          required: true
        - name: jobUpdateParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
        - name: If-Match
          in: header
          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 servic
        - name: If-None-Match
          in: header
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: jobs-jobId-disable
      path: /jobs/{jobId}/disable
      operations:
      - name: microsoftazurejobdisable
        method: POST
        description: Microsoft Azure Disables The Specified Job, Preventing New Tasks From Running
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to disable.
          required: true
        - name: jobDisableParameter
          in: body
          type: string
          description: The parameters for the request.
          required: true
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
        - name: If-Match
          in: header
          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 servic
        - name: If-None-Match
          in: header
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: jobs-jobId-enable
      path: /jobs/{jobId}/enable
      operations:
      - name: microsoftazurejobenable
        method: POST
        description: Microsoft Azure Enables The Specified Job, Allowing New Tasks To Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to enable.
          required: true
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
        - name: If-Match
          in: header
          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 servic
        - name: If-None-Match
          in: header
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: jobs-jobId-jobpreparationandreleasetaskstatus
      path: /jobs/{jobId}/jobpreparationandreleasetaskstatus
      operations:
      - name: microsoftazurejoblistpreparationandreleasetaskstatus
        method: GET
        description: Microsoft Azure Lists The Execution Status Of The Job Preparation And Job Release Task For The Specified
          Job Across The Compute Nodes Where The Job Has Run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#lis
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
    - name: jobs-jobId-taskcounts
      path: /jobs/{jobId}/taskcounts
      operations:
      - name: microsoftazurejobgettaskcounts
        method: GET
        description: Microsoft Azure Gets The Task Counts For The Specified Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job.
          required: true
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
    - name: jobs-jobId-terminate
      path: /jobs/{jobId}/terminate
      operations:
      - name: microsoftazurejobterminate
        method: POST
        description: Microsoft Azure Terminates The Specified Job, Marking It As Completed
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: The ID of the Job to terminate.
          required: true
        - name: jobTerminateParameter
          in: body
          type: string
          description: The parameters for the request.
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
        - name: If-Match
          in: header
          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 servic
        - name: If-None-Match
          in: header
          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 servic
        - name: If-Modified-Since
          in: header
          type: string
          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 '
        - name: If-Unmodified-Since
          in: header
          type: string
          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 b
    - name: jobschedules-jobScheduleId-jobs
      path: /jobschedules/{jobScheduleId}/jobs
      operations:
      - name: microsoftazurejoblistfromjobschedule
        method: GET
        description: Microsoft Azure Lists The Jobs That Have Been Created Under The Specified Job Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobScheduleId
          in: path
          type: string
          description: The ID of the Job Schedule from which you want to get a list of Jobs.
          required: true
        - name: $filter
          in: query
          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#lis
        - name: $select
          in: query
          type: string
          description: An OData $select clause.
        - name: $expand
          in: query
          type: string
          description: An OData $expand clause.
        - name: maxresults
          in: query
          type: integer
          description: The maximum number of items to return in the response. A maximum of 1000 Jobs can be returned.
        - 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
    - name: lifetimejobstats
      path: /lifetimejobstats
      operations:
      - name: microsoftazurejobgetalllifetimestatistics
        method: GET
        description: Microsoft Azure Gets Lifetime Summary Statistics For 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.
        - name: client-request-id
          in: header
          type: string
          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.
        - 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 current system clock time;
            set it explicitly if you are calling the REST API directl
  exposes:
  - type: rest
    namespace: batchservice-jobs-rest
    port: 8080
    description: REST adapter for Microsoft Azure BatchService — Jobs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/jobs
      name: jobs
      description: REST surface for jobs.
      operations:
      - method: POST
        name: microsoftazurejobadd
        description: Microsoft Azure Adds A Job To The Specified Account
        call: batchservice-jobs.microsoftazurejobadd
        with:
          job: rest.job
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: microsoftazurejoblist
        description: Microsoft Azure Lists All Of The Jobs In The Specified Account
        call: batchservice-jobs.microsoftazurejoblist
        with:
          $filter: rest.$filter
          $select: rest.$select
          $expand: rest.$expand
          maxresults: rest.maxresults
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{jobid}
      name: jobs-jobid
      description: REST surface for jobs-jobId.
      operations:
      - method: DELETE
        name: microsoftazurejobdelete
        description: Microsoft Azure Deletes A Job
        call: batchservice-jobs.microsoftazurejobdelete
        with:
          jobId: rest.jobId
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
          If-Match: rest.If-Match
          If-None-Match: rest.If-None-Match
          If-Modified-Since: rest.If-Modified-Since
          If-Unmodified-Since: rest.If-Unmodified-Since
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: microsoftazurejobget
        description: Microsoft Azure Gets Information About The Specified Job
        call: batchservice-jobs.microsoftazurejobget
        with:
          jobId: rest.jobId
          $select: rest.$select
          $expand: rest.$expand
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
          If-Match: rest.If-Match
          If-None-Match: rest.If-None-Match
          If-Modified-Since: rest.If-Modified-Since
          If-Unmodified-Since: rest.If-Unmodified-Since
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: microsoftazurejobpatch
        description: Microsoft Azure Updates The Properties Of The Specified Job
        call: batchservice-jobs.microsoftazurejobpatch
        with:
          jobId: rest.jobId
          jobPatchParameter: rest.jobPatchParameter
          timeout: rest.timeout
          client-request-id: rest.client-request-id
          return-client-request-id: rest.return-client-request-id
          ocp-date: rest.ocp-date
          If-Match: rest.If-Match
          If-None-Match: rest.If-None-Match
          If-Modified-Since: rest.If-Modified-Since
          If-Unmodified-Since: rest.If-Unmodified-Since
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
   

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