Virtual Machines - Install Patches

Ссылка

Service:: Compute

API Version:: 2024-03-01

Устанавливает исправления на виртуальной машине.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
vmName	path	True	string	Имя виртуальной машины.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
installPatchesInput	VirtualMachineInstallPatchesParameters	Входные данные для InstallPatches, полученные напрямую API

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineInstallPatchesResult	ОК
202 Accepted		Принято
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
CloudError	Ответ об ошибке от службы вычислений.
InnerError	Сведения о внутренней ошибке.
LinuxParameters	Входные данные для InstallPatches на виртуальной машине Linux, полученные напрямую API
PatchInstallationDetail	Исправления, установленные во время операции.
PatchInstallationState	Состояние исправления после завершения операции установки.
PatchOperationStatus	Общее состояние успешного или неудачного выполнения операции. Он остается "InProgress" до завершения операции. На этом этапе он станет "Failed", "Succeeded", "Unknown" или "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Входные данные для InstallPatches, полученные напрямую API
VirtualMachineInstallPatchesResult	Сводка результатов операции установки.
VMGuestPatchClassification_Linux	Классификации обновлений, выбираемые при установке исправлений для Linux.
VMGuestPatchClassification_Windows	Классификации обновлений, выбираемые при установке исправлений для Windows.
VMGuestPatchRebootSetting	Определяет допустимое время перезагрузки виртуальной машины во время операции обновления программного обеспечения.
VMGuestPatchRebootStatus	Состояние перезагрузки виртуальной машины после завершения операции.
WindowsParameters	Входные данные для InstallPatches на виртуальной машине Windows, полученные напрямую API

ApiError

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

CloudError

Ответ об ошибке от службы вычислений.

Имя	Тип	Описание
error	ApiError	Ошибка API.

InnerError

Сведения о внутренней ошибке.

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

LinuxParameters

Входные данные для InstallPatches на виртуальной машине Linux, полученные напрямую API

Имя	Тип	Описание
classificationsToInclude	VMGuestPatchClassification_Linux[]	Классификации обновлений, выбираемые при установке исправлений для Linux.
maintenanceRunId	string	Используется в качестве идентификатора запуска обслуживания для автоматического исправления гостевых виртуальных машин в Linux.
packageNameMasksToExclude	string[]	пакеты, исключаемые в операции исправления. Формат: packageName_packageVersion
packageNameMasksToInclude	string[]	пакеты для включения в операцию исправления. Формат: packageName_packageVersion

PatchInstallationDetail

Исправления, установленные во время операции.

Имя	Тип	Описание
classifications	string[]	Классификации исправления, предоставляемые издателем исправлений.
installationState	PatchInstallationState	Состояние исправления после завершения операции установки.
kbId	string	KBID исправления. Применяется только к исправлениям Windows.
name	string	Понятное имя исправления.
patchId	string	Уникальный идентификатор исправления.
version	string	Строка версии пакета. Он может соответствовать семантике управления версиями. Применяется только к Linux.

PatchInstallationState

Состояние исправления после завершения операции установки.

Имя	Тип	Описание
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

Общее состояние успешного или неудачного выполнения операции. Он остается "InProgress" до завершения операции. На этом этапе он станет "Failed", "Succeeded", "Unknown" или "CompletedWithWarnings".

Имя	Тип	Описание
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

Входные данные для InstallPatches, полученные напрямую API

Имя	Тип	Описание
linuxParameters	LinuxParameters	Входные данные для InstallPatches на виртуальной машине Linux, полученные напрямую API
maximumDuration	string	Указывает максимальное время выполнения операции. Это должна быть строка длительности, совместимая с ISO 8601, например PT4H (4 часа).
rebootSetting	VMGuestPatchRebootSetting	Определяет допустимое время перезагрузки виртуальной машины во время операции обновления программного обеспечения.
windowsParameters	WindowsParameters	Входные данные для InstallPatches на виртуальной машине Windows, полученные напрямую API

VirtualMachineInstallPatchesResult

Сводка результатов операции установки.

Имя	Тип	Описание
error	ApiError	Ошибки, возникшие во время выполнения операции. Массив сведений содержит их список.
excludedPatchCount	integer	Количество исправлений, которые не были установлены из-за того, что пользователь заблокировал их установку.
failedPatchCount	integer	Количество исправлений, которые не удалось установить из-за некоторых проблем. Дополнительные сведения см. в статье об ошибках.
installationActivityId	string	Идентификатор действия операции, которая привела к этому результату. Он используется для сопоставления журналов CRP и расширений.
installedPatchCount	integer	Количество успешно установленных исправлений.
maintenanceWindowExceeded	boolean	Истекло ли время операции до завершения всех предполагаемых действий.
notSelectedPatchCount	integer	Количество исправлений, которые были обнаружены как доступные для установки, но не соответствуют критериям операции.
patches	PatchInstallationDetail[]	Исправления, установленные во время операции.
pendingPatchCount	integer	Количество исправлений, которые были определены как соответствующие критериям установки, но не были установлены. Обычно это происходит, когда maintenanceWindowExceededed == true.
rebootStatus	VMGuestPatchRebootStatus	Состояние перезагрузки виртуальной машины после завершения операции.
startDateTime	string	Метка времени в формате UTC при начале операции.
status	PatchOperationStatus	Общее состояние успешного или неудачного выполнения операции. Он остается "InProgress" до завершения операции. На этом этапе он станет "Failed", "Succeeded", "Unknown" или "CompletedWithWarnings".

VMGuestPatchClassification_Linux

Классификации обновлений, выбираемые при установке исправлений для Linux.

Имя	Тип	Описание
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

Классификации обновлений, выбираемые при установке исправлений для Windows.

Имя	Тип	Описание
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

Определяет допустимое время перезагрузки виртуальной машины во время операции обновления программного обеспечения.

Имя	Тип	Описание
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

Состояние перезагрузки виртуальной машины после завершения операции.

Имя	Тип	Описание
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

Входные данные для InstallPatches на виртуальной машине Windows, полученные напрямую API

Имя	Тип	Описание
classificationsToInclude	VMGuestPatchClassification_Windows[]	Классификации обновлений, выбираемые при установке исправлений для Windows.
excludeKbsRequiringReboot	boolean	Отфильтровывает kbs, у которых нет параметра InstallationRebootBehavior "NeverReboots", если задано значение true.
kbNumbersToExclude	string[]	Kbs для исключения в операции исправления
kbNumbersToInclude	string[]	Кб для включения в операцию исправления
maxPatchPublishDate	string	Используется для установки исправлений, которые были опубликованы до указанной максимальной даты публикации.

Share via

Virtual Machines - Install Patches

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Scopes

Примеры

Install patch state of a virtual machine.

Sample Request

Sample Response

Определения

ApiError

ApiErrorBase

CloudError

InnerError

LinuxParameters

PatchInstallationDetail

PatchInstallationState

PatchOperationStatus

VirtualMachineInstallPatchesParameters

VirtualMachineInstallPatchesResult

VMGuestPatchClassification_Linux

VMGuestPatchClassification_Windows

VMGuestPatchRebootSetting

VMGuestPatchRebootStatus

WindowsParameters

Дополнительные ресурсы