Azure Automation Job API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Job API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Job across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Job
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs
  : get:
      operationId: Job_ListByAutomationAccount
      tags:
      - Job
      description: Retrieve a list of jobs.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: $filter
        in: query
        description: The filter to apply on the operation.
        required: false
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResultV2'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List jobs by automation account:
          $ref: ./examples/job/listJobsByAutomationAccount.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Job list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}
  : get:
      operationId: Job_Get
      tags:
      - Job
      description: Retrieve the job identified by job name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: The job name.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get job:
          $ref: ./examples/job/getJob.json
      summary: Job get
      x-summary-source: derived
    put:
      operationId: Job_Create
      tags:
      - Job
      description: Create a job of the runbook.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: The job name.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Resource 'Job' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create job:
          $ref: ./examples/job/createJob.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobCreateParameters'
        description: The parameters supplied to the create job operation.
        required: true
      summary: Job create
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/output
  : get:
      operationId: Job_GetOutput
      tags:
      - Job
      description: Retrieve the job output identified by job name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: The job name.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            text/plain:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Job Output:
          $ref: ./examples/job/getJobOutput.json
      summary: Job get output
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/resume
  : post:
      operationId: Job_Resume
      tags:
      - Job
      description: Resume the job identified by jobName.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: The job name.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Resume job:
          $ref: ./examples/job/resumeJob.json
      summary: Job resume
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/runbookContent
  : get:
      operationId: Job_GetRunbookContent
      tags:
      - Job
      description: Retrieve the runbook content of the job identified by job name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: The job name.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            text/powershell:
              schema:
                type: string
            application/json:
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            text/powershell:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get Job Runbook Content:
          $ref: ./examples/job/getJobRunbookContent.json
      summary: Job get runbook content
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/stop
  : post:
      operationId: Job_Stop
      tags:
      - Job
      description: Stop the job identified by jobName.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: The job name.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Stop job:
          $ref: ./examples/job/stopJob.json
      summary: Job stop
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/suspend
  : post:
      operationId: Job_Suspend
      tags:
      - Job
      description: Suspend the job identified by job name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/joboperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: The job name.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Suspend job:
          $ref: ./examples/job/suspendJob.json
      summary: Job suspend
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    JobListResultV2:
      type: object
      description: The response model for the list job operation.
      properties:
        value:
          type: array
          description: The JobCollectionItem items on this page
          items:
            $ref: '#/components/schemas/JobCollectionItem'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    JobCreateProperties:
      type: object
      properties:
        runbook:
          $ref: '#/components/schemas/RunbookAssociationProperty'
          description: Gets or sets the runbook.
        parameters:
          type: object
          description: Gets or sets the parameters of the job.
          additionalProperties:
            type: string
        runOn:
          type: string
          description: Gets or sets the runOn which specifies the group name where the job is to be executed.
    JobCollectionItemProperties:
      type: object
      description: Job collection item properties.
      properties:
        runbook:
          $ref: '#/components/schemas/RunbookAssociationProperty'
          description: The runbook association.
          readOnly: true
        jobId:
          type: string
          format: uuid
          description: The id of the job.
          readOnly: true
        startedBy:
          type:
          - string
          - 'null'
          description: Gets or sets the job started by.
          readOnly: true
        creationTime:
          type: string
          format: date-time
          description: The creation time of the job.
          readOnly: true
        status:
          $ref: '#/components/schemas/JobStatus'
          description: The status of the job.
          readOnly: true
        startTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The start time of the job.
          readOnly: true
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The end time of the job.
          readOnly: true
        lastModifiedTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The last modified time of the job.
          readOnly: true
        provisioningState:
          type: string
          description: The provisioning state of a resource.
          readOnly: true
        jobRuntimeEnvironment:
          $ref: '#/components/schemas/JobRuntimeEnvironment'
          description: Runtime Environment Property
        runOn:
          type: string
          description: Specifies the runOn group name where the job was executed.
    RunbookAssociationProperty:
      type: object
      description: The runbook property associated with the entity.
      properties:
        name:
          type: string
          description: Gets or sets the name of the runbook.
    JobRuntimeEnvironment:
      type: object
      description: The runbook property associated with the entity.
      properties:
        runtimeEnvironmentName:
          type: string
          description: Name of Runtime Environment.
    JobStatus:
      type: string
      description: Gets or sets the status of the job.
      enum:
      - New
      - Activating
      - Running
      - Completed
      - Failed
      - Stopped
      - Blocked
      - Suspended
      - Disconnected
      - Suspending
      - Stopping
      - Resuming
      - Removing
      x-ms-enum:
        name: JobStatus
        modelAsString: true
        values:
        - name: New
          value: New
          description: New
        - name: Activating
          value: Activating
          description: Activating
        - name: Running
          value: Running
          description: Running
        - name: Completed
          value: Completed
          description: Completed
        - name: Failed
          value: Failed
          description: Failed
        - name: Stopped
          value: Stopped
          description: Stopped
        - name: Blocked
          value: Blocked
          description: Blocked
        - name: Suspended
          value: Suspended
          description: Suspended
        - name: Disconnected
          value: Disconnected
          description: Disconnected
        - name: Suspending
          value: Suspending
          description: Suspending
        - name: Stopping
          value: Stopping
          description: Stopping
        - name: Resuming
          value: Resuming
          description: Resuming
        - name: Removing
          value: Removing
          description: Removing
    JobProvisioningState:
      type: string
      description: The provisioning state of the resource.
      enum:
      - Failed
      - Succeeded
      - Suspended
      - Processing
      x-ms-enum:
        name: JobProvisioningState
        modelAsString: true
        values:
        - name: Failed
          value: Failed
          description: Failed
        - name: Succeeded
          value: Succeeded
          description: Succeeded
        - name: Suspended
          value: Suspended
          description: Suspended
        - name: Processing
          value: Processing
          description: Processing
    JobCollectionItem:
      type: object
      description: Job collection item properties.
      properties:
        properties:
          $ref: '#/components/schemas/JobCollectionItemProperties'
          description: Job properties.
          x-ms-client-flatten: true
      required:
      - properties
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    JobCreateParameters:
      type: object
      description: The parameters supplied to the create job operation.
      properties:
        properties:
          $ref: '#/components/schemas/JobCreateProperties'
          description: Gets or sets the list of job properties.
          x-ms-client-flatten: true
      required:
      - properties
    Job:
      type: object
      description: Definition of the job.
      properties:
        properties:
          $ref: '#/components/schemas/JobProperties'
          description: The properties of the job.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    JobProperties:
      type: object
      description: Definition of job properties.
      properties:
        runbook:
          $ref: '#/components/schemas/RunbookAssociationProperty'
          description: Gets or sets the runbook.
        startedBy:
          type: string
          description: Gets or sets the job started by.
        runOn:
          type: string
          description: Gets or sets the runOn which specifies the group name where the job is to be executed.
        jobRuntimeEnvironment:
          $ref: '#/components/schemas/JobRuntimeEnvironment'
          description: Runtime Environment Property
        jobId:
          type: string
          format: uuid
          description: Gets or sets the id of the job.
        creationTime:
          type: string
          format: date-time
          description: Gets or sets the creation time of the job.
        status:
          $ref: '#/components/schemas/JobStatus'
          description: Gets or sets the status of the job.
        statusDetails:
          type: string
          description: Gets or sets the status details of the job.
        startTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the start time of the job.
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the end time of the job.
        exception:
          type: string
          description: Gets or sets the exception of the job.
        lastModifiedTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the last modified time of the job.
        lastStatusModifiedTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the last status modified time of the job.
        parameters:
          type: object
          description: Gets or sets the parameters of the job.
          additionalProperties:
            type: string
        provisioningState:
          $ref: '#/components/schemas/JobProvisioningState'
          description: The current provisioning state of the job.
          readOnly: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml