Virtual Machines - Assess Patches

Referens

Service:: Compute

API Version:: 2024-03-01

Utvärdera korrigeringar på den virtuella datorn.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vmName	path	True	string	Namnet på den virtuella datorn.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	VirtualMachineAssessPatchesResult	OK
202 Accepted		Har godkänts
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	Api-felbas.
CloudError	Ett felsvar från Beräkningstjänsten.
InnerError	Inre felinformation.
PatchAssessmentState	Beskriver tillgängligheten för en viss korrigering.
PatchOperationStatus	Åtgärdens övergripande status för lyckade eller misslyckade åtgärder. Den förblir "InProgress" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckad", "Lyckades" eller "CompletedWithWarnings".
VirtualMachineAssessPatchesResult	Beskriver egenskaperna för ett AssessPatches-resultat.
VirtualMachineSoftwarePatchProperties	Listan över korrigeringar som har identifierats som tillgängliga för installation.
VMGuestPatchRebootBehavior	Beskriver omstartskraven för korrigeringen.

ApiError

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

CloudError

Ett felsvar från Beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

PatchAssessmentState

Beskriver tillgängligheten för en viss korrigering.

Name	Typ	Description
Available	string
Unknown	string

PatchOperationStatus

Åtgärdens övergripande status för lyckade eller misslyckade åtgärder. Den förblir "InProgress" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckad", "Lyckades" eller "CompletedWithWarnings".

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

VirtualMachineAssessPatchesResult

Beskriver egenskaperna för ett AssessPatches-resultat.

Name	Typ	Description
assessmentActivityId	string	Aktivitets-ID för åtgärden som genererade det här resultatet. Den används för att korrelera mellan CRP- och tilläggsloggar.
availablePatches	VirtualMachineSoftwarePatchProperties[]	Listan över korrigeringar som har identifierats som tillgängliga för installation.
criticalAndSecurityPatchCount	integer	Antalet kritiska korrigeringar eller säkerhetskorrigeringar som har identifierats som tillgängliga och ännu inte installerats.
error	ApiError	De fel som påträffades under körningen av åtgärden. Informationsmatrisen innehåller listan över dem.
otherPatchCount	integer	Antalet tillgängliga korrigeringar exklusive kritisk och säkerhet.
rebootPending	boolean	Den virtuella datorns övergripande omstartsstatus. Det är sant när delvis installerade korrigeringar kräver en omstart för att slutföra installationen, men omstarten har ännu inte inträffat.
startDateTime	string	UTC-tidsstämpeln när åtgärden påbörjades.
status	PatchOperationStatus	Åtgärdens övergripande status för lyckade eller misslyckade åtgärder. Den förblir "InProgress" tills åtgärden har slutförts. Då blir den "Okänd", "Misslyckad", "Lyckades" eller "CompletedWithWarnings".

VirtualMachineSoftwarePatchProperties

Listan över korrigeringar som har identifierats som tillgängliga för installation.

Name	Typ	Description
activityId	string	Aktivitets-ID för åtgärden som genererade det här resultatet. Den används för att korrelera mellan CRP- och tilläggsloggar.
assessmentState	PatchAssessmentState	Beskriver tillgängligheten för en viss korrigering.
classifications	string[]	Korrigeringens klassificering(ar) som tillhandahålls av korrigeringsutgivaren.
kbId	string	KBID för korrigeringen. Gäller endast för Windows-korrigeringar.
lastModifiedDateTime	string	UTC-tidsstämpeln för den senaste uppdateringen av den här korrigeringsposten.
name	string	Det egna namnet på korrigeringen.
patchId	string	En unik identifierare för korrigeringen.
publishedDate	string	UTC-tidsstämpeln när lagringsplatsen publicerade den här korrigeringen.
rebootBehavior	VMGuestPatchRebootBehavior	Beskriver omstartskraven för korrigeringen.
version	string	Versionsnumret för korrigeringen. Den här egenskapen gäller endast för Linux-korrigeringar.

VMGuestPatchRebootBehavior

Beskriver omstartskraven för korrigeringen.

Name	Typ	Description
AlwaysRequiresReboot	string
CanRequestReboot	string
NeverReboots	string
Unknown	string

Virtual Machines - Assess Patches

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

Assess patch state of a virtual machine.

Sample Request

Sample Response

Definitioner

ApiError

ApiErrorBase

CloudError

InnerError

PatchAssessmentState

PatchOperationStatus

VirtualMachineAssessPatchesResult

VirtualMachineSoftwarePatchProperties

VMGuestPatchRebootBehavior

Ytterligare resurser