Microsoft Azure

Microsoft Azure Update Management API

Microsoft Azure Update Management API allows users to programmatically manage and automate updates for their virtual machines in Azure. With this API, users can schedule update deployments, track update compliance, and customize update settings for their virtual machines. This API provides a convenient way to ensure that virtual machines are regularly updated with the latest security patches and updates, reducing the risk of security vulnerabilities and downtime.

GitHub OpenAPI

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/update-manager/manage-vms-programmatically

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/update-management-api-openapi-original.yml

OpenAPI Specification

update-management-api-openapi-original.yml Raw ↑ 
swagger: '2.0'
info:
  title: Microsoft Azure Update Management API
  description: APIs for managing software update configurations.
  contact:
    name: Mohamed Enein
  version: 2023-05-15-preview
  x-ms-code-generation-settings:
    useDateTimeOffset: true
consumes:
  - application/json
produces:
  - application/json
schemes:
  - https
host: management.azure.com
basePath: /
security:
  - azure_auth:
      - user_impersonation
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow
    scopes:
      user_impersonation: impersonate your user account
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns/{softwareUpdateConfigurationRunId}
  : get:
      tags:
        - Software Update Configuration Run
      description: Get a single software update configuration Run by Id.
      externalDocs:
        url: >-
          http://aka.ms/azureautomationsdk/softwareupdateconfigurationrunoperations
      x-ms-examples:
        Get software update configuration runs by Id:
          $ref: >-
            ./examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json
      operationId: microsoftAzureSoftwareupdateconfigurationrunsGetbyid
      parameters:
        - $ref: ../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter
        - name: softwareUpdateConfigurationRunId
          description: The Id of the software update configuration run.
          type: string
          required: true
          in: path
          format: uuid
        - $ref: ../../common/v1/definitions.json#/parameters/ApiVersionParameter
        - $ref: ../../common/v1/definitions.json#/parameters/clientRequestId
      responses:
        '200':
          description: A single software update configuration Run.
          schema:
            $ref: '#/definitions/softwareUpdateConfigurationRun'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Automation Automationaccounts Automationaccountname Softwareupdateconfigurationruns Softwareupdateconfigurationrunid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns
  : get:
      tags:
        - Software Update Configuration Run
      description: Return list of software update configuration runs
      externalDocs:
        url: http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations
      x-ms-examples:
        List software update configuration machine runs:
          $ref: >-
            ./examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json
        List software update configuration machine run with status equal to 'Failed':
          $ref: >-
            ./examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json
      operationId: microsoftAzureSoftwareupdateconfigurationrunsList
      parameters:
        - $ref: ../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter
        - $ref: ../../common/v1/definitions.json#/parameters/ApiVersionParameter
        - $ref: ../../common/v1/definitions.json#/parameters/clientRequestId
        - name: $filter
          in: query
          required: false
          type: string
          description: >-
            The filter to apply on the operation. You can use the following
            filters: 'properties/osType', 'properties/status',
            'properties/startTime', and
            'properties/softwareUpdateConfiguration/name'
        - name: $skip
          in: query
          required: false
          type: string
          description: Number of entries you skip before returning results
        - name: $top
          in: query
          required: false
          type: string
          description: Maximum number of entries returned in the results collection
      responses:
        '200':
          description: Return list of software update configurations runs.
          schema:
            $ref: '#/definitions/softwareUpdateConfigurationRunListResult'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Automation Automationaccounts Automationaccountname Softwareupdateconfigurationruns
definitions:
  softwareUpdateConfigurationRun:
    description: Software update configuration Run properties.
    x-ms-azure-resource: false
    type: object
    properties:
      name:
        readOnly: true
        type: string
        description: Name of the software update configuration run.
      id:
        readOnly: true
        type: string
        description: Resource Id of the software update configuration run
      properties:
        x-ms-client-flatten: true
        description: Software update configuration Run properties.
        $ref: '#/definitions/softwareUpdateConfigurationRunProperties'
  softwareUpdateConfigurationRunProperties:
    description: Software update configuration properties.
    properties:
      softwareUpdateConfiguration:
        description: software update configuration triggered this run
        $ref: '#/definitions/updateConfigurationNavigation'
      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
        x-nullable: false
        description: Start time of the software update configuration run.
        readOnly: true
      endTime:
        type: string
        format: date-time
        x-nullable: true
        description: End time of the software update configuration run.
        readOnly: true
      computerCount:
        type: integer
        description: Number of computers in the software update configuration run.
        readOnly: true
      failedCount:
        type: integer
        description: Number of computers with failed status.
        readOnly: true
      creationTime:
        type: string
        description: Creation time of the resource, which only appears in the response.
        format: date-time
        x-nullable: false
        readOnly: true
      createdBy:
        type: string
        description: CreatedBy property, which only appears in the response.
        readOnly: true
      lastModifiedTime:
        type: string
        description: Last time resource was modified, which only appears in the response.
        format: date-time
        x-nullable: false
        readOnly: true
      lastModifiedBy:
        type: string
        description: LastModifiedBy property, which only appears in the response.
        readOnly: true
      tasks:
        description: Software update configuration tasks triggered in this run
        $ref: '#/definitions/softwareUpdateConfigurationRunTasks'
  softwareUpdateConfigurationRunTasks:
    description: Software update configuration run tasks model.
    type: object
    properties:
      preTask:
        description: Pre task properties.
        $ref: '#/definitions/softwareUpdateConfigurationRunTaskProperties'
      postTask:
        description: Post task properties.
        $ref: '#/definitions/softwareUpdateConfigurationRunTaskProperties'
  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.
  updateConfigurationNavigation:
    description: Software update configuration Run Navigation model.
    type: object
    properties:
      name:
        description: >-
          Name of the software update configuration triggered the software
          update configuration run
        type: string
        readOnly: true
  softwareUpdateConfigurationRunListResult:
    description: result of listing all software update configuration runs
    properties:
      value:
        description: >-
          outer object returned when listing all software update configuration
          runs
        type: array
        items:
          $ref: '#/definitions/softwareUpdateConfigurationRun'
      nextLink:
        type: string
        description: link to next page of results.
tags:
  - name: Software Update Configuration Run