Virtual Machines - Install Patches
Installeert patches op de VM.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches?api-version=2025-04-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
De naam van de resourcegroep. De naam is hoofdletterongevoelig. |
|
subscription
|
path | True |
string minLength: 1 |
De id van het doelabonnement. |
|
vm
|
path | True |
string |
De naam van de virtuele machine. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagbody
| Name | Vereist | Type | Description |
|---|---|---|---|
| rebootSetting | True |
Definieert wanneer het acceptabel is om een VIRTUELE machine opnieuw op te starten tijdens een software-updatebewerking. |
|
| linuxParameters |
Invoer voor InstallPatches op een Linux-VM, zoals rechtstreeks ontvangen door de API |
||
| maximumDuration |
string (duration) |
Hiermee geeft u de maximale tijdsduur op die de bewerking wordt uitgevoerd. Het moet een iso 8601-compatibele duurtekenreeks zijn, zoals PT4H (4 uur) |
|
| windowsParameters |
Invoer voor InstallPatches op een Windows-VM, zoals rechtstreeks ontvangen door de API |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
Azure-bewerking is voltooid. |
|
| 202 Accepted |
Resourcebewerking geaccepteerd. Kopteksten
|
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
azure_auth
OAuth2-stroom voor Azure Active Directory.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Install patch state of a virtual machine.
Voorbeeldaanvraag
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*"
]
}
}
Voorbeeldrespons
{
"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
Definities
| Name | Description |
|---|---|
|
Api |
Api-fout. |
|
Api |
Api-foutbasis. |
|
Cloud |
Een foutreactie van de Compute-service. |
|
Inner |
Interne foutdetails. |
|
Linux |
Invoer voor InstallPatches op een Linux-VM, zoals rechtstreeks ontvangen door de API |
|
Patch |
Informatie over een specifieke patch die is aangetroffen tijdens een installatieactie. |
|
Patch |
De status van de patch nadat de installatiebewerking is voltooid. |
|
Patch |
De algehele succes- of mislukkingsstatus van de operatie. Het blijft "InProgress" totdat de bewerking is voltooid. Op dat moment wordt het "Onbekend", "Mislukt", "Geslaagd" of "VoltooidMetWaarschuwingen". |
|
Virtual |
Invoer voor InstallPatches zoals rechtstreeks ontvangen door de API |
|
Virtual |
Het resultaat samenvatting van een installatiebewerking. |
|
VMGuest |
|
|
VMGuest |
|
|
VMGuest |
Definieert wanneer het acceptabel is om een VIRTUELE machine opnieuw op te starten tijdens een software-updatebewerking. |
|
VMGuest |
De herstartstatus van de VM na voltooiing van de bewerking. |
|
Windows |
Invoer voor InstallPatches op een Windows-VM, zoals rechtstreeks ontvangen door de API |
ApiError
Api-fout.
| Name | Type | Description |
|---|---|---|
| code |
string |
De foutcode. |
| details |
Details van de Api-fout |
|
| innererror |
De innerlijke fout van de Api |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het doel van de specifieke fout. |
ApiErrorBase
Api-foutbasis.
| Name | Type | Description |
|---|---|---|
| code |
string |
De foutcode. |
| message |
string |
Het foutbericht. |
| target |
string |
Het doel van de specifieke fout. |
CloudError
Een foutreactie van de Compute-service.
| Name | Type | Description |
|---|---|---|
| error |
Api-fout. |
InnerError
Interne foutdetails.
| Name | Type | Description |
|---|---|---|
| errordetail |
string |
De interne foutmelding of uitzonderingsdump. |
| exceptiontype |
string |
Het uitzonderingstype. |
LinuxParameters
Invoer voor InstallPatches op een Linux-VM, zoals rechtstreeks ontvangen door de API
| Name | Type | Description |
|---|---|---|
| classificationsToInclude |
De updateclassificaties die moeten worden geselecteerd bij het installeren van patches voor Linux. |
|
| maintenanceRunId |
string |
Dit wordt gebruikt als een id voor onderhoudsuitvoering voor Auto VM Guest Patching in Linux. |
| packageNameMasksToExclude |
string[] |
pakketten die moeten worden uitgesloten in de patchbewerking. Indeling: packageName_packageVersion |
| packageNameMasksToInclude |
string[] |
pakketten die moeten worden opgenomen in de patchbewerking. Indeling: packageName_packageVersion |
PatchInstallationDetail
Informatie over een specifieke patch die is aangetroffen tijdens een installatieactie.
| Name | Type | Description |
|---|---|---|
| classifications |
string[] |
De classificatie(s) van de patch zoals verstrekt door de uitgever van de patch. |
| installationState |
De status van de patch nadat de installatiebewerking is voltooid. |
|
| kbId |
string |
De KBID van de patch. Geldt alleen voor Windows-patches. |
| name |
string |
De vriendelijke naam van de patch. |
| patchId |
string |
Een unieke identificatiecode voor de patch. |
| version |
string |
De versiereeks van het pakket. Het kan voldoen aan semantisch versiebeheer. Geldt alleen voor Linux. |
PatchInstallationState
De status van de patch nadat de installatiebewerking is voltooid.
| Waarde | Description |
|---|---|
| Unknown | |
| Installed | |
| Failed | |
| Excluded | |
| NotSelected | |
| Pending |
PatchOperationStatus
De algehele succes- of mislukkingsstatus van de operatie. Het blijft "InProgress" totdat de bewerking is voltooid. Op dat moment wordt het "Onbekend", "Mislukt", "Geslaagd" of "VoltooidMetWaarschuwingen".
| Waarde | Description |
|---|---|
| Unknown | |
| InProgress | |
| Failed | |
| Succeeded | |
| CompletedWithWarnings |
VirtualMachineInstallPatchesParameters
Invoer voor InstallPatches zoals rechtstreeks ontvangen door de API
| Name | Type | Description |
|---|---|---|
| linuxParameters |
Invoer voor InstallPatches op een Linux-VM, zoals rechtstreeks ontvangen door de API |
|
| maximumDuration |
string (duration) |
Hiermee geeft u de maximale tijdsduur op die de bewerking wordt uitgevoerd. Het moet een iso 8601-compatibele duurtekenreeks zijn, zoals PT4H (4 uur) |
| rebootSetting |
Definieert wanneer het acceptabel is om een VIRTUELE machine opnieuw op te starten tijdens een software-updatebewerking. |
|
| windowsParameters |
Invoer voor InstallPatches op een Windows-VM, zoals rechtstreeks ontvangen door de API |
VirtualMachineInstallPatchesResult
Het resultaat samenvatting van een installatiebewerking.
| Name | Type | Description |
|---|---|---|
| error |
De fouten die zijn opgetreden tijdens de uitvoering van de bewerking. De detailarray bevat de lijst ervan. |
|
| excludedPatchCount |
integer (int32) |
Het aantal patches dat niet is geïnstalleerd omdat de gebruiker de installatie ervan blokkeert. |
| failedPatchCount |
integer (int32) |
Het aantal patches dat niet kon worden geïnstalleerd vanwege een probleem. Zie fouten voor meer informatie. |
| installationActivityId |
string |
De activiteit-id van de bewerking die dit resultaat heeft opgeleverd. Het wordt gebruikt om te correleren tussen CRP- en extensielogboeken. |
| installedPatchCount |
integer (int32) |
Het aantal patches dat met succes is geïnstalleerd. |
| maintenanceWindowExceeded |
boolean |
Of de operatie te laat was voordat alle beoogde acties waren voltooid. |
| notSelectedPatchCount |
integer (int32) |
Het aantal patches waarvan is vastgesteld dat ze beschikbaar zijn voor installatie, maar niet voldoen aan de criteria van de bewerking. |
| patches |
De patches die tijdens de operatie zijn geïnstalleerd. |
|
| pendingPatchCount |
integer (int32) |
Het aantal patches waarvan is vastgesteld dat ze voldoen aan de installatiecriteria, maar niet konden worden geïnstalleerd. Dit gebeurt meestal wanneer maintenanceWindowExceeded == true. |
| rebootStatus |
De herstartstatus van de VM na voltooiing van de bewerking. |
|
| startDateTime |
string (date-time) |
Het UTC-tijdstempel wanneer de bewerking begon. |
| status |
De algehele succes- of mislukkingsstatus van de operatie. Het blijft "InProgress" totdat de bewerking is voltooid. Op dat moment wordt het "Mislukt", "Geslaagd", "Onbekend" of "VoltooidMetWaarschuwingen". |
VMGuestPatchClassificationLinux
| Waarde | Description |
|---|---|
| Critical | |
| Security | |
| Other |
VMGuestPatchClassificationWindows
| Waarde | Description |
|---|---|
| Critical | |
| Security | |
| UpdateRollUp | |
| FeaturePack | |
| ServicePack | |
| Definition | |
| Tools | |
| Updates |
VMGuestPatchRebootSetting
Definieert wanneer het acceptabel is om een VIRTUELE machine opnieuw op te starten tijdens een software-updatebewerking.
| Waarde | Description |
|---|---|
| IfRequired | |
| Never | |
| Always |
VMGuestPatchRebootStatus
De herstartstatus van de VM na voltooiing van de bewerking.
| Waarde | Description |
|---|---|
| Unknown | |
| NotNeeded | |
| Required | |
| Started | |
| Failed | |
| Completed |
WindowsParameters
Invoer voor InstallPatches op een Windows-VM, zoals rechtstreeks ontvangen door de API
| Name | Type | Description |
|---|---|---|
| classificationsToInclude |
De updateclassificaties die moeten worden geselecteerd bij het installeren van patches voor Windows. |
|
| excludeKbsRequiringReboot |
boolean |
Hiermee filtert u Kbs die geen InstallationRebootBehavior van 'NeverReboots' hebben als dit is ingesteld op waar. |
| kbNumbersToExclude |
string[] |
Kbs die moeten worden uitgesloten in de patchbewerking |
| kbNumbersToInclude |
string[] |
Kbs die moeten worden opgenomen in de patchbewerking |
| maxPatchPublishDate |
string (date-time) |
Dit wordt gebruikt om patches te installeren die zijn gepubliceerd op of vóór deze maximale gepubliceerde datum. |
| patchNameMasksToExclude |
string[] |
Dit wordt gebruikt om patches uit te sluiten die overeenkomen met de gegeven patchnaammaskers. Alfanumerieke tekenreeksen en jokertekenexpressies bestaande uit * en ? worden alleen ondersteund als invoerwaarden in de lijst. Null-, lege en alleen spaties-tekenreeksen als invoerwaarden worden niet ondersteund. |
| patchNameMasksToInclude |
string[] |
Dit wordt gebruikt om patches op te nemen die overeenkomen met de gegeven patchnaammaskers. Alfanumerieke tekenreeksen en jokertekenexpressies bestaande uit * en ? worden alleen ondersteund als invoerwaarden in de lijst. Null-, lege en alleen spaties-tekenreeksen als invoerwaarden worden niet ondersteund. |