Virtual Machines - Install Patches

Servicio:: Compute

Versión de la API:: 2026-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=2026-03-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
vmName	path	True	string	El nombre de la máquina virtual.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
rebootSetting	True	VMGuestPatchRebootSetting	Define cuándo es aceptable reiniciar una máquina virtual durante una operación de actualización de software.
linuxParameters		LinuxParameters	Entrada para InstallPatches en una máquina virtual Linux, como recibe directamente la API.
maximumDuration		string (duration)	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).
windowsParameters		WindowsParameters	Entrada para InstallPatches en una máquina virtual Windows, como recibe directamente la API.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualMachineInstallPatchesResult	La operación de Azure se completó correctamente.
202 Accepted		Operación de recursos aceptada. Encabezados Location: string Retry-After: integer
Other Status Codes	CloudError	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

VirtualMachineInstallPatchesResult

La operación de Azure se completó correctamente.

202 Accepted

Operación de recursos aceptada.

Encabezados

Location: string
Retry-After: integer

Other Status Codes

CloudError

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar su cuenta de usuario

Ejemplos

Install patch state of a virtual machine.

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

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

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",
                "patchNameMasksToExclude": ["*Windows*"],
                "patchNameMasksToInclude": ["*SQL*"],
            },
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-03-01/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

Respuesta de muestra

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=2025-04-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, como recibe directamente la API.
PatchInstallationDetail	Información sobre una revisión específica que se encontró durante una acción de instalación.
PatchInstallationState	Estado de la revisión una vez completada la operación de instalación.
PatchOperationStatus	El estado general de éxito o fracaso de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento, se convertirá en "Desconocido", "Error", "Correcto" o "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Entrada para InstallPatches como recibe directamente la API
VirtualMachineInstallPatchesResult	Resumen del resultado de una operación de instalación.
VMGuestPatchClassificationLinux
VMGuestPatchClassificationWindows
VMGuestPatchRebootSetting	Define cuándo es aceptable reiniciar una máquina virtual durante una operación de actualización de software.
VMGuestPatchRebootStatus	El 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, como recibe directamente la API.

ApiError

Objeto

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

Objeto

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

Objeto

Respuesta de error del servicio Compute.

Nombre	Tipo	Description
error	ApiError	Error de API.

InnerError

Objeto

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

Objeto

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

Nombre	Tipo	Description
classificationsToInclude	VMGuestPatchClassificationLinux[]	Clasificaciones de actualización que se van a seleccionar al instalar revisiones para Linux.
maintenanceRunId	string	Se utiliza como identificador de ejecución de mantenimiento para la aplicación automática de revisiones de invitado de VM en Linux.
packageNameMasksToExclude	string[]	paquetes que se van a excluir 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

Objeto

Información sobre una revisión específica que se encontró durante una acción de instalació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 para 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

Enumeración

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

Valor	Description
Unknown
Installed
Failed
Excluded
NotSelected
Pending

PatchOperationStatus

Enumeración

El estado general de éxito o fracaso de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento, se convertirá en "Desconocido", "Error", "Correcto" o "CompletedWithWarnings".

Valor	Description
Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

VirtualMachineInstallPatchesParameters

Objeto

Entrada para InstallPatches como recibe directamente la API

Nombre	Tipo	Description
linuxParameters	LinuxParameters	Entrada para InstallPatches en una máquina virtual Linux, como recibe directamente la API.
maximumDuration	string (duration)	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, como recibe directamente la API.

VirtualMachineInstallPatchesResult

Objeto

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

Nombre	Tipo	Description
error	ApiError	Los errores que se encontraron durante la ejecución de la operación. La matriz details contiene la lista de ellos.
excludedPatchCount	integer (int32)	El número de parches que no se instalaron debido a que el usuario bloqueó su instalación.
failedPatchCount	integer (int32)	El número de parches que no se pudieron instalar debido a algún problema. Consulte los errores para obtener más información.
installationActivityId	string	El identificador de actividad de la operación que produjo este resultado. Se usa para correlacionar los registros de CRP y de extensión.
installedPatchCount	integer (int32)	El número de parches instalados correctamente.
maintenanceWindowExceeded	boolean	Si la operación se quedó sin tiempo antes de completar todas las acciones previstas.
notSelectedPatchCount	integer (int32)	El número de parches que se detectaron como disponibles para la instalación, pero que no cumplían los criterios de la operación.
patches	PatchInstallationDetail[]	Las revisiones que se instalaron durante la operación.
pendingPatchCount	integer (int32)	El número de parches que se identificaron como que cumplían los criterios de instalación, pero que no se pudieron instalar. Normalmente, esto sucede cuando maintenanceWindowExceeded == true.
rebootStatus	VMGuestPatchRebootStatus	El estado de reinicio de la máquina virtual después de la finalización de la operación.
startDateTime	string (date-time)	La marca de tiempo UTC cuando comenzó la operación.
status	PatchOperationStatus	El estado general de éxito o fracaso de la operación. Permanece "InProgress" hasta que se completa la operación. En ese momento, se convertirá en "Error", "Correcto", "Desconocido" o "CompletedWithWarnings".

VMGuestPatchClassificationLinux

Enumeración

Valor	Description
Critical
Security
Other

VMGuestPatchClassificationWindows

Enumeración

Valor	Description
Critical
Security
UpdateRollUp
FeaturePack
ServicePack
Definition
Tools
Updates

VMGuestPatchRebootSetting

Enumeración

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

Valor	Description
IfRequired
Never
Always

VMGuestPatchRebootStatus

Enumeración

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

Valor	Description
Unknown
NotNeeded
Required
Started
Failed
Completed

WindowsParameters

Objeto

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

Nombre	Tipo	Description
classificationsToInclude	VMGuestPatchClassificationWindows[]	Clasificaciones de actualización que se van a seleccionar al instalar revisiones para Windows.
excludeKbsRequiringReboot	boolean	Filtra kbs que no tienen una 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 (date-time)	Se usa para instalar revisiones publicadas en la fecha máxima de publicación indicada o con anterioridad a esta.
patchNameMasksToExclude	string[]	Esto se utiliza para excluir parches que coincidan con las máscaras de nombre de parche dadas. Las cadenas alfanuméricas y las expresiones comodín que constan de * y ? solo se admiten como valores de entrada en la lista. No se admiten cadenas nulas, vacías y solo espacios en blanco como valores de entrada.
patchNameMasksToInclude	string[]	Esto se utiliza para incluir parches que coincidan con las máscaras de nombre de parche dadas. Las cadenas alfanuméricas y las expresiones comodín que constan de * y ? solo se admiten como valores de entrada en la lista. No se admiten cadenas nulas, vacías y solo espacios en blanco como valores de entrada.