你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Virtual Machines - Install Patches
在 VM 上安装修补程序。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches?api-version=2024-07-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 |
subscription
|
path | True |
string |
唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
vm
|
path | True |
string |
虚拟机的名称。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
installPatchesInput |
API 直接接收的 InstallPatches 的输入 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
还行 |
|
202 Accepted |
接受 |
|
Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
类型:
oauth2
流向:
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
定义
名称 | 说明 |
---|---|
Api |
Api 错误。 |
Api |
Api 错误基数。 |
Cloud |
来自计算服务的错误响应。 |
Inner |
内部错误详细信息。 |
Linux |
Linux VM 上的 InstallPatches 输入,如 API 直接接收 |
Patch |
在操作过程中安装的修补程序。 |
Patch |
安装操作完成后修补程序的状态。 |
Patch |
操作的总体成功或失败状态。 在操作完成之前,它将保持“InProgress”。 此时,它将成为“Failed”、“Succeeded”、“Unknown”或“CompletedWithWarnings”。 |
Virtual |
API 直接接收的 InstallPatches 的输入 |
Virtual |
安装操作的结果摘要。 |
VMGuest |
安装 Linux 修补程序时要选择的更新分类。 |
VMGuest |
安装 Windows 修补程序时要选择的更新分类。 |
VMGuest |
定义在软件更新操作期间重新启动 VM 是可以接受的。 |
VMGuest |
操作完成后 VM 的重新启动状态。 |
Windows |
Windows VM 上的 InstallPatches 的输入,如 API 直接接收 |
ApiError
Api 错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
API 错误详细信息 |
|
innererror |
Api 内部错误 |
|
message |
string |
错误消息。 |
target |
string |
特定错误的目标。 |
ApiErrorBase
Api 错误基数。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
message |
string |
错误消息。 |
target |
string |
特定错误的目标。 |
CloudError
来自计算服务的错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
Api 错误。 |
InnerError
内部错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
errordetail |
string |
内部错误消息或异常转储。 |
exceptiontype |
string |
异常类型。 |
LinuxParameters
Linux VM 上的 InstallPatches 输入,如 API 直接接收
名称 | 类型 | 说明 |
---|---|---|
classificationsToInclude |
安装 Linux 修补程序时要选择的更新分类。 |
|
maintenanceRunId |
string |
这用作 Linux 中自动 VM 来宾修补的维护运行标识符。 |
packageNameMasksToExclude |
string[] |
要排除在修补程序操作中的包。 格式:packageName_packageVersion |
packageNameMasksToInclude |
string[] |
要包含在修补操作中的包。 格式:packageName_packageVersion |
PatchInstallationDetail
在操作过程中安装的修补程序。
名称 | 类型 | 说明 |
---|---|---|
classifications |
string[] |
修补程序的分类(s)由修补程序发布者提供。 |
installationState |
安装操作完成后修补程序的状态。 |
|
kbId |
string |
修补程序的 KBID。 仅适用于 Windows 修补程序。 |
name |
string |
修补程序的友好名称。 |
patchId |
string |
修补程序的唯一标识符。 |
version |
string |
包的版本字符串。 它可能符合语义版本控制。 仅适用于 Linux。 |
PatchInstallationState
安装操作完成后修补程序的状态。
值 | 说明 |
---|---|
Excluded | |
Failed | |
Installed | |
NotSelected | |
Pending | |
Unknown |
PatchOperationStatus
操作的总体成功或失败状态。 在操作完成之前,它将保持“InProgress”。 此时,它将成为“Failed”、“Succeeded”、“Unknown”或“CompletedWithWarnings”。
值 | 说明 |
---|---|
CompletedWithWarnings | |
Failed | |
InProgress | |
Succeeded | |
Unknown |
VirtualMachineInstallPatchesParameters
API 直接接收的 InstallPatches 的输入
名称 | 类型 | 说明 |
---|---|---|
linuxParameters |
Linux VM 上的 InstallPatches 输入,如 API 直接接收 |
|
maximumDuration |
string |
指定操作将运行的最大时间量。 它必须是符合 ISO 8601 的持续时间字符串,如 PT4H(4 小时) |
rebootSetting |
定义在软件更新操作期间重新启动 VM 是可以接受的。 |
|
windowsParameters |
Windows VM 上的 InstallPatches 的输入,如 API 直接接收 |
VirtualMachineInstallPatchesResult
安装操作的结果摘要。
名称 | 类型 | 说明 |
---|---|---|
error |
执行操作期间遇到的错误。 详细信息数组包含它们的列表。 |
|
excludedPatchCount |
integer |
由于用户阻止安装而未安装的修补程序数。 |
failedPatchCount |
integer |
由于某些问题,无法安装的修补程序数。 有关详细信息,请参阅错误。 |
installationActivityId |
string |
生成此结果的操作的活动 ID。 它用于跨 CRP 和扩展日志关联。 |
installedPatchCount |
integer |
已成功安装的修补程序数。 |
maintenanceWindowExceeded |
boolean |
操作在完成所有预期操作之前是否用完时间。 |
notSelectedPatchCount |
integer |
检测到可用于安装的修补程序数,但不符合操作的条件。 |
patches |
在操作过程中安装的修补程序。 |
|
pendingPatchCount |
integer |
标识为满足安装条件但无法安装的修补程序数。 通常在 maintenanceWindowExceeded == true 时发生这种情况。 |
rebootStatus |
操作完成后 VM 的重新启动状态。 |
|
startDateTime |
string |
操作开始时的 UTC 时间戳。 |
status |
操作的总体成功或失败状态。 在操作完成之前,它将保持“InProgress”。 此时,它将成为“Failed”、“Succeeded”、“Unknown”或“CompletedWithWarnings”。 |
VMGuestPatchClassification_Linux
安装 Linux 修补程序时要选择的更新分类。
值 | 说明 |
---|---|
Critical | |
Other | |
Security |
VMGuestPatchClassification_Windows
安装 Windows 修补程序时要选择的更新分类。
值 | 说明 |
---|---|
Critical | |
Definition | |
FeaturePack | |
Security | |
ServicePack | |
Tools | |
UpdateRollUp | |
Updates |
VMGuestPatchRebootSetting
定义在软件更新操作期间重新启动 VM 是可以接受的。
值 | 说明 |
---|---|
Always | |
IfRequired | |
Never |
VMGuestPatchRebootStatus
操作完成后 VM 的重新启动状态。
值 | 说明 |
---|---|
Completed | |
Failed | |
NotNeeded | |
Required | |
Started | |
Unknown |
WindowsParameters
Windows VM 上的 InstallPatches 的输入,如 API 直接接收
名称 | 类型 | 说明 |
---|---|---|
classificationsToInclude |
安装 Windows 修补程序时要选择的更新分类。 |
|
excludeKbsRequiringReboot |
boolean |
筛选掉在设置为 true 时没有“NeverReboots”的 InstallationRebootBehavior 的 Kbs。 |
kbNumbersToExclude |
string[] |
在修补操作中要排除的 Kbs |
kbNumbersToInclude |
string[] |
要包含在修补操作中的 Kbs |
maxPatchPublishDate |
string |
这用于安装在此给定最大发布日期或之前发布的修补程序。 |