Virtual Machines - Install Patches

Usługa:

Compute

Wersja interfejsu API:

2024-07-01

Instaluje poprawki na maszynie wirtualnej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
vmName	path	True	string	Nazwa maszyny wirtualnej.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
installPatchesInput	VirtualMachineInstallPatchesParameters	Dane wejściowe dla elementów InstallPatches odebrane bezpośrednio przez interfejs API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VirtualMachineInstallPatchesResult	OK
202 Accepted		Akceptowane
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Install patch state of a virtual machine.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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
}

Kod stanu:

202

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

Definicje

Nazwa	Opis
ApiError	Błąd interfejsu API.
ApiErrorBase	Baza błędów interfejsu API.
CloudError	Odpowiedź na błąd z usługi Obliczeniowej.
InnerError	Szczegóły błędu wewnętrznego.
LinuxParameters	Dane wejściowe dla instalacjiPatches na maszynie wirtualnej z systemem Linux, jak bezpośrednio odebrane przez interfejs API
PatchInstallationDetail	Poprawki, które zostały zainstalowane podczas operacji.
PatchInstallationState	Stan poprawki po zakończeniu operacji instalacji.
PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress", dopóki operacja nie zostanie ukończona. W tym momencie stanie się to "Niepowodzenie", "Succeeded", "Unknown" lub "CompletedWithWarnings".
VirtualMachineInstallPatchesParameters	Dane wejściowe dla elementów InstallPatches odebrane bezpośrednio przez interfejs API
VirtualMachineInstallPatchesResult	Podsumowanie wyniku operacji instalacji.
VMGuestPatchClassification_Linux	Klasyfikacje aktualizacji do wybrania podczas instalowania poprawek dla systemu Linux.
VMGuestPatchClassification_Windows	Klasyfikacje aktualizacji do wybrania podczas instalowania poprawek dla systemu Windows.
VMGuestPatchRebootSetting	Określa, kiedy dopuszczalne jest ponowne uruchomienie maszyny wirtualnej podczas operacji aktualizacji oprogramowania.
VMGuestPatchRebootStatus	Stan ponownego uruchomienia maszyny wirtualnej po zakończeniu operacji.
WindowsParameters	Dane wejściowe dla instalacjiPatches na maszynie wirtualnej z systemem Windows, jak bezpośrednio odebrane przez interfejs API

ApiError

Błąd interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Błąd wewnętrzny interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

CloudError

Odpowiedź na błąd z usługi Obliczeniowej.

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

InnerError

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

LinuxParameters

Dane wejściowe dla instalacjiPatches na maszynie wirtualnej z systemem Linux, jak bezpośrednio odebrane przez interfejs API

Nazwa	Typ	Opis
classificationsToInclude	VMGuestPatchClassification_Linux[]	Klasyfikacje aktualizacji do wybrania podczas instalowania poprawek dla systemu Linux.
maintenanceRunId	string	Jest to używane jako identyfikator przebiegu konserwacji dla automatycznego stosowania poprawek gościa maszyny wirtualnej w systemie Linux.
packageNameMasksToExclude	string[]	pakiety do wykluczenia w operacji poprawki. Format: packageName_packageVersion
packageNameMasksToInclude	string[]	pakiety do uwzględnienia w operacji stosowania poprawek. Format: packageName_packageVersion

PatchInstallationDetail

Poprawki, które zostały zainstalowane podczas operacji.

Nazwa	Typ	Opis
classifications	string[]	Klasyfikacje poprawek udostępniane przez wydawcę poprawek.
installationState	PatchInstallationState	Stan poprawki po zakończeniu operacji instalacji.
kbId	string	Identyfikator KBID poprawki. Dotyczy tylko poprawek systemu Windows.
name	string	Przyjazna nazwa poprawki.
patchId	string	Unikatowy identyfikator poprawki.
version	string	Ciąg wersji pakietu. Może on być zgodny z semantycznym przechowywaniem wersji. Dotyczy tylko systemu Linux.

PatchInstallationState

Stan poprawki po zakończeniu operacji instalacji.

Nazwa	Typ	Opis
Excluded	string
Failed	string
Installed	string
NotSelected	string
Pending	string
Unknown	string

PatchOperationStatus

Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress", dopóki operacja nie zostanie ukończona. W tym momencie stanie się to "Niepowodzenie", "Succeeded", "Unknown" lub "CompletedWithWarnings".

Nazwa	Typ	Opis
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineInstallPatchesParameters

Dane wejściowe dla elementów InstallPatches odebrane bezpośrednio przez interfejs API

Nazwa	Typ	Opis
linuxParameters	LinuxParameters	Dane wejściowe dla instalacjiPatches na maszynie wirtualnej z systemem Linux, jak bezpośrednio odebrane przez interfejs API
maximumDuration	string	Określa maksymalny czas uruchomienia operacji. Musi to być ciąg czasu trwania zgodny ze standardem ISO 8601, taki jak PT4H (4 godziny)
rebootSetting	VMGuestPatchRebootSetting	Określa, kiedy dopuszczalne jest ponowne uruchomienie maszyny wirtualnej podczas operacji aktualizacji oprogramowania.
windowsParameters	WindowsParameters	Dane wejściowe dla instalacjiPatches na maszynie wirtualnej z systemem Windows, jak bezpośrednio odebrane przez interfejs API

VirtualMachineInstallPatchesResult

Podsumowanie wyniku operacji instalacji.

Nazwa	Typ	Opis
error	ApiError	Błędy, które wystąpiły podczas wykonywania operacji. Tablica szczegółów zawiera listę.
excludedPatchCount	integer	Liczba poprawek, które nie zostały zainstalowane z powodu blokowania instalacji przez użytkownika.
failedPatchCount	integer	Liczba poprawek, których nie można zainstalować z powodu niektórych problemów. Zobacz błędy, aby uzyskać szczegółowe informacje.
installationActivityId	string	Identyfikator działania operacji, która wygenerowała ten wynik. Służy do korelowania między dziennikami CRP i rozszerzeniami.
installedPatchCount	integer	Liczba poprawek, które zostały pomyślnie zainstalowane.
maintenanceWindowExceeded	boolean	Czy operacja zakończyła się z upływem czasu, zanim zakończyła wszystkie zamierzone działania.
notSelectedPatchCount	integer	Liczba wykrytych poprawek dostępnych do zainstalowania, ale nie spełniała kryteriów operacji.
patches	PatchInstallationDetail[]	Poprawki, które zostały zainstalowane podczas operacji.
pendingPatchCount	integer	Liczba poprawek, które zostały zidentyfikowane jako spełniające kryteria instalacji, ale nie można było ich zainstalować. Zazwyczaj dzieje się tak, gdy konserwacjaWindowExceeded == true.
rebootStatus	VMGuestPatchRebootStatus	Stan ponownego uruchomienia maszyny wirtualnej po zakończeniu operacji.
startDateTime	string	Sygnatura czasowa UTC rozpoczęcia operacji.
status	PatchOperationStatus	Ogólny stan powodzenia lub niepowodzenia operacji. Pozostaje on "InProgress", dopóki operacja nie zostanie ukończona. W tym momencie stanie się to "Niepowodzenie", "Succeeded", "Unknown" lub "CompletedWithWarnings".

VMGuestPatchClassification_Linux

Klasyfikacje aktualizacji do wybrania podczas instalowania poprawek dla systemu Linux.

Nazwa	Typ	Opis
Critical	string
Other	string
Security	string

VMGuestPatchClassification_Windows

Klasyfikacje aktualizacji do wybrania podczas instalowania poprawek dla systemu Windows.

Nazwa	Typ	Opis
Critical	string
Definition	string
FeaturePack	string
Security	string
ServicePack	string
Tools	string
UpdateRollUp	string
Updates	string

VMGuestPatchRebootSetting

Określa, kiedy dopuszczalne jest ponowne uruchomienie maszyny wirtualnej podczas operacji aktualizacji oprogramowania.

Nazwa	Typ	Opis
Always	string
IfRequired	string
Never	string

VMGuestPatchRebootStatus

Stan ponownego uruchomienia maszyny wirtualnej po zakończeniu operacji.

Nazwa	Typ	Opis
Completed	string
Failed	string
NotNeeded	string
Required	string
Started	string
Unknown	string

WindowsParameters

Dane wejściowe dla instalacjiPatches na maszynie wirtualnej z systemem Windows, jak bezpośrednio odebrane przez interfejs API

Nazwa	Typ	Opis
classificationsToInclude	VMGuestPatchClassification_Windows[]	Klasyfikacje aktualizacji do wybrania podczas instalowania poprawek dla systemu Windows.
excludeKbsRequiringReboot	boolean	Filtruje kbs, które nie mają właściwości InstallationRebootBehavior polecenia "NeverReboots", gdy jest ustawiona wartość true.
kbNumbersToExclude	string[]	Kbs do wykluczenia w operacji poprawki
kbNumbersToInclude	string[]	Kbs do uwzględnienia w operacji poprawek
maxPatchPublishDate	string	Służy do instalowania poprawek opublikowanych w dniu lub przed tą maksymalną datą publikacji.