Virtual Machines - Install Patches
Installiert Patches auf der VM.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches?api-version=2025-04-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
|
subscription
|
path | True |
string minLength: 1 |
Hierbei handelt es sich um die ID des Zielabonnements. |
|
vm
|
path | True |
string |
Der Name des virtuellen Computers. |
|
api-version
|
query | True |
string minLength: 1 |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| rebootSetting | True |
Definiert, wann es akzeptabel ist, einen virtuellen Computer während eines Softwareupdatevorgangs neu zu starten. |
|
| linuxParameters |
Eingabe für InstallPatches auf einer Linux-VM, wie sie direkt von der API empfangen wird |
||
| maximumDuration |
string (duration) |
Gibt die maximale Zeitspanne an, die der Vorgang ausführt. Es muss eine ISO 8601-kompatible Dauerzeichenfolge wie PT4H (4 Stunden) sein. |
|
| windowsParameters |
Eingabe für InstallPatches auf einer Windows-VM, wie sie direkt von der API empfangen wird |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Der Azure-Vorgang wurde erfolgreich abgeschlossen. |
|
| 202 Accepted |
Ressourcenvorgang akzeptiert. Header
|
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Install patch state of a virtual machine.
Beispielanforderung
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/installPatches?api-version=2025-04-01
{
"maximumDuration": "PT4H",
"rebootSetting": "IfRequired",
"windowsParameters": {
"classificationsToInclude": [
"Critical",
"Security"
],
"maxPatchPublishDate": "2020-11-19T02:36:43.0539904+00:00",
"patchNameMasksToInclude": [
"*SQL*"
],
"patchNameMasksToExclude": [
"*Windows*"
]
}
}
Beispiel für eine Antwort
{
"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=2025-04-01
Definitionen
| Name | Beschreibung |
|---|---|
|
Api |
API-Fehler. |
|
Api |
API-Fehlerbasis. |
|
Cloud |
Eine Fehlerantwort vom Compute-Dienst. |
|
Inner |
Innere Fehlerdetails. |
|
Linux |
Eingabe für InstallPatches auf einer Linux-VM, wie sie direkt von der API empfangen wird |
|
Patch |
Informationen zu einem bestimmten Patch, der während einer Installationsaktion aufgetreten ist. |
|
Patch |
Der Status des Patches nach Abschluss des Installationsvorgangs. |
|
Patch |
Der allgemeine Erfolgs- oder Fehlerstatus des Vorgangs. Er bleibt "InProgress", bis der Vorgang abgeschlossen ist. Zu diesem Zeitpunkt wird es zu "Unbekannt", "Fehlgeschlagen", "Erfolgreich" oder "AbgeschlossenWithWarnings". |
|
Virtual |
Eingabe für InstallPatches, wie sie direkt von der API empfangen wird |
|
Virtual |
Die Ergebniszusammenfassung eines Installationsvorgangs. |
|
VMGuest |
|
|
VMGuest |
|
|
VMGuest |
Definiert, wann es akzeptabel ist, einen virtuellen Computer während eines Softwareupdatevorgangs neu zu starten. |
|
VMGuest |
Der Neustartstatus der VM nach Abschluss des Vorgangs. |
|
Windows |
Eingabe für InstallPatches auf einer Windows-VM, wie sie direkt von der API empfangen wird |
ApiError
API-Fehler.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Der Fehlercode. |
| details |
Die Details zum API-Fehler |
|
| innererror |
Der innere API-Fehler |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Ziel des bestimmten Fehlers. |
ApiErrorBase
API-Fehlerbasis.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Der Fehlercode. |
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Ziel des bestimmten Fehlers. |
CloudError
Eine Fehlerantwort vom Compute-Dienst.
| Name | Typ | Beschreibung |
|---|---|---|
| error |
API-Fehler. |
InnerError
Innere Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| errordetail |
string |
Die interne Fehlermeldung oder der Ausnahmedump. |
| exceptiontype |
string |
Der Ausnahmetyp. |
LinuxParameters
Eingabe für InstallPatches auf einer Linux-VM, wie sie direkt von der API empfangen wird
| Name | Typ | Beschreibung |
|---|---|---|
| classificationsToInclude |
Die Updateklassifizierungen, die beim Installieren von Patches für Linux ausgewählt werden sollen. |
|
| maintenanceRunId |
string |
Dies wird als Wartungslauf-ID für das automatische Patchen von VM-Gästen unter Linux verwendet. |
| packageNameMasksToExclude |
string[] |
Pakete, die im Patchvorgang ausgeschlossen werden sollen. Format: packageName_packageVersion |
| packageNameMasksToInclude |
string[] |
Pakete, die in den Patchvorgang eingeschlossen werden sollen. Format: packageName_packageVersion |
PatchInstallationDetail
Informationen zu einem bestimmten Patch, der während einer Installationsaktion aufgetreten ist.
| Name | Typ | Beschreibung |
|---|---|---|
| classifications |
string[] |
Die Klassifizierung(en) des Patches, wie sie vom Patch-Herausgeber bereitgestellt werden. |
| installationState |
Der Status des Patches nach Abschluss des Installationsvorgangs. |
|
| kbId |
string |
Die KBID des Patches. Gilt nur für Windows-Patches. |
| name |
string |
Der Anzeigename des Patches. |
| patchId |
string |
Eine eindeutige Kennung für den Patch. |
| version |
string |
Die Versionszeichenfolge des Pakets. Sie kann der semantischen Versionierung entsprechen. Gilt nur für Linux. |
PatchInstallationState
Der Status des Patches nach Abschluss des Installationsvorgangs.
| Wert | Beschreibung |
|---|---|
| Unknown | |
| Installed | |
| Failed | |
| Excluded | |
| NotSelected | |
| Pending |
PatchOperationStatus
Der allgemeine Erfolgs- oder Fehlerstatus des Vorgangs. Er bleibt "InProgress", bis der Vorgang abgeschlossen ist. Zu diesem Zeitpunkt wird es zu "Unbekannt", "Fehlgeschlagen", "Erfolgreich" oder "AbgeschlossenWithWarnings".
| Wert | Beschreibung |
|---|---|
| Unknown | |
| InProgress | |
| Failed | |
| Succeeded | |
| CompletedWithWarnings |
VirtualMachineInstallPatchesParameters
Eingabe für InstallPatches, wie sie direkt von der API empfangen wird
| Name | Typ | Beschreibung |
|---|---|---|
| linuxParameters |
Eingabe für InstallPatches auf einer Linux-VM, wie sie direkt von der API empfangen wird |
|
| maximumDuration |
string (duration) |
Gibt die maximale Zeitspanne an, die der Vorgang ausführt. Es muss eine ISO 8601-kompatible Dauerzeichenfolge wie PT4H (4 Stunden) sein. |
| rebootSetting |
Definiert, wann es akzeptabel ist, einen virtuellen Computer während eines Softwareupdatevorgangs neu zu starten. |
|
| windowsParameters |
Eingabe für InstallPatches auf einer Windows-VM, wie sie direkt von der API empfangen wird |
VirtualMachineInstallPatchesResult
Die Ergebniszusammenfassung eines Installationsvorgangs.
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Die Fehler, die während der Ausführung des Vorgangs aufgetreten sind. Das Details-Array enthält die Liste der Arrays. |
|
| excludedPatchCount |
integer (int32) |
Die Anzahl der Patches, die nicht installiert wurden, weil der Benutzer die Installation blockiert hat. |
| failedPatchCount |
integer (int32) |
Die Anzahl der Patches, die aufgrund eines Problems nicht installiert werden konnten. Weitere Informationen finden Sie unter Fehler. |
| installationActivityId |
string |
Die Aktivitäts-ID des Vorgangs, der dieses Ergebnis erzeugt hat. Es wird verwendet, um CRP- und Erweiterungsprotokolle zu korrelieren. |
| installedPatchCount |
integer (int32) |
Die Anzahl der erfolgreich installierten Patches. |
| maintenanceWindowExceeded |
boolean |
Gibt an, ob die Zeit des Vorgangs abgelaufen ist, bevor er alle beabsichtigten Aktionen ausgeführt hat. |
| notSelectedPatchCount |
integer (int32) |
Die Anzahl der Patches, die als zur Installation verfügbar erkannt wurden, aber die Kriterien des Vorgangs nicht erfüllten. |
| patches |
Die Patches, die während des Vorgangs installiert wurden. |
|
| pendingPatchCount |
integer (int32) |
Die Anzahl der Patches, die als die Installationskriterien erfüllend identifiziert wurden, aber nicht installiert werden konnten. In der Regel geschieht dies, wenn maintenanceWindowExceeded == true ist. |
| rebootStatus |
Der Neustartstatus der VM nach Abschluss des Vorgangs. |
|
| startDateTime |
string (date-time) |
Der UTC-Zeitstempel, zu dem der Vorgang gestartet wurde. |
| status |
Der allgemeine Erfolgs- oder Fehlerstatus des Vorgangs. Er bleibt "InProgress", bis der Vorgang abgeschlossen ist. Zu diesem Zeitpunkt wird es zu "Fehlgeschlagen", "Erfolgreich", "Unbekannt" oder "AbgeschlossenWithWarnings". |
VMGuestPatchClassificationLinux
| Wert | Beschreibung |
|---|---|
| Critical | |
| Security | |
| Other |
VMGuestPatchClassificationWindows
| Wert | Beschreibung |
|---|---|
| Critical | |
| Security | |
| UpdateRollUp | |
| FeaturePack | |
| ServicePack | |
| Definition | |
| Tools | |
| Updates |
VMGuestPatchRebootSetting
Definiert, wann es akzeptabel ist, einen virtuellen Computer während eines Softwareupdatevorgangs neu zu starten.
| Wert | Beschreibung |
|---|---|
| IfRequired | |
| Never | |
| Always |
VMGuestPatchRebootStatus
Der Neustartstatus der VM nach Abschluss des Vorgangs.
| Wert | Beschreibung |
|---|---|
| Unknown | |
| NotNeeded | |
| Required | |
| Started | |
| Failed | |
| Completed |
WindowsParameters
Eingabe für InstallPatches auf einer Windows-VM, wie sie direkt von der API empfangen wird
| Name | Typ | Beschreibung |
|---|---|---|
| classificationsToInclude |
Die Updateklassifizierungen, die beim Installieren von Patches für Windows ausgewählt werden sollen. |
|
| excludeKbsRequiringReboot |
boolean |
Filtert KBs aus, die nicht über "InstallationRebootBehavior" von "NeverReboots" verfügen, wenn dies auf "true" festgelegt ist. |
| kbNumbersToExclude |
string[] |
Kbs, die im Patchvorgang ausgeschlossen werden sollen |
| kbNumbersToInclude |
string[] |
Kbs, die in den Patchvorgang aufgenommen werden sollen |
| maxPatchPublishDate |
string (date-time) |
Dies wird verwendet, um Patches zu installieren, die am oder vor diesem angegebenen maximalen Veröffentlichungsdatum veröffentlicht wurden. |
| patchNameMasksToExclude |
string[] |
Dies wird verwendet, um Patches auszuschließen, die mit den angegebenen Patch-Namensmasken übereinstimmen. Alphanumerische Zeichenfolgen und Platzhalterausdrücke, die aus * und ? werden nur als Eingabewerte in der Liste unterstützt. Null-, Leerzeichenfolgen und nur Leerzeichen als Eingabewerte werden nicht unterstützt. |
| patchNameMasksToInclude |
string[] |
Dies wird verwendet, um Patches einzuschließen, die mit den angegebenen Patch-Namensmasken übereinstimmen. Alphanumerische Zeichenfolgen und Platzhalterausdrücke, die aus * und ? werden nur als Eingabewerte in der Liste unterstützt. Null-, Leerzeichenfolgen und nur Leerzeichen als Eingabewerte werden nicht unterstützt. |