Azure Automation Software Update Configuration 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 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 Run
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns
  : get:
      operationId: SoftwareUpdateConfigurationRuns_List
      tags:
      - Software Update Configuration Run
      description: Return list of software update configuration 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/softwareUpdateConfigurationRunListResult'
        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 run with status equal to 'Failed':
          $ref: ./examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json
        List software update configuration machine runs:
          $ref: ./examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json
      summary: Software update configuration runs list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns/{softwareUpdateConfigurationRunId}
  : get:
      operationId: SoftwareUpdateConfigurationRuns_GetById
      tags:
      - Software Update Configuration Run
      description: Get a single software update configuration Run by Id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/softwareupdateconfigurationrunoperations
      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: softwareUpdateConfigurationRunId
        in: path
        description: The Id of the software update configuration 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/softwareUpdateConfigurationRun'
        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 runs by Id:
          $ref: ./examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json
      summary: Software update configuration runs get by id
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    softwareUpdateConfigurationRunListResult:
      type: object
      description: result of listing all software update configuration runs
      properties:
        value:
          type: array
          description: The softwareUpdateConfigurationRun items on this page
          items:
            $ref: '#/components/schemas/softwareUpdateConfigurationRun'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    softwareUpdateConfigurationRun:
      type: object
      description: Software update configuration Run properties.
      properties:
        name:
          type: string
          description: Name of the software update configuration run.
          readOnly: true
        id:
          type: string
          description: Resource Id of the software update configuration run
          readOnly: true
        properties:
          $ref: '#/components/schemas/softwareUpdateConfigurationRunProperties'
          description: Software update configuration Run properties.
          x-ms-client-flatten: 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
    softwareUpdateConfigurationRunProperties:
      type: object
      description: Software update configuration properties.
      properties:
        softwareUpdateConfiguration:
          $ref: '#/components/schemas/updateConfigurationNavigation'
          description: software update configuration triggered this run
        status:
          type: string
          description: Status of the software update configuration run.
          readOnly: true
        configuredDuration:
          type: string
          description: Configured duration for the software update configuration run.
          readOnly: true
        osType:
          type: string
          description: Operating system target of the software update configuration triggered this run
          readOnly: true
        startTime:
          type: string
          format: date-time
          description: Start time of the software update configuration run.
          readOnly: true
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: End time of the software update configuration run.
          readOnly: true
        computerCount:
          type: integer
          format: int32
          description: Number of computers in the software update configuration run.
          readOnly: true
        failedCount:
          type: integer
          format: int32
          description: Number of computers with failed status.
          readOnly: true
        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
        tasks:
          $ref: '#/components/schemas/softwareUpdateConfigurationRunTasks'
          description: Software update configuration tasks triggered in this run
    softwareUpdateConfigurationRunTaskProperties:
      type: object
      description: Task properties of the software update configuration.
      properties:
        status:
          type: string
          description: The status of the task.
        source:
          type: string
          description: The name of the source of the task.
        jobId:
          type: string
          description: The job id of the task.
    softwareUpdateConfigurationRunTasks:
      type: object
      description: Software update configuration run tasks model.
      properties:
        preTask:
          $ref: '#/components/schemas/softwareUpdateConfigurationRunTaskProperties'
          description: Pre task properties.
        postTask:
          $ref: '#/components/schemas/softwareUpdateConfigurationRunTaskProperties'
          description: Post task properties.
  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