Azure Automation Software Update Configuration Machine Run API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Software Update Configuration…
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Software Update Configuration Machine Run 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: Software Update Configuration Machine Run
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns
  : get:
      operationId: SoftwareUpdateConfigurationMachineRuns_List
      tags:
      - Software Update Configuration Machine Run
      description: Return list of software update configuration machine runs
      externalDocs:
        url: http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations
      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: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: 'The filter to apply on the operation. You can use the following filters: ''properties/osType'', ''properties/status'', ''properties/startTime'', and ''properties/softwareUpdateConfiguration/name'''
        required: false
        schema:
          type: string
      - name: $skip
        in: query
        description: number of entries you skip before returning results
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Maximum number of entries returned in the results collection
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/softwareUpdateConfigurationMachineRunListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List software update configuration machine runs:
          $ref: ./examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json
        List software update configuration machine runs for a specific software update configuration run:
          $ref: ./examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json
      summary: Software update configuration machine runs list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns/{softwareUpdateConfigurationMachineRunId}
  : get:
      operationId: SoftwareUpdateConfigurationMachineRuns_GetById
      tags:
      - Software Update Configuration Machine Run
      description: Get a single software update configuration machine run by Id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations
      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: softwareUpdateConfigurationMachineRunId
        in: path
        description: The Id of the software update configuration machine run.
        required: true
        schema:
          type: string
          format: uuid
      - 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/softwareUpdateConfigurationMachineRun'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get software update configuration machine run:
          $ref: ./examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json
      summary: Software update configuration machine runs get by id
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    softwareUpdateConfigurationMachineRun:
      type: object
      description: Software update configuration machine run model.
      properties:
        name:
          type: string
          description: Name of the software update configuration machine run
          readOnly: true
        id:
          type: string
          description: Resource Id of the software update configuration machine run
          readOnly: true
        properties:
          $ref: '#/components/schemas/updateConfigurationMachineRunProperties'
          description: Software update configuration machine run properties.
          x-ms-client-flatten: true
    AutomationErrorResponse:
      type: object
      description: Error response of an operation failure
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message indicating why the operation failed.
    updateConfigurationMachineRunProperties:
      type: object
      description: Software update configuration machine run properties.
      properties:
        targetComputer:
          type: string
          description: name of the updated computer
          readOnly: true
        targetComputerType:
          type: string
          description: type of the updated computer.
          readOnly: true
        softwareUpdateConfiguration:
          $ref: '#/components/schemas/updateConfigurationNavigation'
          description: software update configuration triggered this run
        status:
          type: string
          description: Status of the software update configuration machine run.
          readOnly: true
        osType:
          type: string
          description: Operating system target of the software update configuration triggered this run
          readOnly: true
        correlationId:
          type: string
          format: uuid
          description: correlation id of the software update configuration machine run
          readOnly: true
        sourceComputerId:
          type: string
          format: uuid
          description: source computer id of the software update configuration machine run
          readOnly: true
        startTime:
          type: string
          format: date-time
          description: Start time of the software update configuration machine run.
          readOnly: true
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: End time of the software update configuration machine run.
          readOnly: true
        configuredDuration:
          type: string
          description: configured duration for the software update configuration run.
          readOnly: true
        job:
          $ref: '#/components/schemas/jobNavigation'
          description: Job associated with the software update configuration machine run
        creationTime:
          type: string
          format: date-time
          description: Creation time of the resource, which only appears in the response.
          readOnly: true
        createdBy:
          type: string
          description: createdBy property, which only appears in the response.
          readOnly: true
        lastModifiedTime:
          type: string
          format: date-time
          description: Last time resource was modified, which only appears in the response.
          readOnly: true
        lastModifiedBy:
          type: string
          description: lastModifiedBy property, which only appears in the response.
          readOnly: true
        error:
          $ref: '#/components/schemas/AutomationErrorResponse'
          description: Details of provisioning error
    softwareUpdateConfigurationMachineRunListResult:
      type: object
      description: result of listing all software update configuration machine runs
      properties:
        value:
          type: array
          description: The softwareUpdateConfigurationMachineRun items on this page
          items:
            $ref: '#/components/schemas/softwareUpdateConfigurationMachineRun'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    jobNavigation:
      type: object
      description: Software update configuration machine run job navigation properties.
      properties:
        id:
          type: string
          description: Id of the job associated with the software update configuration run
          readOnly: true
    updateConfigurationNavigation:
      type: object
      description: Software update configuration Run Navigation model.
      properties:
        name:
          type: string
          description: Name of the software update configuration triggered the software update configuration run
          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