Virtual Machines - Install Patches

Service:

Compute

API Version:

2024-03-01

Telepít javításokat a virtuális gépre.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
vmName	path	True	string	A virtuális gép neve.
api-version	query	True	string	Client API-verzió.

Kérelem törzse

Name	Típus	Description
installPatchesInput	VirtualMachineInstallPatchesParameters	Az InstallPatches bemenete az API által közvetlenül fogadott módon

Válaszok

Name	Típus	Description
200 OK	VirtualMachineInstallPatchesResult	OK
202 Accepted		Elfogadva
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Install patch state of a virtual machine.

Sample Request

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

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

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

Definíciók

Name	Description
ApiError	API-hiba.
ApiErrorBase	API-hibabázis.
CloudError	Hibaválasz a Compute szolgáltatástól.
InnerError	Belső hiba részletei.
LinuxParameters	Az InstallPatches bemenete Linux rendszerű virtuális gépen, az API által közvetlenül fogadott módon
PatchInstallationDetail	A művelet során telepített javítások.
PatchInstallationState	A javítás állapota a telepítési művelet befejezése után.
PatchOperationStatus	A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig "InProgress" marad. Ekkor a következő lesz: "Failed", "Succeeded", "Unknown" vagy "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Az InstallPatches bemenete az API által közvetlenül fogadott módon
VirtualMachineInstallPatchesResult	A telepítési művelet eredményösszegzése.
VMGuestPatchClassification_Linux	A linuxos javítások telepítésekor kiválasztandó frissítési besorolások.
VMGuestPatchClassification_Windows	A windowsos javítások telepítésekor kiválasztandó frissítési besorolások.
VMGuestPatchRebootSetting	Meghatározza, hogy mikor lehet elfogadható újraindítani egy virtuális gépet egy szoftverfrissítési művelet során.
VMGuestPatchRebootStatus	A virtuális gép újraindítási állapota a művelet befejezése után.
WindowsParameters	Az InstallPatches bemenete Windows rendszerű virtuális gépen, az API által közvetlenül fogadott módon

ApiError

API-hiba.

Name	Típus	Description
code	string	A hibakód.
details	ApiErrorBase[]	Az API-hiba részletei
innererror	InnerError	Az API belső hibája
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

ApiErrorBase

API-hibabázis.

Name	Típus	Description
code	string	A hibakód.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

CloudError

Hibaválasz a Compute szolgáltatástól.

Name	Típus	Description
error	ApiError	API-hiba.

InnerError

Belső hiba részletei.

Name	Típus	Description
errordetail	string	A belső hibaüzenet vagy kivételkép.
exceptiontype	string	A kivétel típusa.

LinuxParameters

Az InstallPatches bemenete Linux rendszerű virtuális gépen, az API által közvetlenül fogadott módon

Name	Típus	Description
classificationsToInclude	VMGuestPatchClassification_Linux[]	A linuxos javítások telepítésekor kiválasztandó frissítési besorolások.
maintenanceRunId	string	Ez a linuxos automatikus virtuálisgép-vendégjavítás karbantartási futtatási azonosítójaként használatos.
packageNameMasksToExclude	string[]	a javításműveletből kizárandó csomagok. Formátum: packageName_packageVersion
packageNameMasksToInclude	string[]	a javítási műveletbe belefoglalandó csomagok. Formátum: packageName_packageVersion

PatchInstallationDetail

A művelet során telepített javítások.

Name	Típus	Description
classifications	string[]	A javítás közzétevője által megadott besorolás(ok).
installationState	PatchInstallationState	A javítás állapota a telepítési művelet befejezése után.
kbId	string	A javítás KBID azonosítója. Csak a Windows-javításokra vonatkozik.
name	string	A javítás felhasználóbarát neve.
patchId	string	A javítás egyedi azonosítója.
version	string	A csomag verziósztringje. Ez megfelelhet a szemantikai verziószámozásnak. Csak a Linuxra vonatkozik.

PatchInstallationState

A javítás állapota a telepítési művelet befejezése után.

Name	Típus	Description
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig "InProgress" marad. Ekkor a következő lesz: "Failed", "Succeeded", "Unknown" vagy "CompletedWithWarnings".

Name	Típus	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

Az InstallPatches bemenete az API által közvetlenül fogadott módon

Name	Típus	Description
linuxParameters	LinuxParameters	Az InstallPatches bemenete Linux rendszerű virtuális gépen, az API által közvetlenül fogadott módon
maximumDuration	string	A művelet futtatásának maximális időtartamát adja meg. Iso 8601 szabványnak megfelelő időtartam-sztringnek kell lennie, például PT4H (4 óra)
rebootSetting	VMGuestPatchRebootSetting	Meghatározza, hogy mikor lehet elfogadható újraindítani egy virtuális gépet egy szoftverfrissítési művelet során.
windowsParameters	WindowsParameters	Az InstallPatches bemenete Windows rendszerű virtuális gépen, az API által közvetlenül fogadott módon

VirtualMachineInstallPatchesResult

A telepítési művelet eredményösszegzése.

Name	Típus	Description
error	ApiError	A művelet végrehajtása során észlelt hibák. A részletek tömb tartalmazza a lista őket.
excludedPatchCount	integer	Azon javítások száma, amelyek azért nem lettek telepítve, mert a felhasználó blokkolta a telepítést.
failedPatchCount	integer	Azon javítások száma, amelyeket valamilyen probléma miatt nem lehetett telepíteni. A részletekért tekintse meg a hibákat.
installationActivityId	string	Az eredményt eredményező művelet tevékenységazonosítója. A CRP- és a bővítménynaplók közötti korrelációra szolgál.
installedPatchCount	integer	A sikeresen telepített javítások száma.
maintenanceWindowExceeded	boolean	Az, hogy a művelet elfogyott-e az időből, mielőtt az összes kívánt műveletet végrehajtotta volna.
notSelectedPatchCount	integer	Azoknak a javításoknak a száma, amelyek telepíthetőként észlelhetők, de nem felelnek meg a művelet feltételeinek.
patches	PatchInstallationDetail[]	A művelet során telepített javítások.
pendingPatchCount	integer	A telepítési feltételeknek megfelelőként azonosított, de nem telepíthető javítások száma. Ez általában akkor fordul elő, ha karbantartásWindowExceeded == igaz.
rebootStatus	VMGuestPatchRebootStatus	A virtuális gép újraindítási állapota a művelet befejezése után.
startDateTime	string	A művelet kezdetének UTC időbélyege.
status	PatchOperationStatus	A művelet általános sikeres vagy sikertelen állapota. A művelet befejezéséig "InProgress" marad. Ekkor a következő lesz: "Failed", "Succeeded", "Unknown" vagy "CompletedWithWarnings".

VMGuestPatchClassification_Linux

A linuxos javítások telepítésekor kiválasztandó frissítési besorolások.

Name	Típus	Description
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

A windowsos javítások telepítésekor kiválasztandó frissítési besorolások.

Name	Típus	Description
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

Meghatározza, hogy mikor lehet elfogadható újraindítani egy virtuális gépet egy szoftverfrissítési művelet során.

Name	Típus	Description
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

A virtuális gép újraindítási állapota a művelet befejezése után.

Name	Típus	Description
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

Az InstallPatches bemenete Windows rendszerű virtuális gépen, az API által közvetlenül fogadott módon

Name	Típus	Description
classificationsToInclude	VMGuestPatchClassification_Windows[]	A windowsos javítások telepítésekor kiválasztandó frissítési besorolások.
excludeKbsRequiringReboot	boolean	Kiszűri azokat a tudásbázisokat, amelyek nem rendelkeznek a "NeverReboots" InstallationRebootBehavior tulajdonságával, ha ez igaz értékre van állítva.
kbNumbersToExclude	string[]	Kizárandó tudásbázisok a javítási műveletben
kbNumbersToInclude	string[]	A javítási műveletbe belefoglalandó tudásbázisok
maxPatchPublishDate	string	Ez olyan javítások telepítéséhez használható, amelyeket ezen a maximális közzétételi dátumon vagy azt megelőzően tettek közzé.