Virtual Machines - Install Patches

Service:

Compute

API Version:

2024-03-01

Instala patches na VM.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches?api-version=2024-03-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 subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para 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, conforme recebido diretamente pela API

Respostas

Name	Tipo	Description
200 OK	VirtualMachineInstallPatchesResult	OK
202 Accepted		Aceite
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Install patch state of a virtual machine.

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/installPatches?api-version=2024-03-01

{
  "maximumDuration": "PT4H",
  "rebootSetting": "IfRequired",
  "windowsParameters": {
    "classificationsToInclude": [
      "Critical",
      "Security"
    ],
    "maxPatchPublishDate": "2020-11-19T02:36:43.0539904+00:00"
  }
}

Java

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-03-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

Python

from typing import Any, IO, Union

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-03-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

Go

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

JavaScript

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-03-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

Sample Response

Status code:

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
}

Status code:

202

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

Definições

Name	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros da API.
CloudError	Uma resposta de erro do serviço de Computação.
InnerError	Detalhes do erro interno.
LinuxParameters	Entrada para InstallPatches numa VM do 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 estado geral de êxito ou falha da operação. Permanece "InProgress" até que a operação seja concluída. Nessa altura, tornar-se-á "Com Falhas", "Com Êxito", "Desconhecido" ou "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Entrada para InstallPatches, conforme recebido diretamente pela API
VirtualMachineInstallPatchesResult	O resumo do resultado de uma operação de instalação.
VMGuestPatchClassification_Linux	As classificações de atualização a selecionar ao instalar patches para Linux.
VMGuestPatchClassification_Windows	As classificações de atualização a selecionar ao instalar patches para o Windows.
VMGuestPatchRebootSetting	Define quando é aceitável reiniciar uma VM durante uma operação de atualização de software.
VMGuestPatchRebootStatus	O estado de reinício da VM após a conclusão da operação.
WindowsParameters	Entrada para InstallPatches numa 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 da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Base de erros da API.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino 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 a informação de falha de sistema da exceção.
exceptiontype	string	O tipo de exceção.

LinuxParameters

Entrada para InstallPatches numa VM do Linux, conforme recebido diretamente pela API

Name	Tipo	Description
classificationsToInclude	VMGuestPatchClassification_Linux[]	As classificações de atualização a selecionar ao instalar patches para Linux.
maintenanceRunId	string	Isto é utilizado como um identificador de execução de manutenção para a Aplicação de Patches de Convidado de VM Automática no Linux.
packageNameMasksToExclude	string[]	pacotes a excluir na operação de patch. Formato: packageName_packageVersion
packageNameMasksToInclude	string[]	pacotes a incluir na operação de patch. Formato: packageName_packageVersion

PatchInstallationDetail

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

Name	Tipo	Description
classifications	string[]	As classificações do patch, conforme fornecido pelo fabricante 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 versão do pacote. Pode estar em conformidade com o Controlo de Versões 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 estado geral de êxito ou falha da operação. Permanece "InProgress" até que a operação seja concluída. Nessa altura, tornar-se-á "Com Falhas", "Com Êxito", "Desconhecido" ou "CompletedWithWarnings".

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

VirtualMachineInstallPatchesParameters

Entrada para InstallPatches, conforme recebido diretamente pela API

Name	Tipo	Description
linuxParameters	LinuxParameters	Entrada para InstallPatches numa VM do Linux, conforme recebido diretamente pela API
maximumDuration	string	Especifica a quantidade máxima de tempo que a operação irá executar. Tem de ser uma cadeia de duração compatível com ISO 8601, como PT4H (4 horas)
rebootSetting	VMGuestPatchRebootSetting	Define quando é aceitável reiniciar uma VM durante uma operação de atualização de software.
windowsParameters	WindowsParameters	Entrada para InstallPatches numa 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 encontrados durante a execução da operação. A matriz de detalhes contém a lista dos mesmos.
excludedPatchCount	integer	O número de patches que não foram instalados devido ao utilizador estar a bloquear a instalação.
failedPatchCount	integer	O número de patches que não foi possível instalar devido a algum problema. Veja erros para obter detalhes.
installationActivityId	string	O ID de atividade da operação que produziu este resultado. É utilizado para correlacionar entre registos de CRP e extensões.
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 cumpriram os 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 cumprindo os critérios de instalação, mas não foram capazes de ser instalados. Normalmente, isto acontece quando maintenanceWindowExceeded == true.
rebootStatus	VMGuestPatchRebootStatus	O estado de reinício 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 estado geral de êxito ou falha da operação. Permanece "InProgress" até que a operação seja concluída. Nessa altura, tornar-se-á "Com Falhas", "Com Êxito", "Desconhecido" ou "CompletedWithWarnings".

VMGuestPatchClassification_Linux

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

Name	Tipo	Description
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

As classificações de atualização a selecionar ao instalar patches para o 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 reiniciar uma VM durante uma operação de atualização de software.

Name	Tipo	Description
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

O estado de reinício 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 numa VM do Windows, conforme recebido diretamente pela API

Name	Tipo	Description
classificationsToInclude	VMGuestPatchClassification_Windows[]	As classificações de atualização a selecionar ao instalar patches para o Windows.
excludeKbsRequiringReboot	boolean	Filtra Kbs que não têm um InstallationRebootBehavior de "NeverReboots" quando está definido como verdadeiro.
kbNumbersToExclude	string[]	Kbs a excluir na operação de patch
kbNumbersToInclude	string[]	Kbs a incluir na operação de patch
maxPatchPublishDate	string	Isto é utilizado para instalar patches que foram publicados em ou antes desta data máxima publicada.