Virtual Machines - Install Patches

Referencia

Service:: Compute

API Version:: 2024-03-01

Instala revisiones en la máquina virtual.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
vmName	path	True	string	El nombre de la máquina virtual.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
installPatchesInput	VirtualMachineInstallPatchesParameters	Entrada para InstallPatches como recibe directamente la API

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineInstallPatchesResult	Aceptar
202 Accepted		Aceptado
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Install patch state of a virtual machine.

Sample Request

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


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

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

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

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

Definiciones

Nombre	Description
ApiError	Error de API.
ApiErrorBase	Base de errores de API.
CloudError	Respuesta de error del servicio Compute.
InnerError	Detalles del error interno.
LinuxParameters	Entrada para InstallPatches en una máquina virtual Linux, tal y como recibe directamente la API.
PatchInstallationDetail	Revisiones que se instalaron durante la operación.
PatchInstallationState	Estado de la revisión una vez completada la operación de instalación.
PatchOperationStatus	Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Failed", "Succeeded", "Unknown" o "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Entrada para InstallPatches como recibe directamente la API
VirtualMachineInstallPatchesResult	Resumen del resultado de una operación de instalación.
VMGuestPatchClassification_Linux	Las clasificaciones de actualización que se van a seleccionar al instalar revisiones para Linux.
VMGuestPatchClassification_Windows	Las clasificaciones de actualización que se van a seleccionar al instalar revisiones para Windows.
VMGuestPatchRebootSetting	Define cuándo es aceptable reiniciar una máquina virtual durante una operación de actualización de software.
VMGuestPatchRebootStatus	Estado de reinicio de la máquina virtual después de la finalización de la operación.
WindowsParameters	Entrada para InstallPatches en una máquina virtual Windows, tal y como recibe directamente la API.

ApiError

Error de API.

Nombre	Tipo	Description
code	string	Código de error.
details	ApiErrorBase[]	Detalles del error de api
innererror	InnerError	Error interno de api
message	string	El mensaje de error.
target	string	Destino del error concreto.

ApiErrorBase

Base de errores de API.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.
target	string	Destino del error concreto.

CloudError

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

InnerError

Detalles del error interno.

Nombre	Tipo	Description
errordetail	string	Mensaje de error interno o volcado de memoria de excepciones.
exceptiontype	string	Tipo de la excepción.

LinuxParameters

Entrada para InstallPatches en una máquina virtual Linux, tal y como recibe directamente la API.

Nombre	Tipo	Description
classificationsToInclude	VMGuestPatchClassification_Linux[]	Las clasificaciones de actualización que se van a seleccionar al instalar revisiones para Linux.
maintenanceRunId	string	Se usa como identificador de ejecución de mantenimiento para la aplicación de revisiones de invitado de máquina virtual automática en Linux.
packageNameMasksToExclude	string[]	paquetes que se excluirán en la operación de revisión. Formato: packageName_packageVersion
packageNameMasksToInclude	string[]	paquetes que se van a incluir en la operación de revisión. Formato: packageName_packageVersion

PatchInstallationDetail

Revisiones que se instalaron durante la operación.

Nombre	Tipo	Description
classifications	string[]	Las clasificaciones de la revisión proporcionadas por el publicador de revisiones.
installationState	PatchInstallationState	Estado de la revisión una vez completada la operación de instalación.
kbId	string	KBID de la revisión. Solo se aplica a las revisiones de Windows.
name	string	Nombre descriptivo de la revisión.
patchId	string	Identificador único de la revisión.
version	string	Cadena de versión del paquete. Puede ajustarse al control de versiones semántico. Solo se aplica a Linux.

PatchInstallationState

Estado de la revisión una vez completada la operación de instalación.

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

PatchOperationStatus

Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Failed", "Succeeded", "Unknown" o "CompletedWithWarnings".

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

VirtualMachineInstallPatchesParameters

Entrada para InstallPatches como recibe directamente la API

Nombre	Tipo	Description
linuxParameters	LinuxParameters	Entrada para InstallPatches en una máquina virtual Linux, tal y como recibe directamente la API.
maximumDuration	string	Especifica la cantidad máxima de tiempo que se ejecutará la operación. Debe ser una cadena de duración compatible con ISO 8601, como PT4H (4 horas).
rebootSetting	VMGuestPatchRebootSetting	Define cuándo es aceptable reiniciar una máquina virtual durante una operación de actualización de software.
windowsParameters	WindowsParameters	Entrada para InstallPatches en una máquina virtual Windows, tal y como recibe directamente la API.

VirtualMachineInstallPatchesResult

Resumen del resultado de una operación de instalación.

Nombre	Tipo	Description
error	ApiError	Errores que se encontraron durante la ejecución de la operación. La matriz de detalles contiene la lista de ellos.
excludedPatchCount	integer	Número de revisiones que no se instalaron debido a que el usuario bloquea su instalación.
failedPatchCount	integer	Número de revisiones que no se pudieron instalar debido a algún problema. Consulte los errores para obtener más información.
installationActivityId	string	Identificador de actividad de la operación que generó este resultado. Se usa para correlacionar los registros de CRP y de extensión.
installedPatchCount	integer	Número de revisiones instaladas correctamente.
maintenanceWindowExceeded	boolean	Si la operación se agotó el tiempo antes de completar todas sus acciones previstas.
notSelectedPatchCount	integer	Número de revisiones que se detectaron como disponibles para la instalación, pero que no cumplen los criterios de la operación.
patches	PatchInstallationDetail[]	Revisiones que se instalaron durante la operación.
pendingPatchCount	integer	Número de revisiones identificadas como que cumplen los criterios de instalación, pero que no se pudieron instalar. Normalmente esto sucede cuando maintenanceWindowExceededed == true.
rebootStatus	VMGuestPatchRebootStatus	Estado de reinicio de la máquina virtual después de la finalización de la operación.
startDateTime	string	Marca de tiempo UTC cuando se inició la operación.
status	PatchOperationStatus	Estado general correcto o de error de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento se convertirá en "Failed", "Succeeded", "Unknown" o "CompletedWithWarnings".

VMGuestPatchClassification_Linux

Las clasificaciones de actualización que se van a seleccionar al instalar revisiones para Linux.

Nombre	Tipo	Description
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

Las clasificaciones de actualización que se van a seleccionar al instalar revisiones para Windows.

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

VMGuestPatchRebootSetting

Define cuándo es aceptable reiniciar una máquina virtual durante una operación de actualización de software.

Nombre	Tipo	Description
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

Estado de reinicio de la máquina virtual después de la finalización de la operación.

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

WindowsParameters

Entrada para InstallPatches en una máquina virtual Windows, tal y como recibe directamente la API.

Nombre	Tipo	Description
classificationsToInclude	VMGuestPatchClassification_Windows[]	Las clasificaciones de actualización que se van a seleccionar al instalar revisiones para Windows.
excludeKbsRequiringReboot	boolean	Filtra kbs que no tienen un installationRebootBehavior de "NeverReboots" cuando se establece en true.
kbNumbersToExclude	string[]	Kbs que se van a excluir en la operación de revisión
kbNumbersToInclude	string[]	Kbs que se van a incluir en la operación de revisión
maxPatchPublishDate	string	Se usa para instalar revisiones publicadas en o antes de esta fecha máxima de publicación determinada.

Share via

Virtual Machines - Install Patches

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Install patch state of a virtual machine.

Sample Request

Sample Response

Definiciones

ApiError

ApiErrorBase

CloudError

InnerError

LinuxParameters

PatchInstallationDetail

PatchInstallationState

PatchOperationStatus

VirtualMachineInstallPatchesParameters

VirtualMachineInstallPatchesResult

VMGuestPatchClassification_Linux

VMGuestPatchClassification_Windows

VMGuestPatchRebootSetting

VMGuestPatchRebootStatus

WindowsParameters

Recursos adicionales