Virtual Machines - Assess Patches

Referentie

Service:: Compute

API Version:: 2024-03-01

Patches op de VM evalueren.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
vmName	path	True	string	De naam van de virtuele machine.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	VirtualMachineAssessPatchesResult	OK
202 Accepted		Geaccepteerd
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Assess patch state of a virtual machine.

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/assessPatches?api-version=2024-03-01


/**
 * Samples for VirtualMachines AssessPatches.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * virtualMachineExamples/VirtualMachine_AssessPatches.json
     */
    /**
     * Sample code: Assess patch state of a virtual machine.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void assessPatchStateOfAVirtualMachine(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getVirtualMachines().assessPatches("myResourceGroupName",
            "myVMName", 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 azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python virtual_machine_assess_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_assess_patches(
        resource_group_name="myResourceGroupName",
        vm_name="myVMName",
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.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"

	"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_AssessPatches.json
func ExampleVirtualMachinesClient_BeginAssessPatches() {
	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().BeginAssessPatches(ctx, "myResourceGroupName", "myVMName", 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.VirtualMachineAssessPatchesResult = armcompute.VirtualMachineAssessPatchesResult{
	// 	AssessmentActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 	AvailablePatches: []*armcompute.VirtualMachineSoftwarePatchProperties{
	// 		{
	// 			Name: to.Ptr("Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)"),
	// 			ActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 			AssessmentState: to.Ptr(armcompute.PatchAssessmentStateAvailable),
	// 			Classifications: []*string{
	// 				to.Ptr("Definition Updates")},
	// 				KbID: to.Ptr("2267602"),
	// 				LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:18:45.283Z"); return t}()),
	// 				PatchID: to.Ptr("35428702-5784-4ba4-a6e0-5222258b5411"),
	// 				PublishedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-07T00:00:00.000Z"); return t}()),
	// 				RebootBehavior: to.Ptr(armcompute.VMGuestPatchRebootBehaviorNeverReboots),
	// 				Version: to.Ptr(""),
	// 			},
	// 			{
	// 				Name: to.Ptr("Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)"),
	// 				ActivityID: to.Ptr("68f8b292-dfc2-4646-9781-33cc88631968"),
	// 				AssessmentState: to.Ptr(armcompute.PatchAssessmentStateAvailable),
	// 				Classifications: []*string{
	// 					to.Ptr("Update Rollups")},
	// 					KbID: to.Ptr("890830"),
	// 					LastModifiedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T21:18:45.283Z"); return t}()),
	// 					PatchID: to.Ptr("39f9cdd1-795c-4d0e-8c0a-73ab3f31746d"),
	// 					PublishedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-07T00:00:00.000Z"); return t}()),
	// 					RebootBehavior: to.Ptr(armcompute.VMGuestPatchRebootBehaviorCanRequestReboot),
	// 					Version: to.Ptr(""),
	// 			}},
	// 			CriticalAndSecurityPatchCount: to.Ptr[int32](1),
	// 			OtherPatchCount: to.Ptr[int32](2),
	// 			RebootPending: to.Ptr(true),
	// 			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 Assess patches on the VM.
 *
 * @summary Assess patches on the VM.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json
 */
async function assessPatchStateOfAVirtualMachine() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroupName";
  const vmName = "myVMName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.virtualMachines.beginAssessPatchesAndWait(resourceGroupName, vmName);
  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",
  "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
  "rebootPending": true,
  "criticalAndSecurityPatchCount": 1,
  "otherPatchCount": 2,
  "startDateTime": "2020-04-24T21:02:04.2556154Z",
  "availablePatches": [
    {
      "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"
      ],
      "rebootBehavior": "NeverReboots",
      "activityId": "68f8b292-dfc2-4646-9781-33cc88631968",
      "publishedDate": "2018-11-07T00:00:00Z",
      "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z",
      "assessmentState": "Available"
    },
    {
      "patchId": "39f9cdd1-795c-4d0e-8c0a-73ab3f31746d",
      "name": "Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)",
      "version": "",
      "kbId": "890830",
      "classifications": [
        "Update Rollups"
      ],
      "rebootBehavior": "CanRequestReboot",
      "activityId": "68f8b292-dfc2-4646-9781-33cc88631968",
      "publishedDate": "2018-11-07T00:00:00Z",
      "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z",
      "assessmentState": "Available"
    }
  ],
  "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

Definities

Name	Description
ApiError	API-fout.
ApiErrorBase	API-foutbasis.
CloudError	Een foutreactie van de Compute-service.
InnerError	Details van interne fout.
PatchAssessmentState	Beschrijft de beschikbaarheid van een bepaalde patch.
PatchOperationStatus	De algehele geslaagde of mislukte status van de bewerking. Het blijft 'InProgress' totdat de bewerking is voltooid. Op dat moment wordt het 'Onbekend', 'Mislukt', 'Geslaagd' of 'CompletedWithWarnings'.
VirtualMachineAssessPatchesResult	Beschrijft de eigenschappen van een AssessPatches-resultaat.
VirtualMachineSoftwarePatchProperties	De lijst met patches die zijn gedetecteerd als beschikbaar voor installatie.
VMGuestPatchRebootBehavior	Beschrijft de vereisten voor opnieuw opstarten van de patch.

ApiError

API-fout.

Name	Type	Description
code	string	De foutcode.
details	ApiErrorBase[]	De API-foutdetails
innererror	InnerError	De interne API-fout
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

ApiErrorBase

API-foutbasis.

Name	Type	Description
code	string	De foutcode.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

CloudError

Een foutreactie van de Compute-service.

Name	Type	Description
error	ApiError	API-fout.

InnerError

Details van interne fout.

Name	Type	Description
errordetail	string	Het interne foutbericht of de uitzonderingsdump.
exceptiontype	string	Het uitzonderingstype.

PatchAssessmentState

Beschrijft de beschikbaarheid van een bepaalde patch.

Name	Type	Description
Available	string
Unknown	string

PatchOperationStatus

De algehele geslaagde of mislukte status van de bewerking. Het blijft 'InProgress' totdat de bewerking is voltooid. Op dat moment wordt het 'Onbekend', 'Mislukt', 'Geslaagd' of 'CompletedWithWarnings'.

Name	Type	Description
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineAssessPatchesResult

Beschrijft de eigenschappen van een AssessPatches-resultaat.

Name	Type	Description
assessmentActivityId	string	De activiteits-id van de bewerking die dit resultaat heeft geproduceerd. Het wordt gebruikt om te correleren tussen CRP- en extensielogboeken.
availablePatches	VirtualMachineSoftwarePatchProperties[]	De lijst met patches die zijn gedetecteerd als beschikbaar voor installatie.
criticalAndSecurityPatchCount	integer	Het aantal kritieke of beveiligingspatches dat is gedetecteerd als beschikbaar en nog niet geïnstalleerd.
error	ApiError	De fouten die zijn opgetreden tijdens het uitvoeren van de bewerking. De detailmatrix bevat de lijst met de details.
otherPatchCount	integer	Het aantal beschikbare patches, met uitzondering van kritiek en beveiliging.
rebootPending	boolean	De algehele status van opnieuw opstarten van de VM. Dit is waar wanneer gedeeltelijk geïnstalleerde patches opnieuw moeten worden opgestart om de installatie te voltooien, maar het opnieuw opstarten nog niet heeft plaatsgevonden.
startDateTime	string	De UTC-tijdstempel wanneer de bewerking is gestart.
status	PatchOperationStatus	De algehele geslaagde of mislukte status van de bewerking. Het blijft 'InProgress' totdat de bewerking is voltooid. Op dat moment wordt het 'Onbekend', 'Mislukt', 'Geslaagd' of 'CompletedWithWarnings'.

VirtualMachineSoftwarePatchProperties

De lijst met patches die zijn gedetecteerd als beschikbaar voor installatie.

Name	Type	Description
activityId	string	De activiteits-id van de bewerking die dit resultaat heeft geproduceerd. Het wordt gebruikt om te correleren tussen CRP- en extensielogboeken.
assessmentState	PatchAssessmentState	Beschrijft de beschikbaarheid van een bepaalde patch.
classifications	string[]	De classificatie(s) van de patch zoals opgegeven door de uitgever van de patch.
kbId	string	De KBID van de patch. Alleen van toepassing op Windows-patches.
lastModifiedDateTime	string	Het UTC-tijdstempel van de laatste update voor deze patchrecord.
name	string	De beschrijvende naam van de patch.
patchId	string	Een unieke id voor de patch.
publishedDate	string	Het UTC-tijdstempel toen de opslagplaats deze patch heeft gepubliceerd.
rebootBehavior	VMGuestPatchRebootBehavior	Beschrijft de vereisten voor opnieuw opstarten van de patch.
version	string	Het versienummer van de patch. Deze eigenschap is alleen van toepassing op Linux-patches.

VMGuestPatchRebootBehavior

Beschrijft de vereisten voor opnieuw opstarten van de patch.

Name	Type	Description
AlwaysRequiresReboot	string
CanRequestReboot	string
NeverReboots	string
Unknown	string

Delen via

Virtual Machines - Assess Patches

URI-parameters

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

Assess patch state of a virtual machine.

Sample Request

Sample Response

Definities

ApiError

ApiErrorBase

CloudError

InnerError

PatchAssessmentState

PatchOperationStatus

VirtualMachineAssessPatchesResult

VirtualMachineSoftwarePatchProperties

VMGuestPatchRebootBehavior

Aanvullende resources