Azure Automation Test Job Stream API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Test Job Stream API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged TestJobStream 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: TestJobStream
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams
  : get:
      operationId: TestJobStreams_ListByTestJob
      tags:
      - TestJobStream
      description: Retrieve a list of test job streams identified by runbook name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/jobstreamoperations
      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]*$
      - name: $filter
        in: query
        description: The filter to apply on the operation.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStreamListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List job streams by job name:
          $ref: ./examples/runbook/listTestJobStreamsByJob.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Test job streams list by test job
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams/{jobStreamId}
  : get:
      operationId: TestJobStreams_Get
      tags:
      - TestJobStream
      description: Retrieve a test job stream of the test job identified by runbook name and stream id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/jobstreamoperations
      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]*$
      - name: jobStreamId
        in: path
        description: The job stream id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStream'
        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 stream:
          $ref: ./examples/runbook/getTestJobStream.json
      summary: Test job streams get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    JobStreamType:
      type: string
      description: Gets or sets the stream type.
      enum:
      - Progress
      - Output
      - Warning
      - Error
      - Debug
      - Verbose
      - Any
      x-ms-enum:
        name: JobStreamType
        modelAsString: true
        values:
        - name: Progress
          value: Progress
          description: Progress
        - name: Output
          value: Output
          description: Output
        - name: Warning
          value: Warning
          description: Warning
        - name: Error
          value: Error
          description: Error
        - name: Debug
          value: Debug
          description: Debug
        - name: Verbose
          value: Verbose
          description: Verbose
        - name: Any
          value: Any
          description: Any
    JobStreamListResult:
      type: object
      description: The response model for the list job stream operation.
      properties:
        value:
          type: array
          description: The JobStream items on this page
          items:
            $ref: '#/components/schemas/JobStream'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    JobStreamProperties:
      type: object
      description: Definition of the job stream.
      properties:
        jobStreamId:
          type: string
          description: Gets or sets the id of the job stream.
        time:
          type: string
          format: date-time
          description: Gets or sets the creation time of the job.
        streamType:
          $ref: '#/components/schemas/JobStreamType'
          description: Gets or sets the stream type.
        streamText:
          type: string
          description: Gets or sets the stream text.
        summary:
          type:
          - string
          - 'null'
          description: Gets or sets the summary.
        value:
          type: object
          description: Gets or sets the values of the job stream.
          additionalProperties: {}
    JobStream:
      type: object
      description: Definition of the job stream.
      properties:
        id:
          type: string
          description: Gets or sets the id of the resource.
        properties:
          $ref: '#/components/schemas/JobStreamProperties'
          description: Gets or sets the id of the job stream.
          x-ms-client-flatten: 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