Virtual Machines - Install Patches

Referensi

Service:: Compute

API Version:: 2024-03-01

Menginstal patch pada VM.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vmName	path	True	string	Nama mesin virtual.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
installPatchesInput	VirtualMachineInstallPatchesParameters	Input untuk InstallPatches seperti yang diterima langsung oleh API

Respons

Nama	Jenis	Deskripsi
200 OK	VirtualMachineInstallPatchesResult	OK
202 Accepted		Diterima
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
CloudError	Respons kesalahan dari layanan Komputasi.
InnerError	Detail kesalahan dalam.
LinuxParameters	Input untuk InstallPatches pada VM Linux, seperti yang diterima langsung oleh API
PatchInstallationDetail	Patch yang diinstal selama operasi.
PatchInstallationState	Status patch setelah operasi penginstalan selesai.
PatchOperationStatus	Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Gagal", "Berhasil", "Tidak Diketahui" atau "CompletedWithWarnings."
VirtualMachineInstallPatchesParameters	Input untuk InstallPatches seperti yang diterima langsung oleh API
VirtualMachineInstallPatchesResult	Ringkasan hasil operasi penginstalan.
VMGuestPatchClassification_Linux	Klasifikasi pembaruan yang akan dipilih saat menginstal patch untuk Linux.
VMGuestPatchClassification_Windows	Klasifikasi pembaruan yang akan dipilih saat menginstal patch untuk Windows.
VMGuestPatchRebootSetting	Menentukan kapan dapat diterima untuk me-reboot VM selama operasi pembaruan perangkat lunak.
VMGuestPatchRebootStatus	Status boot ulang VM setelah penyelesaian operasi.
WindowsParameters	Input untuk InstallPatches pada VM Windows, seperti yang diterima langsung oleh API

ApiError

Kesalahan api.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	ApiErrorBase[]	Detail kesalahan Api
innererror	InnerError	Kesalahan dalam Api
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

ApiErrorBase

Basis kesalahan api.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

CloudError

Respons kesalahan dari layanan Komputasi.

Nama	Jenis	Deskripsi
error	ApiError	Kesalahan api.

InnerError

Detail kesalahan dalam.

Nama	Jenis	Deskripsi
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

LinuxParameters

Input untuk InstallPatches pada VM Linux, seperti yang diterima langsung oleh API

Nama	Jenis	Deskripsi
classificationsToInclude	VMGuestPatchClassification_Linux[]	Klasifikasi pembaruan yang akan dipilih saat menginstal patch untuk Linux.
maintenanceRunId	string	Ini digunakan sebagai pengidentifikasi eksekusi pemeliharaan untuk Patching Tamu VM Otomatis di Linux.
packageNameMasksToExclude	string[]	paket yang akan dikecualikan dalam operasi patch. Format: packageName_packageVersion
packageNameMasksToInclude	string[]	paket untuk disertakan dalam operasi patch. Format: packageName_packageVersion

PatchInstallationDetail

Patch yang diinstal selama operasi.

Nama	Jenis	Deskripsi
classifications	string[]	Klasifikasi patch sebagaimana disediakan oleh penerbit patch.
installationState	PatchInstallationState	Status patch setelah operasi penginstalan selesai.
kbId	string	KBID patch. Hanya berlaku untuk patch Windows.
name	string	Nama patch yang ramah.
patchId	string	Pengidentifikasi unik untuk patch.
version	string	String versi paket. Ini mungkin sesuai dengan Penerapan Versi Semantik. Hanya berlaku untuk Linux.

PatchInstallationState

Status patch setelah operasi penginstalan selesai.

Nama	Jenis	Deskripsi
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Gagal", "Berhasil", "Tidak Diketahui" atau "CompletedWithWarnings."

Nama	Jenis	Deskripsi
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

Input untuk InstallPatches seperti yang diterima langsung oleh API

Nama	Jenis	Deskripsi
linuxParameters	LinuxParameters	Input untuk InstallPatches pada VM Linux, seperti yang diterima langsung oleh API
maximumDuration	string	Menentukan jumlah waktu maksimum operasi akan berjalan. Ini harus berupa string durasi yang mematuhi ISO 8601 seperti PT4H (4 jam)
rebootSetting	VMGuestPatchRebootSetting	Menentukan kapan dapat diterima untuk me-reboot VM selama operasi pembaruan perangkat lunak.
windowsParameters	WindowsParameters	Input untuk InstallPatches pada VM Windows, seperti yang diterima langsung oleh API

VirtualMachineInstallPatchesResult

Ringkasan hasil operasi penginstalan.

Nama	Jenis	Deskripsi
error	ApiError	Kesalahan yang ditemui selama eksekusi operasi. Array detail berisi daftarnya.
excludedPatchCount	integer	Jumlah patch yang tidak diinstal karena pengguna memblokir penginstalan mereka.
failedPatchCount	integer	Jumlah patch yang tidak dapat diinstal karena beberapa masalah. Lihat kesalahan untuk detailnya.
installationActivityId	string	ID aktivitas operasi yang menghasilkan hasil ini. Ini digunakan untuk berkorelasi di seluruh log CRP dan ekstensi.
installedPatchCount	integer	Jumlah patch berhasil diinstal.
maintenanceWindowExceeded	boolean	Apakah operasi kehabisan waktu sebelum menyelesaikan semua tindakan yang dimaksudkan.
notSelectedPatchCount	integer	Jumlah patch yang terdeteksi tersedia untuk diinstal, tetapi tidak memenuhi kriteria operasi.
patches	PatchInstallationDetail[]	Patch yang diinstal selama operasi.
pendingPatchCount	integer	Jumlah patch yang diidentifikasi sebagai memenuhi kriteria penginstalan, tetapi tidak dapat diinstal. Biasanya ini terjadi ketika maintenanceWindowExceeded == true.
rebootStatus	VMGuestPatchRebootStatus	Status boot ulang VM setelah penyelesaian operasi.
startDateTime	string	Tanda waktu UTC ketika operasi dimulai.
status	PatchOperationStatus	Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Gagal", "Berhasil", "Tidak Diketahui" atau "CompletedWithWarnings."

VMGuestPatchClassification_Linux

Klasifikasi pembaruan yang akan dipilih saat menginstal patch untuk Linux.

Nama	Jenis	Deskripsi
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

Klasifikasi pembaruan yang akan dipilih saat menginstal patch untuk Windows.

Nama	Jenis	Deskripsi
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

Menentukan kapan dapat diterima untuk me-reboot VM selama operasi pembaruan perangkat lunak.

Nama	Jenis	Deskripsi
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

Status boot ulang VM setelah penyelesaian operasi.

Nama	Jenis	Deskripsi
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

Input untuk InstallPatches pada VM Windows, seperti yang diterima langsung oleh API

Nama	Jenis	Deskripsi
classificationsToInclude	VMGuestPatchClassification_Windows[]	Klasifikasi pembaruan yang akan dipilih saat menginstal patch untuk Windows.
excludeKbsRequiringReboot	boolean	Memfilter Kbs yang tidak memiliki InstallationRebootBehavior dari 'NeverReboots' ketika ini diatur ke true.
kbNumbersToExclude	string[]	Kbs untuk dikecualikan dalam operasi patch
kbNumbersToInclude	string[]	Kbs untuk disertakan dalam operasi patch
maxPatchPublishDate	string	Ini digunakan untuk menginstal patch yang diterbitkan pada atau sebelum tanggal publikasi maks yang diberikan ini.

Virtual Machines - Install Patches

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

Install patch state of a virtual machine.

Sample Request

Sample Response

Definisi

ApiError

ApiErrorBase

CloudError

InnerError

LinuxParameters

PatchInstallationDetail

PatchInstallationState

PatchOperationStatus

VirtualMachineInstallPatchesParameters

VirtualMachineInstallPatchesResult

VMGuestPatchClassification_Linux

VMGuestPatchClassification_Windows

VMGuestPatchRebootSetting

VMGuestPatchRebootStatus

WindowsParameters

Sumber Daya Tambahan: