Virtual Machines - Install Patches

서비스:

Compute

API 버전:

2024-07-01

VM에 패치를 설치합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
vmName	path	True	string	가상 머신의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	형식	Description
installPatchesInput	VirtualMachineInstallPatchesParameters	API에서 직접 수신한 InstallPatches에 대한 입력

응답

Name	형식	Description
200 OK	VirtualMachineInstallPatchesResult	그래
202 Accepted		허용
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Install patch state of a virtual machine.

샘플 요청

HTTP

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

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

Python

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

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

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

dotnet

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

샘플 응답

상태 코드:

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
}

상태 코드:

202

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

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
CloudError	Compute 서비스의 오류 응답입니다.
InnerError	내부 오류 세부 정보입니다.
LinuxParameters	API에서 직접 수신한 Linux VM의 InstallPatches 입력
PatchInstallationDetail	작업 중에 설치된 패치입니다.
PatchInstallationState	설치 작업이 완료된 후의 패치 상태입니다.
PatchOperationStatus	작업의 전체 성공 또는 실패 상태입니다. 작업이 완료될 때까지 "InProgress"로 유지됩니다. 이 시점에서 "실패", "성공", "알 수 없음" 또는 "CompletedWithWarnings"가 됩니다.
VirtualMachineInstallPatchesParameters	API에서 직접 수신한 InstallPatches에 대한 입력
VirtualMachineInstallPatchesResult	설치 작업의 결과 요약입니다.
VMGuestPatchClassification_Linux	Linux용 패치를 설치할 때 선택할 업데이트 분류입니다.
VMGuestPatchClassification_Windows	Windows용 패치를 설치할 때 선택할 업데이트 분류입니다.
VMGuestPatchRebootSetting	소프트웨어 업데이트 작업 중에 VM을 다시 부팅할 수 있는 시기를 정의합니다.
VMGuestPatchRebootStatus	작업이 완료된 후 VM의 다시 부팅 상태입니다.
WindowsParameters	API에서 직접 수신한 Windows VM의 InstallPatches 입력

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

CloudError

Compute 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류입니다.

InnerError

내부 오류 세부 정보입니다.

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

LinuxParameters

API에서 직접 수신한 Linux VM의 InstallPatches 입력

Name	형식	Description
classificationsToInclude	VMGuestPatchClassification_Linux[]	Linux용 패치를 설치할 때 선택할 업데이트 분류입니다.
maintenanceRunId	string	이는 Linux에서 자동 VM 게스트 패치에 대한 유지 관리 실행 식별자로 사용됩니다.
packageNameMasksToExclude	string[]	패치 작업에서 제외할 패키지입니다. 형식: packageName_packageVersion
packageNameMasksToInclude	string[]	패치 작업에 포함할 패키지입니다. 형식: packageName_packageVersion

PatchInstallationDetail

작업 중에 설치된 패치입니다.

Name	형식	Description
classifications	string[]	패치 게시자가 제공한 패치의 분류입니다.
installationState	PatchInstallationState	설치 작업이 완료된 후의 패치 상태입니다.
kbId	string	패치의 KBID입니다. Windows 패치에만 적용됩니다.
name	string	패치의 이름입니다.
patchId	string	패치의 고유 식별자입니다.
version	string	패키지의 버전 문자열입니다. 의미 체계 버전 지정을 준수할 수 있습니다. Linux에만 적용됩니다.

PatchInstallationState

설치 작업이 완료된 후의 패치 상태입니다.

Name	형식	Description
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

작업의 전체 성공 또는 실패 상태입니다. 작업이 완료될 때까지 "InProgress"로 유지됩니다. 이 시점에서 "실패", "성공", "알 수 없음" 또는 "CompletedWithWarnings"가 됩니다.

Name	형식	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

API에서 직접 수신한 InstallPatches에 대한 입력

Name	형식	Description
linuxParameters	LinuxParameters	API에서 직접 수신한 Linux VM의 InstallPatches 입력
maximumDuration	string	작업이 실행되는 최대 시간을 지정합니다. PT4H(4시간)와 같은 ISO 8601 규격 기간 문자열이어야 합니다.
rebootSetting	VMGuestPatchRebootSetting	소프트웨어 업데이트 작업 중에 VM을 다시 부팅할 수 있는 시기를 정의합니다.
windowsParameters	WindowsParameters	API에서 직접 수신한 Windows VM의 InstallPatches 입력

VirtualMachineInstallPatchesResult

설치 작업의 결과 요약입니다.

Name	형식	Description
error	ApiError	작업을 실행하는 동안 발생한 오류입니다. 세부 정보 배열에는 해당 목록이 포함됩니다.
excludedPatchCount	integer	사용자가 설치를 차단하여 설치되지 않은 패치의 수입니다.
failedPatchCount	integer	일부 문제로 인해 설치할 수 없는 패치의 수입니다. 자세한 내용은 오류를 참조하세요.
installationActivityId	string	이 결과를 생성한 작업의 활동 ID입니다. CRP 및 확장 로그 간에 상관 관계를 지정하는 데 사용됩니다.
installedPatchCount	integer	성공적으로 설치된 패치 수입니다.
maintenanceWindowExceeded	boolean	작업이 의도한 모든 작업을 완료하기 전에 시간이 부족했는지 여부입니다.
notSelectedPatchCount	integer	설치에 사용할 수 있는 것으로 검색되었지만 작업의 기준을 충족하지 못한 패치의 수입니다.
patches	PatchInstallationDetail[]	작업 중에 설치된 패치입니다.
pendingPatchCount	integer	설치 조건을 충족하는 것으로 식별되었지만 설치할 수 없는 패치의 수입니다. 일반적으로 이 문제는 maintenanceWindowExceeded == true일 때 발생합니다.
rebootStatus	VMGuestPatchRebootStatus	작업이 완료된 후 VM의 다시 부팅 상태입니다.
startDateTime	string	작업이 시작된 UTC 타임스탬프입니다.
status	PatchOperationStatus	작업의 전체 성공 또는 실패 상태입니다. 작업이 완료될 때까지 "InProgress"로 유지됩니다. 이 시점에서 "실패", "성공", "알 수 없음" 또는 "CompletedWithWarnings"가 됩니다.

VMGuestPatchClassification_Linux

Linux용 패치를 설치할 때 선택할 업데이트 분류입니다.

Name	형식	Description
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

Windows용 패치를 설치할 때 선택할 업데이트 분류입니다.

Name	형식	Description
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

소프트웨어 업데이트 작업 중에 VM을 다시 부팅할 수 있는 시기를 정의합니다.

Name	형식	Description
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

작업이 완료된 후 VM의 다시 부팅 상태입니다.

Name	형식	Description
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

API에서 직접 수신한 Windows VM의 InstallPatches 입력

Name	형식	Description
classificationsToInclude	VMGuestPatchClassification_Windows[]	Windows용 패치를 설치할 때 선택할 업데이트 분류입니다.
excludeKbsRequiringReboot	boolean	True로 설정된 경우 'NeverReboots'의 InstallationRebootBehavior가 없는 Kbs를 필터링합니다.
kbNumbersToExclude	string[]	패치 작업에서 제외할 KB
kbNumbersToInclude	string[]	패치 작업에 포함할 KB
maxPatchPublishDate	string	지정된 최대 게시 날짜 또는 그 이전에 게시된 패치를 설치하는 데 사용됩니다.