Microsoft Azure
Microsoft Azure Job API

The Job API from Microsoft Azure — 18 operation(s) for job.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Job API
schemes:
- https
tags:
- name: Job
paths:
  /jobs:
    get:
      tags:
      - Job
      operationId: microsoftAzureJobList
      description: Lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.
      parameters:
      - name: $filter
        in: query
        required: false
        type: string
        description: OData filter. Optional.
      - name: $top
        in: query
        required: false
        type: integer
        format: int32
        minimum: 1
        description: The number of items to return. Optional.
      - name: $skip
        in: query
        required: false
        type: integer
        format: int32
        minimum: 1
        description: The number of items to skip over before returning elements. Optional.
      - name: $select
        in: query
        required: false
        type: string
        description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
      - name: $orderby
        in: query
        required: false
        type: string
        description: OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
      - name: $count
        in: query
        required: false
        type: boolean
        description: The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of jobs.
          schema:
            $ref: '#/definitions/JobInfoListResult'
      x-ms-examples:
        Lists the jobs, if any, associated with the specified Data Lake Analytics account:
          $ref: ./examples/Job_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/JobInformationBasic'
      summary: Microsoft Azure Get Jobs
  /jobs/{jobIdentity}:
    put:
      tags:
      - Job
      operationId: microsoftAzureJobCreate
      description: Submits a job to the specified Data Lake Analytics account.
      parameters:
      - name: jobIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: Job identifier. Uniquely identifies the job across all jobs submitted to the service.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateJobParameters'
        description: The parameters to submit a job.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully submitted the job.
          schema:
            $ref: '#/definitions/JobInformation'
      x-ms-examples:
        Submits a job to the specified Data Lake Analytics account:
          $ref: ./examples/Job_Create.json
      summary: Microsoft Azure Put Jobs Jobidentity
    get:
      tags:
      - Job
      operationId: microsoftAzureJobGet
      description: Gets the job information for the specified job ID.
      parameters:
      - name: jobIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: JobInfo ID.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved details of the specified job.
          schema:
            $ref: '#/definitions/JobInformation'
      x-ms-examples:
        Gets the job information for the specified job ID:
          $ref: ./examples/Job_Get.json
      summary: Microsoft Azure Get Jobs Jobidentity
    patch:
      tags:
      - Job
      operationId: microsoftAzureJobUpdate
      description: Updates the job information for the specified job ID. (Only for use internally with Scope job type.)
      parameters:
      - name: jobIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: Job identifier. Uniquely identifies the job across all jobs submitted to the service.
      - name: parameters
        in: body
        required: false
        schema:
          $ref: '#/definitions/UpdateJobParameters'
        description: The parameters to update a job.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the details of the specified job.
          schema:
            $ref: '#/definitions/JobInformation'
        '201':
          description: Successfully initiated an update of the specified job.
        '202':
          description: Successfully initiated an update of the specified job.
      x-ms-examples:
        Updates the job information for the specified job ID. (Only for use internally with Scope job type.):
          $ref: ./examples/Job_Update.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Jobs Jobidentity
  /jobs/{jobIdentity}/GetStatistics:
    get:
      tags:
      - Job
      operationId: microsoftAzureJobGetstatistics
      description: Gets statistics of the specified job.
      parameters:
      - name: jobIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: Job Information ID.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved job statistics of the specified job.
          schema:
            $ref: '#/definitions/JobStatistics'
      x-ms-examples:
        Gets statistics of the specified job:
          $ref: ./examples/Job_GetStatistics.json
      summary: Microsoft Azure Get Jobs Jobidentity Getstatistics
  /jobs/{jobIdentity}/GetDebugDataPath:
    get:
      tags:
      - Job
      operationId: microsoftAzureJobGetdebugdatapath
      description: Gets the job debug data information specified by the job ID.
      parameters:
      - name: jobIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: Job identifier. Uniquely identifies the job across all jobs submitted to the service.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved debug data paths of the specified job.
          schema:
            $ref: '#/definitions/JobDataPath'
      x-ms-examples:
        Gets the job debug data information specified by the job ID:
          $ref: ./examples/Job_GetDebugDataPath.json
      summary: Microsoft Azure Get Jobs Jobidentity Getdebugdatapath
  /jobs/{jobIdentity}/CancelJob:
    post:
      tags:
      - Job
      operationId: microsoftAzureJobCancel
      description: Cancels the running job specified by the job ID.
      parameters:
      - name: jobIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: Job identifier. Uniquely identifies the job across all jobs submitted to the service.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully cancelled the job.
        '202':
          description: Successfully initiated the cancellation of the specified job.
        '204':
          description: The specified job was not found.
      x-ms-examples:
        Cancels the running job specified by the job ID:
          $ref: ./examples/Job_Cancel.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Jobs Jobidentity Canceljob
  /jobs/{jobIdentity}/YieldJob:
    post:
      tags:
      - Job
      operationId: microsoftAzureJobYield
      description: Pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.)
      parameters:
      - name: jobIdentity
        in: path
        required: true
        type: string
        format: uuid
        description: Job identifier. Uniquely identifies the job across all jobs submitted to the service.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully yielded the specified job.
        '202':
          description: Successfully initiated the yielding of the specified job.
        '204':
          description: The specified job was not found.
      x-ms-examples:
        ? Pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.)
        : $ref: ./examples/Job_Yield.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Jobs Jobidentity Yieldjob
  /buildJob:
    post:
      tags:
      - Job
      operationId: microsoftAzureJobBuild
      description: Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/BuildJobParameters'
        description: The parameters to build a job.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully built the job script.
          schema:
            $ref: '#/definitions/JobInformation'
      x-ms-examples:
        Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation:
          $ref: ./examples/Job_Build.json
      summary: Microsoft Azure Post Buildjob
  /livy/batches:
    get:
      tags:
      - Job
      description: List all spark batch jobs
      operationId: microsoftAzureJobListsparkbatchjob
      x-ms-examples:
        List all spark batch jobs:
          $ref: ./examples/HDI_Job_ListSparkBatchJob.json
      produces:
      - application/json
      parameters:
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkBatchJobCollection'
      summary: Microsoft Azure Get Livy Batches
    post:
      tags:
      - Job
      description: Create a new spark batch job.
      operationId: microsoftAzureJobSubmitsparkbatchjob
      x-ms-examples:
        Create a spark batch job:
          $ref: ./examples/HDI_Job_SubmitSparkBatchJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sparkBatchJobRequest
        in: body
        description: Livy compatible batch job request payload.
        required: true
        schema:
          $ref: '#/definitions/SparkBatchJobRequest'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/SparkBatchJob'
      summary: Microsoft Azure Post Livy Batches
  /livy/batches/{batchId}:
    get:
      tags:
      - Job
      description: Gets a single spark batch job.
      operationId: microsoftAzureJobGetsparkbatchjob
      x-ms-examples:
        Gets a single spark batch job:
          $ref: ./examples/HDI_Job_GetSparkBatchJob.json
      produces:
      - application/json
      parameters:
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkBatchJob'
      summary: Microsoft Azure Get Livy Batches Batchid
    delete:
      tags:
      - Job
      description: Cancels a running spark batch job.
      operationId: microsoftAzureJobDeletesparkbatch
      x-ms-examples:
        Cancels a running spark batch job:
          $ref: ./examples/HDI_Job_DeleteSparkBatch.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobDeletedResult'
      summary: Microsoft Azure Delete Livy Batches Batchid
  /livy/batches/{batchId}/log:
    get:
      tags:
      - Job
      description: Gets a single spark batch job logs.
      operationId: microsoftAzureJobGetsparkbatchlog
      x-ms-examples:
        Gets a single spark batch job logs:
          $ref: ./examples/HDI_Job_GetSparkBatchLog.json
      produces:
      - application/json
      parameters:
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobLog'
      summary: Microsoft Azure Get Livy Batches Batchid Log
  /livy/batches/{batchId}/state:
    get:
      tags:
      - Job
      description: Gets a single spark batch state.
      operationId: microsoftAzureJobGetsparkbatchstate
      x-ms-examples:
        Gets a single spark batch state:
          $ref: ./examples/HDI_Job_GetSparkBatchState.json
      produces:
      - application/json
      parameters:
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobState'
      summary: Microsoft Azure Get Livy Batches Batchid State
  /livy/sessions:
    get:
      tags:
      - Job
      description: List all spark sessions.
      operationId: microsoftAzureJobListsparksessionjob
      x-ms-examples:
        List all spark sessions:
          $ref: ./examples/HDI_Job_ListSparkSessionJob.json
      produces:
      - application/json
      parameters:
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkSessionCollection'
      summary: Microsoft Azure Get Livy Sessions
    post:
      tags:
      - Job
      description: Create a new spark session.
      operationId: microsoftAzureJobSubmitsparksessionjob
      x-ms-examples:
        Create a new spark session:
          $ref: ./examples/HDI_Job_SubmitSparkSessionJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sparkSessionJobRequest
        in: body
        description: Livy compatible session job request payload.
        required: true
        schema:
          $ref: '#/definitions/SparkSessionJobRequest'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/SparkSessionJob'
      summary: Microsoft Azure Post Livy Sessions
  /livy/sessions/{sessionId}:
    get:
      tags:
      - Job
      description: Gets a single spark session.
      operationId: microsoftAzureJobGetsparksessionjob
      x-ms-examples:
        Gets a single spark session:
          $ref: ./examples/HDI_Job_GetSparkSessionJob.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkSessionJob'
      summary: Microsoft Azure Get Livy Sessions Sessionid
    delete:
      tags:
      - Job
      description: Cancels a running spark session.
      operationId: microsoftAzureJobDeletesparksessionjob
      x-ms-examples:
        Cancels a running spark session:
          $ref: ./examples/HDI_Job_DeleteSparkSessionJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobDeletedResult'
      summary: Microsoft Azure Delete Livy Sessions Sessionid
  /livy/sessions/{sessionId}/log:
    get:
      tags:
      - Job
      description: Gets a single spark session job logs.
      operationId: microsoftAzureJobGetsparksessionlog
      x-ms-examples:
        Gets a single spark session job logs:
          $ref: ./examples/HDI_Job_GetSparkSessionLog.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session job.
        required: true
        type: integer
        format: int32
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobLog'
      summary: Microsoft Azure Get Livy Sessions Sessionid Log
  /livy/sessions/{sessionId}/state:
    get:
      tags:
      - Job
      description: Gets a single spark session job state.
      operationId: microsoftAzureJobGetsparksessionstate
      x-ms-examples:
        Gets a single spark session job state:
          $ref: ./examples/HDI_Job_GetSparkSessionState.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobState'
      summary: Microsoft Azure Get Livy Sessions Sessionid State
  /livy/sessions/{sessionId}/statements:
    get:
      tags:
      - Job
      description: Gets a list of statements within a spark session.
      operationId: microsoftAzureJobListsparkstatementjob
      x-ms-examples:
        Gets a list of statements within a spark session:
          $ref: ./examples/HDI_Job_ListSparkStatementJob.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkStatementCollection'
      summary: Microsoft Azure Get Livy Sessions Sessionid Statements
    post:
      tags:
      - Job
      description: Create a statement within a spark session.
      operationId: microsoftAzureJobSubmitsparkstatementjob
      x-ms-examples:
        Create a statement within a spark session:
          $ref: ./examples/HDI_Job_SubmitSparkStatementJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      - name: sparkStatementRequest
        in: body
        description: Livy compatible batch job request payload.
        required: true
        schema:
          $ref: '#/definitions/SparkStatementRequest'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/SparkStatement'
      summary: Microsoft Azure Post Livy Sessions Sessionid Statements
  /livy/sessions/{sessionId}/statements/{statementId}:
    get:
      tags:
      - Job
      description: Gets a single statement within a spark session.
      operationId: microsoftAzureJobGetsparkstatementjob
      x-ms-examples:
        Gets a single statement within a spark session:
          $ref: ./examples/HDI_Job_GetSparkStatementJob.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      - name: statementId
        in: path
        description: Identifier for the statement.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkStatement'
      summary: Microsoft Azure Get Livy Sessions Sessionid Statements Statementid
  /livy/sessions/{sessionId}/statements/{statementId}/cancel:
    post:
      tags:
      - Job
      description: Kill a statement within a session.
      operationId: microsoftAzureJobDeletesparkstatementjob
      x-ms-examples:
        Kill a statement within a session:
          $ref: ./examples/HDI_Job_DeleteSparkStatementJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      - name: statementId
        in: path
        description: Identifier for the statement.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkStatementCancellationResult'
      summary: Microsoft Azure Post Livy Sessions Sessionid Statements Statementid Cancel
definitions:
  JobDataPath:
    properties:
      jobId:
        readOnly: true
        type: string
        format: uuid
        description: The ID of the job this data is for.
      command:
        readOnly: true
        type: string
        description: The command that this job data relates to.
      paths:
        readOnly: true
        type: array
        items:
          type: string
        description: The list of paths to all of the job data.
    description: A Data Lake Analytics job data path item.
  SparkJobState:
    type: object
    properties:
      id:
        description: The livy id of the spark job.
        format: int32
        type: integer
      state:
        description: The current state of the spark job
        $ref: '#/definitions/JobState'
  SparkSessionCollection:
    type: object
    properties:
      from:
        description: The start index to fetch spark sessions.
        format: int32
        type: integer
      total:
        description: Number of spark sessions to fetch.
        format: int32
        type: integer
      sessions:
        description: List of spark sessions.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SparkSessionJob'
  SparkSessionJobRequest:
    type: object
    properties:
      kind:
        description: Spark session job kind.
        $ref: '#/definitions/SessionJobKind'
      proxyUser:
        description: User to impersonate when starting the session.
        type: string
      jars:
        description: Jars to be used in this session.
        uniqueItems: false
        type: array
        items:
          type: string
      pyFiles:
        description: Python files to be used in this session.
        x-ms-client-name: pythonFiles
        uniqueItems: false
        type: array
        items:
          type: string
      files:
        description: Files to be used in this session.
        uniqueItems: false
        type: array
        items:
          type: string
      driverMemory:
        description: Amount of memory to use for the driver process.
        type: string
      driverCores:
        description: Number of cores to use for the driver process.
        format: int32
        type: integer
      executorMemory:
        description: Amount of memory to use per executor process.
        type: string
      executorCores:
        description: Number of cores to use for each executor.
        format: int32
        type: integer
      numExecutors:
        description: Number of executors to launch for this session.
        x-ms-client-name: executorCount
        format: int32
        type: integer
      archives:
        description: Archives to be used in this session.
        uniqueItems: false
        type: array
        items:
          type: string
      queue:
        description: The name of the YARN queue to which submitted.
        type: string
      name:
        description: The name of this session.
        type: string
      conf:
        description: Spark configuration properties.
        x-ms-client-name: configuration
        type: object
        additionalProperties:
          type: string
      heartbeatTimeoutInSecond:
        description: Timeout in second to which session be orphaned.
        format: int32
        type: integer
  SparkStatement:
    type: object
    properties:
      id:
        description: The livy id of the spark statement job.
        format: int32
        type: integer
      code:
        description: The execution code.
        type: string
      state:
        description: The current state of the spark statement.
        $ref: '#/definitions/StatementState'
      output:
        description: The execution output.
        $ref: '#/definitions/SparkStatementOutput'
      progress:
        description: The execution progress.
        type: number
        format: double
  JobState:
    type: string
    x-ms-enum:
      name: JobState
      modelAsString: true
    enum:
    - not_started
    - starting
    - idle
    - running
    - busy
    - shutting_down
    - error
    - dead
    - killed
    - success
    - recovering
  SessionJobKind:
    type: string
    x-ms-enum:
      name: SessionJobKind
      modelAsString: true
    enum:
    - spark
    - pyspark
    - sparkr
    - sql
  SparkBatchJobCollection:
    type: object
    properties:
      from:
        description: The start index to fetch Spark Batch jobs.
        format: int32
        type: integer
      total:
        description: Number of Spark Batch jobs to fetch.
        format: int32
        type: integer
      sessions:
        description: List of spark batch jobs.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SparkBatchJob'
  JobInformation:
    required:
    - properties
    allOf:
    - $ref: '#/definitions/JobInformationBasic'
    properties:
      errorMessage:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/JobErrorDetails'
        description: The error message details for the job, if the job failed.
      stateAuditRecords:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/JobStateAuditRecord'
        description: The job state audit records, indicating when various operations have been performed on this job.
      properties:
        $ref: '#/definitions/JobProperties'
        description: The job specific properties.
    description: The extended Data Lake Analytics job information properties returned when retrieving a specific job.
  SparkJobLog:
    type: object
    properties:
      id:
        description: The livy id of the spark job.
        format: int32
        type: integer
      from:
        description: Offset from start of log.
        format: int32
        type: integer
      size:
        description: Max number of log lines.
        format: int32
        type: integer
      total:
        description: Total number of log lines.
        format: int64
        type: integer
      log:
        description: The log lines.
        x-ms-client-name: logLines
        uniqueItems: false
        type: array
        items:
          type: string
  JobStatisticsVertexStage:
    properties:
      dataRead:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data read, in bytes.
      dataReadCrossPod:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data read across multiple pods, in bytes.
      dataReadIntraPod:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data read in one pod, in bytes.
      dataToRead:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data remaining to be read, in bytes.
      dataWritten:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data written, in bytes.
      duplicateDiscardCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of duplicates that were discarded.
      failedCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of failures that occurred in this stage.
      maxVertexDataRead:
        readOnly: true
        type: integer
        format: int64
        description: The maximum amount of data read in a single vertex, in bytes.
      minVertexDataRead:
        readOnly: true
        type: integer
        format: int64
        description: The minimum amount of data read in a single vertex, in bytes.
      readFailureCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of read failures in this stage.
      revocationCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of vertices that were revoked during this stage.
      runningCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of currently running vertices in this stage.
      scheduledCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of currently scheduled vertices in this stage.
      stageName:
        readOnly: true
        type: string
        description: The name of this stage in job execution.
      succeededCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of vertices that succeeded in this stage.
      tempDataWritten:
        readOnly: true
        type: integer
        format: int64
        description: The amount of temporary data written, in bytes.
      totalCount:
        readOnly: true
        type: integer
        format: int32
        description: The total vertex count for th

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-job-api-openapi.yml
Microsoft Azure Job API

Documentation

Specifications

Other Resources

OpenAPI Specification
