Virtual Machines - Install Patches

Hizmet:

Compute

API Sürümü:

2024-03-01

VM'ye düzeltme ekleri yükler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
vmName	path	True	string	Sanal makinenin adı.
api-version	query	True	string	İstemci Api Sürümü.

İstek Gövdesi

Name	Tür	Description
installPatchesInput	VirtualMachineInstallPatchesParameters	Api tarafından doğrudan alınan InstallPatches için giriş

Yanıtlar

Name	Tür	Description
200 OK	VirtualMachineInstallPatchesResult	Tamam
202 Accepted		Kabul edildi
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Install patch state of a virtual machine.

Örnek isteği

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/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

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.Resources;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

Örnek yanıt

Durum kodu:

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
}

Durum kodu:

202

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

Tanımlar

Name	Description
ApiError	Api hatası.
ApiErrorBase	Api hata tabanı.
CloudError	İşlem hizmetinden bir hata yanıtı.
InnerError	İç hata ayrıntıları.
LinuxParameters	Doğrudan API tarafından alındığı gibi Linux VM'sinde InstallPatches için giriş
PatchInstallationDetail	İşlem sırasında yüklenen düzeltme ekleri.
PatchInstallationState	Yükleme işlemi tamamlandıktan sonra düzeltme ekinin durumu.
PatchOperationStatus	İşlemin genel başarı veya başarısızlık durumu. İşlem tamamlanana kadar "InProgress" olarak kalır. Bu noktada "Failed", "Succeeded", "Unknown" veya "CompletedWithWarnings" olur.
VirtualMachineInstallPatchesParameters	Api tarafından doğrudan alınan InstallPatches için giriş
VirtualMachineInstallPatchesResult	Yükleme işleminin sonuç özeti.
VMGuestPatchClassification_Linux	Linux için düzeltme eklerini yüklerken seçecek güncelleştirme sınıflandırmaları.
VMGuestPatchClassification_Windows	Windows için düzeltme eklerini yüklerken seçecek güncelleştirme sınıflandırmaları.
VMGuestPatchRebootSetting	Bir yazılım güncelleştirme işlemi sırasında vm'yi yeniden başlatmanın ne zaman kabul edilebilir olduğunu tanımlar.
VMGuestPatchRebootStatus	İşlemin tamamlanmasının ardından VM'nin yeniden başlatma durumu.
WindowsParameters	Doğrudan API tarafından alınan bir Windows VM'sinde InstallPatches için giriş

ApiError

Api hatası.

Name	Tür	Description
code	string	Hata kodu.
details	ApiErrorBase[]	Api hata ayrıntıları
innererror	InnerError	Api iç hatası
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

ApiErrorBase

Api hata tabanı.

Name	Tür	Description
code	string	Hata kodu.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

CloudError

İşlem hizmetinden bir hata yanıtı.

Name	Tür	Description
error	ApiError	Api hatası.

InnerError

İç hata ayrıntıları.

Name	Tür	Description
errordetail	string	İç hata iletisi veya özel durum dökümü.
exceptiontype	string	Özel durum türü.

LinuxParameters

Doğrudan API tarafından alındığı gibi Linux VM'sinde InstallPatches için giriş

Name	Tür	Description
classificationsToInclude	VMGuestPatchClassification_Linux[]	Linux için düzeltme eklerini yüklerken seçecek güncelleştirme sınıflandırmaları.
maintenanceRunId	string	Bu, Linux'ta Otomatik VM Konuk Düzeltme Eki Uygulama için bakım çalıştırma tanımlayıcısı olarak kullanılır.
packageNameMasksToExclude	string[]	düzeltme eki işleminde hariç tutulacak paketler. Biçim: packageName_packageVersion
packageNameMasksToInclude	string[]	düzeltme eki işlemine dahil etmek için paketler. Biçim: packageName_packageVersion

PatchInstallationDetail

İşlem sırasında yüklenen düzeltme ekleri.

Name	Tür	Description
classifications	string[]	Düzeltme eki yayımcısı tarafından sağlanan düzeltme ekinin sınıflandırmaları.
installationState	PatchInstallationState	Yükleme işlemi tamamlandıktan sonra düzeltme ekinin durumu.
kbId	string	Düzeltme ekinin KBID değeri. Yalnızca Windows düzeltme ekleri için geçerlidir.
name	string	Düzeltme ekinin kolay adı.
patchId	string	Düzeltme eki için benzersiz bir tanımlayıcı.
version	string	Paketin sürüm dizesi. Anlamsal Sürüm Oluşturma ile uyumlu olabilir. Yalnızca Linux için geçerlidir.

PatchInstallationState

Yükleme işlemi tamamlandıktan sonra düzeltme ekinin durumu.

Name	Tür	Description
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

İşlemin genel başarı veya başarısızlık durumu. İşlem tamamlanana kadar "InProgress" olarak kalır. Bu noktada "Failed", "Succeeded", "Unknown" veya "CompletedWithWarnings" olur.

Name	Tür	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

Api tarafından doğrudan alınan InstallPatches için giriş

Name	Tür	Description
linuxParameters	LinuxParameters	Doğrudan API tarafından alındığı gibi Linux VM'sinde InstallPatches için giriş
maximumDuration	string	İşlemin çalıştırılacağı en uzun süreyi belirtir. PT4H (4 saat) gibi ISO 8601 uyumlu bir süre dizesi olmalıdır
rebootSetting	VMGuestPatchRebootSetting	Bir yazılım güncelleştirme işlemi sırasında vm'yi yeniden başlatmanın ne zaman kabul edilebilir olduğunu tanımlar.
windowsParameters	WindowsParameters	Doğrudan API tarafından alınan bir Windows VM'sinde InstallPatches için giriş

VirtualMachineInstallPatchesResult

Yükleme işleminin sonuç özeti.

Name	Tür	Description
error	ApiError	İşlemin yürütülmesi sırasında karşılaşılan hatalar. Details dizisi bunların listesini içerir.
excludedPatchCount	integer	Kullanıcının yüklemesini engellemesi nedeniyle yüklenmeyen düzeltme eklerinin sayısı.
failedPatchCount	integer	Bazı sorunlardan dolayı yüklenemeyen düzeltme eklerinin sayısı. Ayrıntılar için hatalara bakın.
installationActivityId	string	Bu sonucu oluşturan işlemin etkinlik kimliği. CRP ve uzantı günlükleri arasında bağıntı sağlamak için kullanılır.
installedPatchCount	integer	Başarıyla yüklenen düzeltme eklerinin sayısı.
maintenanceWindowExceeded	boolean	İşlemin hedeflenen tüm eylemlerini tamamlamadan önce zaman aşımına uğraması.
notSelectedPatchCount	integer	Yükleme için kullanılabilir olarak algılanan ancak işlemin ölçütlerini karşılamayan düzeltme eklerinin sayısı.
patches	PatchInstallationDetail[]	İşlem sırasında yüklenen düzeltme ekleri.
pendingPatchCount	integer	Yükleme ölçütlerine uyan ancak yüklenemediği belirlenen düzeltme eklerinin sayısı. Bu durum genellikle maintenanceWindowExceeded == true olduğunda gerçekleşir.
rebootStatus	VMGuestPatchRebootStatus	İşlemin tamamlanmasının ardından VM'nin yeniden başlatma durumu.
startDateTime	string	İşlemin başladığı UTC zaman damgası.
status	PatchOperationStatus	İşlemin genel başarı veya başarısızlık durumu. İşlem tamamlanana kadar "InProgress" olarak kalır. Bu noktada "Failed", "Succeeded", "Unknown" veya "CompletedWithWarnings" olur.

VMGuestPatchClassification_Linux

Linux için düzeltme eklerini yüklerken seçecek güncelleştirme sınıflandırmaları.

Name	Tür	Description
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

Windows için düzeltme eklerini yüklerken seçecek güncelleştirme sınıflandırmaları.

Name	Tür	Description
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

Bir yazılım güncelleştirme işlemi sırasında vm'yi yeniden başlatmanın ne zaman kabul edilebilir olduğunu tanımlar.

Name	Tür	Description
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

İşlemin tamamlanmasının ardından VM'nin yeniden başlatma durumu.

Name	Tür	Description
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

Doğrudan API tarafından alınan bir Windows VM'sinde InstallPatches için giriş

Name	Tür	Description
classificationsToInclude	VMGuestPatchClassification_Windows[]	Windows için düzeltme eklerini yüklerken seçecek güncelleştirme sınıflandırmaları.
excludeKbsRequiringReboot	boolean	Bu değer true olarak ayarlandığında 'NeverReboots' installationRebootBehavior'ı olmayan KB'leri filtreler.
kbNumbersToExclude	string[]	Düzeltme eki işleminde dışlanması gereken KBS
kbNumbersToInclude	string[]	Düzeltme eki işlemine eklenecek KBS
maxPatchPublishDate	string	Bu, belirtilen en yüksek yayımlama tarihinde veya öncesinde yayımlanan düzeltme eklerini yüklemek için kullanılır.