Microsoft Azure Jobschedules API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Jobschedules API
tags:
- name: Jobschedules
paths:
  /jobschedules:
    get:
      operationId: microsoftAzureBatchListjobschedules
      summary: Microsoft Azure Lists All Of The Job Schedules In The Specified Account
      description: Lists all of the Job Schedules in the specified Account.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          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-job-schedules.'
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: An OData $select clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: An OData $expand clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobScheduleListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        JobSchedule list:
          $ref: ./examples/JobScheduleList.json
      x-ms-pageable:
        nextLinkName: odata.nextLink
      tags:
      - Jobschedules
    post:
      operationId: microsoftAzureBatchCreatejobschedule
      summary: Microsoft Azure Creates A Job Schedule To The Specified Account
      description: Creates a Job Schedule to the specified Account.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          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 JobSchedule:
          $ref: ./examples/JobScheduleCreate_Basic.json
        Creates a complex JobScheduleAdd:
          $ref: ./examples/JobScheduleCreate_Complex.json
      tags:
      - Jobschedules
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchJobScheduleCreateContent'
        description: The Job Schedule to be created.
        required: true
  /jobschedules/{jobScheduleId}:
    get:
      operationId: microsoftAzureBatchGetjobschedule
      description: Gets information about the specified Job Schedule.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          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: jobScheduleId
        in: path
        description: The ID of the Job Schedule to get.
        required: true
        schema:
          type: string
      - name: $select
        in: query
        description: An OData $select clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: An OData $expand clause.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobSchedule'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        JobSchedule get:
          $ref: ./examples/JobScheduleGet.json
      summary: Microsoft Azure Get Jobschedules Jobscheduleid
      tags:
      - Jobschedules
    put:
      operationId: microsoftAzureBatchReplacejobschedule
      summary: Microsoft Azure Updates The Properties Of The Specified Job Schedule
      description: This fully replaces all the updatable properties of the Job Schedule. For<br>example, if the schedule property is not specified with this request, then the<br>Batch service will remove the existing schedule. Changes to a Job Schedule only<br>impact Jobs created by the schedule after the update has taken place; currently<br>running Jobs are unaffected.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          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: jobScheduleId
        in: path
        description: The ID of the Job Schedule to update.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        JobSchedule update:
          $ref: ./examples/JobScheduleUpdate.json
      tags:
      - Jobschedules
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchJobSchedule'
        description: A Job Schedule with updated properties
        required: true
    patch:
      operationId: microsoftAzureBatchUpdatejobschedule
      summary: Microsoft Azure Updates The Properties Of The Specified Job Schedule
      description: This replaces only the Job Schedule properties specified in the request. For<br>example, if the schedule property is not specified with this request, then the<br>Batch service will keep the existing schedule. Changes to a Job Schedule only<br>impact Jobs created by the schedule after the update has taken place; currently<br>running Jobs are unaffected.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          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: jobScheduleId
        in: path
        description: The ID of the Job Schedule to update.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          headers:
            DataServiceId:
              description: The OData ID of the resource to which the request applied.
              schema:
                type: string
            ETag:
              description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.
              schema:
                type: string
            Last-Modified:
              description: The time at which the resource was last modified.
              schema:
                type: string
                format: date-time-rfc7231
            client-request-id:
              description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.
              schema:
                type: string
            request-id:
              description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchError'
      x-ms-examples:
        JobSchedule patch:
          $ref: ./examples/JobSchedulePatch.json
      tags:
      - Jobschedules
      requestBody:
        content:
          application/json; odata=minimalmetadata:
            schema:
              $ref: '#/components/schemas/BatchJobScheduleUpdateContent'
        description: The options to use for updating the Job Schedule.
        required: true
    delete:
      operationId: microsoftAzureBatchDeletejobschedule
      summary: Microsoft Azure Deletes A Job Schedule From The Specified Account
      description: When you delete a Job Schedule, this also deletes all Jobs and Tasks under that<br>schedule. When Tasks are deleted, all the files in their working directories on<br>the Compute Nodes are also deleted (the retention period is ignored). The Job<br>Schedule statistics are no longer accessible once the Job Schedule is deleted,<br>though they are still counted towards Account lifetime statistics.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          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: jobScheduleId
        in: path
        description: The ID of the Job Schedule 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:
        JobSchedule delete:
          $ref: ./examples/JobScheduleDelete.json
      tags:
      - Jobschedules
    head:
      operationId: microsoftAzureBatchJobscheduleexists
      summary: Microsoft Azure Checks The Specified Job Schedule Exists
      description: Checks the specified Job Schedule exists.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: timeOut
        in: query
        description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".
        required: false
        schema:
          type: integer
          format: int32
          default: 30
      - name: client-request-id
        in: header
        description: 'The caller-generated request identity, in the form of a

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