Virtual Machines - Install Patches

Referência

Serviço:: Compute

Versão da API:: 2024-07-01

Instala patches na VM.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
vmName	path	True	string	O nome da máquina virtual.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Tipo	Description
installPatchesInput	VirtualMachineInstallPatchesParameters	Entrada para InstallPatches recebida diretamente pela API

Respostas

Name	Tipo	Description
200 OK	VirtualMachineInstallPatchesResult	OK
202 Accepted		Aceito
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Install patch state of a virtual machine.

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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
}

Código de estado:: 202

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

Definições

Name	Description
ApiError	Erro de api.
ApiErrorBase	Base de erro da api.
CloudError	Uma resposta de erro do serviço de computação.
InnerError	Detalhes do erro interno.
LinuxParameters	Entrada para InstallPatches em uma VM Linux, conforme recebido diretamente pela API
PatchInstallationDetail	Os patches que foram instalados durante a operação.
PatchInstallationState	O estado do patch após a conclusão da operação de instalação.
PatchOperationStatus	O status geral de sucesso ou falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Failed", "Succeeded", "Unknown" ou "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Entrada para InstallPatches recebida diretamente pela API
VirtualMachineInstallPatchesResult	O resumo do resultado de uma operação de instalação.
VMGuestPatchClassification_Linux	As classificações de atualização a serem selecionadas ao instalar patches para Linux.
VMGuestPatchClassification_Windows	As classificações de atualização a serem selecionadas ao instalar patches para Windows.
VMGuestPatchRebootSetting	Define quando é aceitável reinicializar uma VM durante uma operação de atualização de software.
VMGuestPatchRebootStatus	O estado de reinicialização da VM após a conclusão da operação.
WindowsParameters	Entrada para InstallPatches em uma VM do Windows, conforme recebido diretamente pela API

ApiError

Erro de api.

Name	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro Api
innererror	InnerError	O erro interno da Api
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

CloudError

Uma resposta de erro do serviço de computação.

Name	Tipo	Description
error	ApiError	Erro de api.

InnerError

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou despejo de exceção.
exceptiontype	string	O tipo de exceção.

LinuxParameters

Entrada para InstallPatches em uma VM Linux, conforme recebido diretamente pela API

Name	Tipo	Description
classificationsToInclude	VMGuestPatchClassification_Linux[]	As classificações de atualização a serem selecionadas ao instalar patches para Linux.
maintenanceRunId	string	Isso é usado como um identificador de execução de manutenção para Auto VM Guest Patching no Linux.
packageNameMasksToExclude	string[]	pacotes a excluir na operação de patch. Formato: packageName_packageVersion
packageNameMasksToInclude	string[]	pacotes para incluir na operação de patch. Formato: packageName_packageVersion

PatchInstallationDetail

Os patches que foram instalados durante a operação.

Name	Tipo	Description
classifications	string[]	A(s) classificação(ões) do patch, conforme fornecido pelo editor do patch.
installationState	PatchInstallationState	O estado do patch após a conclusão da operação de instalação.
kbId	string	O KBID do patch. Aplica-se apenas a patches do Windows.
name	string	O nome amigável do patch.
patchId	string	Um identificador exclusivo para o patch.
version	string	A cadeia de caracteres de versão do pacote. Pode estar em conformidade com o Versionamento Semântico. Aplica-se apenas ao Linux.

PatchInstallationState

O estado do patch após a conclusão da operação de instalação.

Name	Tipo	Description
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

O status geral de sucesso ou falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Failed", "Succeeded", "Unknown" ou "CompletedWithWarnings".

Name	Tipo	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

Entrada para InstallPatches recebida diretamente pela API

Name	Tipo	Description
linuxParameters	LinuxParameters	Entrada para InstallPatches em uma VM Linux, conforme recebido diretamente pela API
maximumDuration	string	Especifica a quantidade máxima de tempo que a operação será executada. Deve ser uma cadeia de duração compatível com a ISO 8601, como PT4H (4 horas)
rebootSetting	VMGuestPatchRebootSetting	Define quando é aceitável reinicializar uma VM durante uma operação de atualização de software.
windowsParameters	WindowsParameters	Entrada para InstallPatches em uma VM do Windows, conforme recebido diretamente pela API

VirtualMachineInstallPatchesResult

O resumo do resultado de uma operação de instalação.

Name	Tipo	Description
error	ApiError	Os erros que foram encontrados durante a execução da operação. A matriz de detalhes contém a lista deles.
excludedPatchCount	integer	O número de patches que não foram instalados devido ao utilizador bloquear a sua instalação.
failedPatchCount	integer	O número de patches que não puderam ser instalados devido a algum problema. Consulte os erros para obter detalhes.
installationActivityId	string	O ID da atividade da operação que produziu esse resultado. Ele é usado para correlacionar entre CRP e logs de extensão.
installedPatchCount	integer	O número de patches instalados com êxito.
maintenanceWindowExceeded	boolean	Se a operação esgotou o tempo antes de concluir todas as ações pretendidas.
notSelectedPatchCount	integer	O número de patches que foram detetados como disponíveis para instalação, mas não atenderam aos critérios da operação.
patches	PatchInstallationDetail[]	Os patches que foram instalados durante a operação.
pendingPatchCount	integer	O número de patches que foram identificados como atendendo aos critérios de instalação, mas não puderam ser instalados. Normalmente, isso acontece quando maintenanceWindowExceeded == true.
rebootStatus	VMGuestPatchRebootStatus	O estado de reinicialização da VM após a conclusão da operação.
startDateTime	string	O carimbo de data/hora UTC quando a operação começou.
status	PatchOperationStatus	O status geral de sucesso ou falha da operação. Ele permanece "InProgress" até que a operação seja concluída. Nesse ponto, ele se tornará "Failed", "Succeeded", "Unknown" ou "CompletedWithWarnings".

VMGuestPatchClassification_Linux

As classificações de atualização a serem selecionadas ao instalar patches para Linux.

Name	Tipo	Description
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

As classificações de atualização a serem selecionadas ao instalar patches para Windows.

Name	Tipo	Description
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

Define quando é aceitável reinicializar uma VM durante uma operação de atualização de software.

Name	Tipo	Description
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

O estado de reinicialização da VM após a conclusão da operação.

Name	Tipo	Description
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

Entrada para InstallPatches em uma VM do Windows, conforme recebido diretamente pela API

Name	Tipo	Description
classificationsToInclude	VMGuestPatchClassification_Windows[]	As classificações de atualização a serem selecionadas ao instalar patches para Windows.
excludeKbsRequiringReboot	boolean	Filtra Kbs que não têm um InstallationRebootBehavior de 'NeverReboots' quando isso é definido como true.
kbNumbersToExclude	string[]	Kbs a excluir na operação de patch
kbNumbersToInclude	string[]	Kbs a incluir na operação de patch
maxPatchPublishDate	string	Isso é usado para instalar patches que foram publicados em ou antes dessa data máxima de publicação.