Поделиться через


Virtual Machines - Install Patches

Устанавливает исправления на виртуальной машине.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches?api-version=2024-07-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.

vmName
path True

string

Имя виртуальной машины.

api-version
query True

string

Версия клиентского API.

Текст запроса

Имя Тип Описание
installPatchesInput

VirtualMachineInstallPatchesParameters

Входные данные для InstallPatches как непосредственно полученные API

Ответы

Имя Тип Описание
200 OK

VirtualMachineInstallPatchesResult

ХОРОШО

202 Accepted

Принятый

Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Install patch state of a virtual machine.

Образец запроса

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/installPatches?api-version=2024-07-01

{
  "maximumDuration": "PT4H",
  "rebootSetting": "IfRequired",
  "windowsParameters": {
    "classificationsToInclude": [
      "Critical",
      "Security"
    ],
    "maxPatchPublishDate": "2020-11-19T02:36:43.0539904+00:00"
  }
}

Пример ответа

{
  "status": "Succeeded",
  "installationActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
  "rebootStatus": "Completed",
  "maintenanceWindowExceeded": false,
  "excludedPatchCount": 0,
  "notSelectedPatchCount": 0,
  "pendingPatchCount": 2,
  "installedPatchCount": 3,
  "failedPatchCount": 0,
  "startDateTime": "2020-04-24T21:02:04.2556154Z",
  "patches": [
    {
      "patchId": "35428702-5784-4ba4-a6e0-5222258b5411",
      "name": "Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)",
      "version": "",
      "kbId": "2267602",
      "classifications": [
        "Definition Updates"
      ],
      "installationState": "Installed"
    },
    {
      "patchId": "39f9cdd1-795c-4d0e-8c0a-73ab3f31746d",
      "name": "Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)",
      "version": "",
      "kbId": "890830",
      "classifications": [
        "Update Rollups"
      ],
      "installationState": "Pending"
    }
  ],
  "error": null
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-07-01

Определения

Имя Описание
ApiError

Ошибка API.

ApiErrorBase

База ошибок API.

CloudError

Ответ на ошибку из службы вычислений.

InnerError

Сведения о внутренней ошибке.

LinuxParameters

Входные данные для InstallPatches на виртуальной машине Linux, как непосредственно полученные API

PatchInstallationDetail

Исправления, установленные во время операции.

PatchInstallationState

Состояние исправления после завершения операции установки.

PatchOperationStatus

Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе он станет "Сбой", "Успешно", "Неизвестно" или "CompletedWithWarnings".

VirtualMachineInstallPatchesParameters

Входные данные для InstallPatches как непосредственно полученные API

VirtualMachineInstallPatchesResult

Сводка результатов операции установки.

VMGuestPatchClassification_Linux

Классификации обновлений для выбора при установке исправлений для Linux.

VMGuestPatchClassification_Windows

Классификации обновлений для выбора при установке исправлений для Windows.

VMGuestPatchRebootSetting

Определяет, когда можно перезагрузить виртуальную машину во время операции обновления программного обеспечения.

VMGuestPatchRebootStatus

Состояние перезагрузки виртуальной машины после завершения операции.

WindowsParameters

Входные данные для installPatches на виртуальной машине Windows, как непосредственно полученные API

ApiError

Ошибка API.

Имя Тип Описание
code

string

Код ошибки.

details

ApiErrorBase[]

Сведения об ошибке API

innererror

InnerError

Внутренняя ошибка API

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке.

target

string

Целевой объект конкретной ошибки.

CloudError

Ответ на ошибку из службы вычислений.

Имя Тип Описание
error

ApiError

Ошибка API.

InnerError

Сведения о внутренней ошибке.

Имя Тип Описание
errordetail

string

Внутреннее сообщение об ошибке или дамп исключений.

exceptiontype

string

Тип исключения.

LinuxParameters

Входные данные для InstallPatches на виртуальной машине Linux, как непосредственно полученные API

Имя Тип Описание
classificationsToInclude

VMGuestPatchClassification_Linux[]

Классификации обновлений для выбора при установке исправлений для Linux.

maintenanceRunId

string

Это используется в качестве идентификатора запуска обслуживания для автоматического исправления гостевой виртуальной машины в Linux.

packageNameMasksToExclude

string[]

пакеты для исключения в операции исправления. Формат: packageName_packageVersion

packageNameMasksToInclude

string[]

пакеты для включения в операцию исправления. Формат: packageName_packageVersion

PatchInstallationDetail

Исправления, установленные во время операции.

Имя Тип Описание
classifications

string[]

Классификации исправлений, предоставляемые издателем исправлений.

installationState

PatchInstallationState

Состояние исправления после завершения операции установки.

kbId

string

KBID исправления. Применяется только к исправлениям Windows.

name

string

Понятное имя исправления.

patchId

string

Уникальный идентификатор исправления.

version

string

Строка версии пакета. Он может соответствовать семантической версии. Применяется только к Linux.

PatchInstallationState

Состояние исправления после завершения операции установки.

Значение Описание
Excluded
Failed
Installed
NotSelected
Pending
Unknown

PatchOperationStatus

Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе он станет "Сбой", "Успешно", "Неизвестно" или "CompletedWithWarnings".

Значение Описание
CompletedWithWarnings
Failed
InProgress
Succeeded
Unknown

VirtualMachineInstallPatchesParameters

Входные данные для InstallPatches как непосредственно полученные API

Имя Тип Описание
linuxParameters

LinuxParameters

Входные данные для InstallPatches на виртуальной машине Linux, как непосредственно полученные API

maximumDuration

string

Указывает максимальное время выполнения операции. Это должна быть строка длительности, совместимая с ISO 8601, например PT4H (4 часа).

rebootSetting

VMGuestPatchRebootSetting

Определяет, когда можно перезагрузить виртуальную машину во время операции обновления программного обеспечения.

windowsParameters

WindowsParameters

Входные данные для installPatches на виртуальной машине Windows, как непосредственно полученные API

VirtualMachineInstallPatchesResult

Сводка результатов операции установки.

Имя Тип Описание
error

ApiError

Ошибки, возникшие во время выполнения операции. Массив сведений содержит список из них.

excludedPatchCount

integer

Количество исправлений, которые не были установлены из-за блокировки установки пользователем.

failedPatchCount

integer

Количество исправлений, которые не удалось установить из-за некоторых проблем. Дополнительные сведения см. в ошибках.

installationActivityId

string

Идентификатор действия операции, создающей этот результат. Он используется для корреляции между журналами БЕЗОПАСНОСТИ и расширений.

installedPatchCount

integer

Количество исправлений успешно установлено.

maintenanceWindowExceeded

boolean

Истекло ли время операции до завершения всех его предполагаемых действий.

notSelectedPatchCount

integer

Количество исправлений, обнаруженных как доступных для установки, но не соответствовало критериям операции.

patches

PatchInstallationDetail[]

Исправления, установленные во время операции.

pendingPatchCount

integer

Количество исправлений, которые были определены как соответствующие критериям установки, но не удалось установить. Обычно это происходит при обслуживанииWindowExceeded == true.

rebootStatus

VMGuestPatchRebootStatus

Состояние перезагрузки виртуальной машины после завершения операции.

startDateTime

string

Метка времени UTC при начале операции.

status

PatchOperationStatus

Общее состояние успешного выполнения или сбоя операции. Он остается "InProgress" до завершения операции. На этом этапе он станет "Сбой", "Успешно", "Неизвестно" или "CompletedWithWarnings".

VMGuestPatchClassification_Linux

Классификации обновлений для выбора при установке исправлений для Linux.

Значение Описание
Critical
Other
Security

VMGuestPatchClassification_Windows

Классификации обновлений для выбора при установке исправлений для Windows.

Значение Описание
Critical
Definition
FeaturePack
Security
ServicePack
Tools
UpdateRollUp
Updates

VMGuestPatchRebootSetting

Определяет, когда можно перезагрузить виртуальную машину во время операции обновления программного обеспечения.

Значение Описание
Always
IfRequired
Never

VMGuestPatchRebootStatus

Состояние перезагрузки виртуальной машины после завершения операции.

Значение Описание
Completed
Failed
NotNeeded
Required
Started
Unknown

WindowsParameters

Входные данные для installPatches на виртуальной машине Windows, как непосредственно полученные API

Имя Тип Описание
classificationsToInclude

VMGuestPatchClassification_Windows[]

Классификации обновлений для выбора при установке исправлений для Windows.

excludeKbsRequiringReboot

boolean

Отфильтровывает базы знаний, у которых нет объекта InstallationRebootBehavior 'NeverReboots', если задано значение true.

kbNumbersToExclude

string[]

Кб для исключения в операции исправления

kbNumbersToInclude

string[]

Кб для включения в операцию исправления

maxPatchPublishDate

string

Это используется для установки исправлений, опубликованных до указанной максимальной даты публикации.