Azure Automation Test Job API

The TestJob API from Azure Automation — 4 operation(s) for testjob.

Documentation GitHub OpenAPI

Operations 5

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob Test job get #

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob Test job create #

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume Test job resume #

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/automation/

Specifications

⚙

OpenAPI

https://artifacts.apis.io/microsoft-azure-automation/openapi/microsoft-azure-automation-testjob-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-automation:microsoft-azure-automation-testjob-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Test Job API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged TestJob 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: TestJob
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob
  : get:
      operationId: TestJob_Get
      tags:
      - TestJob
      description: Retrieve the test job for the specified runbook.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/testjoboperations
      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: runbookName
        in: path
        description: The runbook name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestJob'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get test job:
          $ref: ./examples/runbook/getTestJob.json
      summary: Test job get
      x-summary-source: derived
    put:
      operationId: TestJob_Create
      tags:
      - TestJob
      description: Create a test job of the runbook.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/testjoboperations
      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: runbookName
        in: path
        description: The runbook name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      responses:
        '201':
          description: Resource 'TestJob' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestJob'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create test job:
          $ref: ./examples/runbook/createTestJob.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestJobCreateParameters'
        description: The parameters supplied to the create test job operation.
        required: true
      summary: Test job create
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume
  : post:
      operationId: TestJob_Resume
      tags:
      - TestJob
      description: Resume the test job.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/testjoboperations
      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: runbookName
        in: path
        description: The runbook name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      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 test job:
          $ref: ./examples/runbook/resumeTestJob.json
      summary: Test job resume
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/stop
  : post:
      operationId: TestJob_Stop
      tags:
      - TestJob
      description: Stop the test job.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/testjoboperations
      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: runbookName
        in: path
        description: The runbook name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      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 test job:
          $ref: ./examples/runbook/stopTestJob.json
      summary: Test job stop
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/suspend
  : post:
      operationId: TestJob_Suspend
      tags:
      - TestJob
      description: Suspend the test job.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/testjoboperations
      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: runbookName
        in: path
        description: The runbook name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$
      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 test job:
          $ref: ./examples/runbook/suspendTestJob.json
      summary: Test job suspend
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    TestJobCreateParameters:
      type: object
      description: The parameters supplied to the create test job operation.
      properties:
        parameters:
          type: object
          description: Gets or sets the parameters of the test 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.
        runtimeEnvironment:
          type: string
          description: The runtime Environment Name on which job needs to be tested
    TestJob:
      type: object
      description: Definition of the test job.
      properties:
        creationTime:
          type: string
          format: date-time
          description: Gets or sets the creation time of the test job.
        status:
          type: string
          description: Gets or sets the status of the test job.
        statusDetails:
          type: string
          description: Gets or sets the status details of the test job.
        runOn:
          type: string
          description: Gets or sets the runOn which specifies the group name where the job is to be executed.
        startTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the start time of the test job.
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the end time of the test job.
        exception:
          type: string
          description: Gets or sets the exception of the test job.
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the last modified time of the test job.
        lastStatusModifiedTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the last status modified time of the test job.
        parameters:
          type: object
          description: Gets or sets the parameters of the test job.
          additionalProperties:
            type: string
        logActivityTrace:
          type: integer
          format: int32
          description: The activity-level tracing options of the runbook.
  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