Azure Automation Software Update Configuration API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Software Update Configuration API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Software Update Configuration 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
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations
  : get:
      operationId: SoftwareUpdateConfigurations_List
      tags:
      - Software Update Configuration
      description: Get all software update configurations for the account.
      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.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/softwareUpdateConfigurationListResult'
        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 configurations:
          $ref: ./examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json
        List software update configurations Targeting a specific azure virtual machine:
          $ref: ./examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json
      summary: Software update configurations list
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}
  : get:
      operationId: SoftwareUpdateConfigurations_GetByName
      tags:
      - Software Update Configuration
      description: Get a single software update configuration by name.
      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: softwareUpdateConfigurationName
        in: path
        description: The name of the software update configuration to be created.
        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/softwareUpdateConfiguration'
        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 by name:
          $ref: ./examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json
      summary: Software update configurations get by name
      x-summary-source: derived
    put:
      operationId: SoftwareUpdateConfigurations_Create
      tags:
      - Software Update Configuration
      description: Create a new software update configuration with the name given in the URI.
      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: softwareUpdateConfigurationName
        in: path
        description: The name of the software update configuration to be created.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Resource 'softwareUpdateConfiguration' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/softwareUpdateConfiguration'
        '201':
          description: Resource 'softwareUpdateConfiguration' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/softwareUpdateConfiguration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create software update configuration:
          $ref: ./examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/softwareUpdateConfiguration'
        description: Request body.
        required: true
      summary: Software update configurations create
      x-summary-source: derived
    delete:
      operationId: SoftwareUpdateConfigurations_Delete
      tags:
      - Software Update Configuration
      description: delete a specific software update configuration.
      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: softwareUpdateConfigurationName
        in: path
        description: The name of the software update configuration to be created.
        required: true
        schema:
          type: string
      - name: clientRequestId
        in: header
        description: Identifies this specific client request.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete software update configuration:
          $ref: ./examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json
      summary: Software update configurations delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    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.
    softwareUpdateConfigurationProperties:
      type: object
      description: Software update configuration properties.
      properties:
        updateConfiguration:
          $ref: '#/components/schemas/updateConfiguration'
          description: update specific properties for the Software update configuration
        scheduleInfo:
          $ref: '#/components/schemas/SUCScheduleProperties'
          description: Schedule information for the Software update configuration
        provisioningState:
          type: string
          description: Provisioning state for the software update configuration, which only appears in the response.
          readOnly: true
        error:
          $ref: '#/components/schemas/AutomationErrorResponse'
          description: Details of provisioning error
        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/softwareUpdateConfigurationTasks'
          description: Tasks information for the Software update configuration.
      required:
      - updateConfiguration
      - scheduleInfo
    AdvancedScheduleMonthlyOccurrence:
      type: object
      description: The properties of the create advanced schedule monthly occurrence.
      properties:
        occurrence:
          type: integer
          format: int32
          description: Occurrence of the week within the month. Must be between 1 and 5
        day:
          $ref: '#/components/schemas/ScheduleDay'
          description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    WindowsUpdateClasses:
      type: string
      description: Update classification included in the software update configuration. A comma separated string with required values
      enum:
      - Unclassified
      - Critical
      - Security
      - UpdateRollup
      - FeaturePack
      - ServicePack
      - Definition
      - Tools
      - Updates
      x-ms-enum:
        name: WindowsUpdateClasses
        modelAsString: true
        values:
        - name: Unclassified
          value: Unclassified
          description: Unclassified
        - name: Critical
          value: Critical
          description: Critical
        - name: Security
          value: Security
          description: Security
        - name: UpdateRollup
          value: UpdateRollup
          description: UpdateRollup
        - name: FeaturePack
          value: FeaturePack
          description: FeaturePack
        - name: ServicePack
          value: ServicePack
          description: ServicePack
        - name: Definition
          value: Definition
          description: Definition
        - name: Tools
          value: Tools
          description: Tools
        - name: Updates
          value: Updates
          description: Updates
    TagOperators:
      type: string
      description: Filter VMs by Any or All specified tags.
      enum:
      - All
      - Any
      x-ms-enum:
        name: TagOperators
        modelAsString: false
        values:
        - name: All
          value: All
          description: All
        - name: Any
          value: Any
          description: Any
    TagSettingsProperties:
      type: object
      description: Tag filter information for the VM.
      properties:
        tags:
          type: object
          description: Dictionary of tags with its list of values.
          additionalProperties:
            items:
              type: string
            type: array
        filterOperator:
          $ref: '#/components/schemas/TagOperators'
          description: Filter VMs by Any or All specified tags.
    AdvancedSchedule:
      type: object
      description: The properties of the create Advanced Schedule.
      properties:
        weekDays:
          type: array
          description: Days of the week that the job should execute on.
          items:
            type: string
        monthDays:
          type: array
          description: Days of the month that the job should execute on. Must be between 1 and 31.
          items:
            type: integer
            format: int32
        monthlyOccurrences:
          type: array
          description: Occurrences of days within a month.
          items:
            $ref: '#/components/schemas/AdvancedScheduleMonthlyOccurrence'
          x-ms-identifiers: []
    softwareUpdateConfigurationCollectionItemProperties:
      type: object
      description: Software update configuration collection item properties.
      properties:
        updateConfiguration:
          $ref: '#/components/schemas/updateConfiguration'
          description: Update specific properties of the software update configuration.
        tasks:
          $ref: '#/components/schemas/softwareUpdateConfigurationTasks'
          description: Pre and Post Tasks defined
        frequency:
          $ref: '#/components/schemas/ScheduleFrequency'
          description: execution frequency of the schedule associated with the software update configuration
        startTime:
          type: string
          format: date-time
          description: the start time of the update.
        creationTime:
          type: string
          format: date-time
          description: Creation time of the software update configuration, which only appears in the response.
          readOnly: true
        lastModifiedTime:
          type: string
          format: date-time
          description: Last time software update configuration was modified, which only appears in the response.
          readOnly: true
        provisioningState:
          type: string
          description: Provisioning state for the software update configuration, which only appears in the response.
          readOnly: true
        nextRun:
          type:
          - string
          - 'null'
          format: date-time
          description: ext run time of the update.
    AzureQueryProperties:
      type: object
      description: Azure query for the update configuration.
      properties:
        scope:
          type: array
          description: List of Subscription or Resource Group ARM Ids.
          items:
            type: string
        locations:
          type: array
          description: List of locations to scope the query to.
          items:
            type: string
        tagSettings:
          $ref: '#/components/schemas/TagSettingsProperties'
          description: Tag settings for the VM.
    LinuxUpdateClasses:
      type: string
      description: Update classifications included in the software update configuration.
      enum:
      - Unclassified
      - Critical
      - Security
      - Other
      x-ms-enum:
        name: LinuxUpdateClasses
        modelAsString: true
        values:
        - name: Unclassified
          value: Unclassified
          description: Unclassified
        - name: Critical
          value: Critical
          description: Critical
        - name: Security
          value: Security
          description: Security
        - name: Other
          value: Other
          description: Other
    ScheduleDay:
      type: string
      description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
      enum:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
      x-ms-enum:
        name: ScheduleDay
        modelAsString: true
        values:
        - name: Monday
          value: Monday
          description: Monday
        - name: Tuesday
          value: Tuesday
          description: Tuesday
        - name: Wednesday
          value: Wednesday
          description: Wednesday
        - name: Thursday
          value: Thursday
          description: Thursday
        - name: Friday
          value: Friday
          description: Friday
        - name: Saturday
          value: Saturday
          description: Saturday
        - name: Sunday
          value: Sunday
          description: Sunday
    softwareUpdateConfigurationCollectionItem:
      type: object
      description: Software update configuration collection item properties.
      properties:
        name:
          type: string
          description: Name of the software update configuration.
          readOnly: true
        id:
          type: string
          description: Resource Id of the software update configuration
          readOnly: true
        properties:
          $ref: '#/components/schemas/softwareUpdateConfigurationCollectionItemProperties'
          description: Software update configuration properties.
          x-ms-client-flatten: true
      required:
      - properties
    TargetProperties:
      type: object
      description: Group specific to the update configuration.
      properties:
        azureQueries:
          type: array
          description: List of Azure queries in the software update configuration.
          items:
            $ref: '#/components/schemas/AzureQueryProperties'
          x-ms-identifiers: []
        nonAzureQueries:
          type: array
          description: List of non Azure queries in the software update configuration.
          items:
            $ref: '#/components/schemas/NonAzureQueryProperties'
          x-ms-identifiers:
          - workspaceId
    ScheduleFrequency:
      type: string
      description: Gets or sets the frequency of the schedule.
      enum:
      - OneTime
      - Day
      - Hour
      - Week
      - Month
      - Minute
      x-ms-enum:
        name: ScheduleFrequency
        modelAsString: true
        values:
        - name: OneTime
          value: OneTime
          description: OneTime
        - name: Day
          value: Day
          description: Day
        - name: Hour
          value: Hour
          description: Hour
        - name: Week
          value: Week
          description: Week
        - name: Month
          value: Month
          description: Month
        - name: Minute
          value: Minute
          description: The minimum allowed interval for Minute schedules is 15 minutes.
    softwareUpdateConfigurationTasks:
      type: object
      description: Task properties of the software update configuration.
      properties:
        preTask:
          $ref: '#/components/schemas/taskProperties'
          description: Pre task properties.
        postTask:
          $ref: '#/components/schemas/taskProperties'
          description: Post task properties.
    softwareUpdateConfiguration:
      type: object
      description: Software update configuration properties.
      properties:
        properties:
          $ref: '#/components/schemas/softwareUpdateConfigurationProperties'
          description: Software update configuration properties.
          x-ms-client-flatten: true
      required:
      - properties
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    SUCScheduleProperties:
      type: object
      description: Definition of schedule parameters.
      properties:
        startTime:
          type: string
          format: date-time
          description: Gets or sets the start time of the schedule.
        startTimeOffsetMinutes:
          type: number
          format: double
          description: Gets the start time's offset in minutes.
          readOnly: true
        expiryTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the end time of the schedule.
        expiryTimeOffsetMinutes:
          type: number
          format: double
          description: Gets or sets the expiry time's offset in minutes.
        isEnabled:
          type: boolean
          description: Gets or sets a value indicating whether this schedule is enabled.
        nextRun:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the next run time of the schedule.
        nextRunOffsetMinutes:
          type: number
          format: double
          description: Gets or sets the next run time's offset in minutes.
        interval:
          type: integer
          format: int64
          description: Gets or sets the interval of the schedule.
        frequency:
          $ref: '#/components/schemas/ScheduleFrequency'
          description: Gets or sets the frequency of the schedule.
        timeZone:
          type: string
          description: Gets or sets the time zone of the schedule.
        advancedSchedule:
          $ref: '#/components/schemas/AdvancedSchedule'
          description: Gets or sets the advanced schedule.
        creationTime:
          type: string
          format: date-time
          description: Gets or sets the creation time.
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the last modified time.
        description:
          type: string
          description: Gets or sets the description.
    WindowsProperties:
      type: object
      description: Windows specific update configuration.
      properties:
        includedUpdateClassifications:
          $ref: '#/components/schemas/WindowsUpdateClasses'
          description: Update classification included in the software update configuration. A comma separated string with required values
        excludedKbNumbers:
          type: array
          description: KB numbers excluded from the software update configuration.
          items:
            type: string
        includedKbNumbers:
          type: array
          description: KB numbers included from the software update configuration.
          items:
            type: string
        rebootSetting:
          type: string
          description: Reboot setting for the software update configuration.
    taskProperties:
      type: object
      description: Task properties of the software update configuration.
      properties:
        parameters:
          type: object
          description: Gets or sets the parameters of the task.
          additionalProperties:
            type: string
        source:
          type: string
          description: Gets or sets the name of the runbook.
    OperatingSystemType:
      type: string
      description: Target operating system for the software update configuration.
      enum:
      - Windows
      - Linux
      x-ms-enum:
        name: OperatingSystemType
        modelAsString: false
        values:
        - name: Windows
          value: Windows
          description: Windows
        - name: Linux
          value: Linux
          description: Linux
    LinuxProperties:
      type: object
      description: Linux specific update configuration.
      properties:
        includedPackageClassifications:
          $ref: '#/components/schemas/LinuxUpdateClasses'
          description: Update classifications included in the software update configuration.
        excludedPackageNameMasks:
          type: array
          description: packages excluded from the software update configuration.
          items:
            type: string
        includedPackageNameMasks:
          type: array
          description: packages included from the software update configuration.
          items:
            type: string
        rebootSetting:
          type: string
          description: Reboot setting for the software update configuration.
    NonAzureQueryProperties:
      type: object
      description: Non Azure query for the update configuration.
      properties:
        functionAlias:
          type: string
          description: Log Analytics Saved Search name.
        workspaceId:
          type: string
          description: Workspace Id for Log Analytics in which the saved Search is resided.
    updateConfiguration:
      type: object
      description: Update specific properties of the software update configuration.
      properties:
        operatingSystem:
          $ref: '#/components/schemas/OperatingSystemType'
          description: operating system of target machines
        windows:
          $ref: '#/components/schemas/WindowsProperties'
          description: Windows specific update configuration.
        linux:
          $ref: '#/components/schemas/LinuxProperties'
          description: Linux specific update configuration.
        duration:
          type: string
          format: duration
          description: Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601
        azureVirtualMachines:
          type: array
          description: List of azure resource Ids for azure virtual machines targeted by the software update configuration.
          items:
            type: string
        nonAzureComputerNames:
          type: array
          description: List of names of non-azure machines targeted by the software update configuration.
          items:
            type: string
        targets:
          $ref: '#/components/schemas/TargetProperties'
          description: Group targets for the software update configuration.
      required:
      - operatingSystem
    softwareUpdateConfigurationListResult:
      type: object
      description: result of listing all software update configuration
      properties:
        value:
          type: array
          description: outer object returned when listing all software update configurations
          items:
            $ref: '#/components/schemas/softwareUpdateConfigurationCollectionItem'
  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