Microsoft Azure

Microsoft Azure Update Admin Client

The Microsoft Azure Update Admin Client is a tool that allows administrators to efficiently manage and install updates across their Azure infrastructure. This client enables administrators to schedule update installations, view update status and progress, and troubleshoot any issues that may arise during the update process.

GitHub OpenAPI

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/update-manager/overview

Specifications

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

OpenAPI Specification

updateadminclient-openapi-original.yml Raw ↑ 
swagger: '2.0'
info:
  description: Update operation endpoints and objects.
  title: Microsoft Azure UpdateAdminClient
  version: '2016-05-01'
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Update.Admin/updateLocations/{updateLocation}/updates
  : get:
      x-ms-examples:
        Get the list of updates at an update locations.:
          $ref: ./examples/Updates/List.json
      tags:
        - Updates
      description: Get the list of update locations
      operationId: microsoftAzureUpdatesList
      parameters:
        - $ref: Update.json#/parameters/SubscriptionIdParameter
        - $ref: Update.json#/parameters/ResourceGroupParameter
        - $ref: UpdateLocations.json#/parameters/UpdateLocationParameter
        - $ref: Update.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/UpdateList'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Update Admin Updatelocations Updatelocation Updates
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Update.Admin/updateLocations/{updateLocation}/updates/{updateName}
  : get:
      x-ms-examples:
        Get a specific update at an update location.:
          $ref: ./examples/Updates/Get.json
      tags:
        - Updates
      description: Get a specific update at an update location.
      operationId: microsoftAzureUpdatesGet
      parameters:
        - $ref: Update.json#/parameters/SubscriptionIdParameter
        - $ref: Update.json#/parameters/ResourceGroupParameter
        - $ref: UpdateLocations.json#/parameters/UpdateLocationParameter
        - $ref: Updates.json#/parameters/UpdateParameter
        - $ref: Update.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Update'
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Update Admin Updatelocations Updatelocation Updates Updatename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Update.Admin/updateLocations/{updateLocation}/updates/{updateName}/Apply
  : post:
      x-ms-examples:
        Apply a specific update at an update location.:
          $ref: ./examples/Updates/Apply.json
      tags:
        - Updates
      description: Apply a specific update at an update location.
      operationId: microsoftAzureUpdatesApply
      parameters:
        - $ref: Update.json#/parameters/SubscriptionIdParameter
        - $ref: Update.json#/parameters/ResourceGroupParameter
        - $ref: UpdateLocations.json#/parameters/UpdateLocationParameter
        - $ref: Updates.json#/parameters/UpdateParameter
        - $ref: Update.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: UpdateRuns.json#/definitions/UpdateRun
        '202':
          description: ACCEPTED
          schema:
            $ref: UpdateRuns.json#/definitions/UpdateRun
      x-ms-long-running-operation: true
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Update Admin Updatelocations Updatelocation Updates Updatename Apply
definitions:
  Update:
    description: Information pertaining to an update.
    type: object
    properties:
      properties:
        description: Properties of an update.
        x-ms-client-flatten: true
        $ref: '#/definitions/UpdateModel'
    allOf:
      - $ref: Update.json#/definitions/Resource
  UpdateModel:
    description: Properties of an update.
    properties:
      installedDate:
        description: Date update was installed.
        type: string
        format: date-time
      description:
        description: Description of the update.
        type: string
      state:
        description: Current state of the update.
        $ref: '#/definitions/UpdateState'
      kbLink:
        description: Link to the KB article about the update.
        type: string
      minVersionRequired:
        description: The minimum version required to install.
        type: string
      minOemVersionRequired:
        description: The minimum OEM version required to install.
        type: string
      packagePath:
        description: Path to the update package.
        type: string
      packageSizeInMb:
        description: Size of update package.
        type: integer
        format: int64
      displayName:
        description: Name of the update.
        type: string
      version:
        description: Version of the update.
        type: string
      oemVersion:
        description: OEM version of the update.
        type: string
      publisher:
        description: Publisher of the update.
        type: string
  UpdateList:
    description: List of updates.
    type: object
    properties:
      value:
        description: List of updates.
        type: array
        items:
          $ref: '#/definitions/Update'
      nextLink:
        description: URI to the next page of updates.
        type: string
  UpdateState:
    description: State of the update.
    type: string
    enum:
      - HasPrerequisite
      - Obsolete
      - Ready
      - NotApplicableBecauseAnotherUpdateIsInProgress
      - Preparing
      - Installing
      - Installed
      - PreparationFailed
      - InstallationFailed
    x-ms-enum:
      name: UpdateState
      modelAsString: true
parameters:
  UpdateParameter:
    name: updateName
    description: Name of the update.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
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
security:
  - azure_auth:
      - user_impersonation
tags:
  - name: Updates