Virtual Machines - Install Patches

Riferimento

Servizio:: Compute

Versione API:: 2024-07-01

Installa le patch nella macchina virtuale.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
vmName	path	True	string	Nome della macchina virtuale.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
installPatchesInput	VirtualMachineInstallPatchesParameters	Input per InstallPatches come ricevuto direttamente dall'API

Risposte

Nome	Tipo	Descrizione
200 OK	VirtualMachineInstallPatchesResult	OK
202 Accepted		Accettato
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Install patch state of a virtual machine.

Esempio di richiesta

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"
  }
}


import com.azure.resourcemanager.compute.models.VMGuestPatchClassificationWindows;
import com.azure.resourcemanager.compute.models.VMGuestPatchRebootSetting;
import com.azure.resourcemanager.compute.models.VirtualMachineInstallPatchesParameters;
import com.azure.resourcemanager.compute.models.WindowsParameters;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for VirtualMachines InstallPatches.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
     * virtualMachineExamples/VirtualMachine_InstallPatches.json
     */
    /**
     * Sample code: Install patch state of a virtual machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void installPatchStateOfAVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().installPatches("myResourceGroupName",
            "myVMName",
            new VirtualMachineInstallPatchesParameters().withMaximumDuration("PT4H")
                .withRebootSetting(VMGuestPatchRebootSetting.IF_REQUIRED)
                .withWindowsParameters(new WindowsParameters()
                    .withClassificationsToInclude(Arrays.asList(VMGuestPatchClassificationWindows.CRITICAL,
                        VMGuestPatchClassificationWindows.SECURITY))
                    .withMaxPatchPublishDate(OffsetDateTime.parse("2020-11-19T02:36:43.0539904+00:00"))),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_install_patches.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.virtual_machines.begin_install_patches(
        resource_group_name="myResourceGroupName",
        vm_name="myVMName",
        install_patches_input={
            "maximumDuration": "PT4H",
            "rebootSetting": "IfRequired",
            "windowsParameters": {
                "classificationsToInclude": ["Critical", "Security"],
                "maxPatchPublishDate": "2020-11-19T02:36:43.0539904+00:00",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcompute_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json
func ExampleVirtualMachinesClient_BeginInstallPatches() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualMachinesClient().BeginInstallPatches(ctx, "myResourceGroupName", "myVMName", armcompute.VirtualMachineInstallPatchesParameters{
		MaximumDuration: to.Ptr("PT4H"),
		RebootSetting:   to.Ptr(armcompute.VMGuestPatchRebootSettingIfRequired),
		WindowsParameters: &armcompute.WindowsParameters{
			ClassificationsToInclude: []*armcompute.VMGuestPatchClassificationWindows{
				to.Ptr(armcompute.VMGuestPatchClassificationWindowsCritical),
				to.Ptr(armcompute.VMGuestPatchClassificationWindowsSecurity)},
			MaxPatchPublishDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-19T02:36:43.053Z"); return t }()),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.VirtualMachineInstallPatchesResult = armcompute.VirtualMachineInstallPatchesResult{
	// 	ExcludedPatchCount: to.Ptr[int32](0),
	// 	FailedPatchCount: to.Ptr[int32](0),
	// 	InstallationActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 	InstalledPatchCount: to.Ptr[int32](3),
	// 	MaintenanceWindowExceeded: to.Ptr(false),
	// 	NotSelectedPatchCount: to.Ptr[int32](0),
	// 	Patches: []*armcompute.PatchInstallationDetail{
	// 		{
	// 			Name: to.Ptr("Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)"),
	// 			Classifications: []*string{
	// 				to.Ptr("Definition Updates")},
	// 				InstallationState: to.Ptr(armcompute.PatchInstallationStateInstalled),
	// 				KbID: to.Ptr("2267602"),
	// 				PatchID: to.Ptr("35428702-5784-4ba4-a6e0-5222258b5411"),
	// 				Version: to.Ptr(""),
	// 			},
	// 			{
	// 				Name: to.Ptr("Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)"),
	// 				Classifications: []*string{
	// 					to.Ptr("Update Rollups")},
	// 					InstallationState: to.Ptr(armcompute.PatchInstallationStatePending),
	// 					KbID: to.Ptr("890830"),
	// 					PatchID: to.Ptr("39f9cdd1-795c-4d0e-8c0a-73ab3f31746d"),
	// 					Version: to.Ptr(""),
	// 			}},
	// 			PendingPatchCount: to.Ptr[int32](2),
	// 			RebootStatus: to.Ptr(armcompute.VMGuestPatchRebootStatusCompleted),
	// 			StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:02:04.255Z"); return t}()),
	// 			Status: to.Ptr(armcompute.PatchOperationStatusSucceeded),
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Installs patches on the VM.
 *
 * @summary Installs patches on the VM.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json
 */
async function installPatchStateOfAVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroupName";
  const vmName = "myVMName";
  const installPatchesInput = {
    maximumDuration: "PT4H",
    rebootSetting: "IfRequired",
    windowsParameters: {
      classificationsToInclude: ["Critical", "Security"],
      maxPatchPublishDate: new Date("2020-11-19T02:36:43.0539904+00:00"),
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginInstallPatchesAndWait(
    resourceGroupName,
    vmName,
    installPatchesInput,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json
// this example is just showing the usage of "VirtualMachines_InstallPatches" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualMachineResource created on azure
// for more information of creating VirtualMachineResource, please refer to the document of VirtualMachineResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroupName";
string vmName = "myVMName";
ResourceIdentifier virtualMachineResourceId = VirtualMachineResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName);
VirtualMachineResource virtualMachine = client.GetVirtualMachineResource(virtualMachineResourceId);

// invoke the operation
VirtualMachineInstallPatchesContent content = new VirtualMachineInstallPatchesContent(VmGuestPatchRebootSetting.IfRequired)
{
    MaximumDuration = XmlConvert.ToTimeSpan("PT4H"),
    WindowsParameters = new WindowsParameters
    {
        ClassificationsToInclude = { VmGuestPatchClassificationForWindows.Critical, VmGuestPatchClassificationForWindows.Security },
        MaxPatchPublishOn = DateTimeOffset.Parse("2020-11-19T02:36:43.0539904+00:00"),
    },
};
ArmOperation<VirtualMachineInstallPatchesResult> lro = await virtualMachine.InstallPatchesAsync(WaitUntil.Completed, content);
VirtualMachineInstallPatchesResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "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
}

Codice di stato:: 202

Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-07-01

Definizioni

Nome	Descrizione
ApiError	Errore dell'API.
ApiErrorBase	Base degli errori api.
CloudError	Risposta di errore dal servizio di calcolo.
InnerError	Dettagli dell'errore interno.
LinuxParameters	Input per InstallPatches in una macchina virtuale Linux, come ricevuto direttamente dall'API
PatchInstallationDetail	Patch installate durante l'operazione.
PatchInstallationState	Stato della patch al termine dell'operazione di installazione.
PatchOperationStatus	Stato complessivo di esito positivo o negativo dell'operazione. Rimane "InProgress" fino al completamento dell'operazione. A quel punto diventerà "Failed", "Succeeded", "Unknown" o "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Input per InstallPatches come ricevuto direttamente dall'API
VirtualMachineInstallPatchesResult	Riepilogo dei risultati di un'operazione di installazione.
VMGuestPatchClassification_Linux	Classificazioni degli aggiornamenti da selezionare durante l'installazione delle patch per Linux.
VMGuestPatchClassification_Windows	Classificazioni degli aggiornamenti da selezionare durante l'installazione delle patch per Windows.
VMGuestPatchRebootSetting	Definisce quando è accettabile riavviare una macchina virtuale durante un'operazione di aggiornamento software.
VMGuestPatchRebootStatus	Stato di riavvio della macchina virtuale dopo il completamento dell'operazione.
WindowsParameters	Input per InstallPatches in una macchina virtuale Windows, come ricevuto direttamente dall'API

ApiError

Errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore dell'API
innererror	InnerError	Errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Base degli errori api.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

CloudError

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore dell'API.

InnerError

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump delle eccezioni.
exceptiontype	string	Tipo di eccezione.

LinuxParameters

Input per InstallPatches in una macchina virtuale Linux, come ricevuto direttamente dall'API

Nome	Tipo	Descrizione
classificationsToInclude	VMGuestPatchClassification_Linux[]	Classificazioni degli aggiornamenti da selezionare durante l'installazione delle patch per Linux.
maintenanceRunId	string	Viene usato come identificatore di esecuzione della manutenzione per l'applicazione automatica di patch guest alle macchine virtuali in Linux.
packageNameMasksToExclude	string[]	pacchetti da escludere nell'operazione patch. Formato: packageName_packageVersion
packageNameMasksToInclude	string[]	pacchetti da includere nell'operazione patch. Formato: packageName_packageVersion

PatchInstallationDetail

Patch installate durante l'operazione.

Nome	Tipo	Descrizione
classifications	string[]	Classificazioni della patch fornite dall'autore di patch.
installationState	PatchInstallationState	Stato della patch al termine dell'operazione di installazione.
kbId	string	KBID della patch. Si applica solo alle patch di Windows.
name	string	Nome descrittivo della patch.
patchId	string	Identificatore univoco per la patch.
version	string	Stringa di versione del pacchetto. Può essere conforme al controllo delle versioni semantiche. Si applica solo a Linux.

PatchInstallationState

Stato della patch al termine dell'operazione di installazione.

Nome	Tipo	Descrizione
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

Stato complessivo di esito positivo o negativo dell'operazione. Rimane "InProgress" fino al completamento dell'operazione. A quel punto diventerà "Failed", "Succeeded", "Unknown" o "CompletedWithWarnings".

Nome	Tipo	Descrizione
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

Input per InstallPatches come ricevuto direttamente dall'API

Nome	Tipo	Descrizione
linuxParameters	LinuxParameters	Input per InstallPatches in una macchina virtuale Linux, come ricevuto direttamente dall'API
maximumDuration	string	Specifica la quantità massima di tempo di esecuzione dell'operazione. Deve essere una stringa di durata conforme a ISO 8601, ad esempio PT4H (4 ore)
rebootSetting	VMGuestPatchRebootSetting	Definisce quando è accettabile riavviare una macchina virtuale durante un'operazione di aggiornamento software.
windowsParameters	WindowsParameters	Input per InstallPatches in una macchina virtuale Windows, come ricevuto direttamente dall'API

VirtualMachineInstallPatchesResult

Riepilogo dei risultati di un'operazione di installazione.

Nome	Tipo	Descrizione
error	ApiError	Errori rilevati durante l'esecuzione dell'operazione. La matrice dei dettagli contiene l'elenco di essi.
excludedPatchCount	integer	Numero di patch non installate a causa del blocco dell'installazione da parte dell'utente.
failedPatchCount	integer	Numero di patch che non è stato possibile installare a causa di un problema. Per informazioni dettagliate, vedere gli errori.
installationActivityId	string	ID attività dell'operazione che ha prodotto questo risultato. Viene usato per correlare i log di estensione e CRP.
installedPatchCount	integer	Numero di patch installate correttamente.
maintenanceWindowExceeded	boolean	Indica se l'operazione ha esaurito il tempo prima del completamento di tutte le azioni desiderate.
notSelectedPatchCount	integer	Numero di patch rilevate come disponibili per l'installazione, ma che non soddisfano i criteri dell'operazione.
patches	PatchInstallationDetail[]	Patch installate durante l'operazione.
pendingPatchCount	integer	Numero di patch identificate come che soddisfano i criteri di installazione, ma che non sono state installate. In genere ciò si verifica quando maintenanceWindowExceeded == true.
rebootStatus	VMGuestPatchRebootStatus	Stato di riavvio della macchina virtuale dopo il completamento dell'operazione.
startDateTime	string	Timestamp UTC all'avvio dell'operazione.
status	PatchOperationStatus	Stato complessivo di esito positivo o negativo dell'operazione. Rimane "InProgress" fino al completamento dell'operazione. A quel punto diventerà "Failed", "Succeeded", "Unknown" o "CompletedWithWarnings".

VMGuestPatchClassification_Linux

Classificazioni degli aggiornamenti da selezionare durante l'installazione delle patch per Linux.

Nome	Tipo	Descrizione
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

Classificazioni degli aggiornamenti da selezionare durante l'installazione delle patch per Windows.

Nome	Tipo	Descrizione
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

Definisce quando è accettabile riavviare una macchina virtuale durante un'operazione di aggiornamento software.

Nome	Tipo	Descrizione
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

Stato di riavvio della macchina virtuale dopo il completamento dell'operazione.

Nome	Tipo	Descrizione
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

Input per InstallPatches in una macchina virtuale Windows, come ricevuto direttamente dall'API

Nome	Tipo	Descrizione
classificationsToInclude	VMGuestPatchClassification_Windows[]	Classificazioni degli aggiornamenti da selezionare durante l'installazione delle patch per Windows.
excludeKbsRequiringReboot	boolean	Filtra i kb che non hanno un InstallationRebootBehavior di 'NeverReboots' quando questa opzione è impostata su true.
kbNumbersToExclude	string[]	Kbs da escludere nell'operazione patch
kbNumbersToInclude	string[]	Kbs da includere nell'operazione patch
maxPatchPublishDate	string	Viene usato per installare le patch pubblicate in o prima della data massima di pubblicazione specificata.