Virtual Machines - Assess Patches

Referensi

Service:: Compute

API Version:: 2022-03-01

Menilai patch pada VM.

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

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	Info masuk 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.

Respons

Name	Type	Description
200 OK	VirtualMachineAssessPatchesResult	OK
202 Accepted		Diterima
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

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=2022-03-01

import com.azure.core.util.Context;

/** Samples for VirtualMachines AssessPatches. */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/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", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/stable/2022-03-01/ComputeRP/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()
	client, err := armcompute.NewVirtualMachinesClient("{subscription-id}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/stable/2022-03-01/ComputeRP/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json
 */
async function assessPatchStateOfAVirtualMachine() {
  const subscriptionId = "{subscription-id}";
  const resourceGroupName = "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);
}

assessPatchStateOfAVirtualMachine().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

Definisi

ApiError	Kesalahan api.
ApiErrorBase	Basis kesalahan api.
CloudError	Respons kesalahan dari layanan Komputasi.
InnerError	Detail kesalahan dalam.
PatchAssessmentState	Menjelaskan ketersediaan patch tertentu.
PatchOperationStatus	Status keberhasilan atau kegagalan operasi secara keseluruhan. Ini tetap "InProgress" sampai operasi selesai. Pada saat itu akan menjadi "Tidak Diketahui", "Gagal", "Berhasil", atau "CompletedWithWarnings."
VirtualMachineAssessPatchesResult	Menjelaskan properti hasil AssessPatches.
VirtualMachineSoftwarePatchProperties	Menjelaskan properti patch perangkat lunak Komputer Virtual.
VMGuestPatchRebootBehavior	Menjelaskan persyaratan reboot patch.

ApiError

Kesalahan api.

Name	Type	Description
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.

Name	Type	Description
code	string	Kode kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan tertentu.

CloudError

Respons kesalahan dari layanan Komputasi.

Name	Type	Description
error	ApiError	Kesalahan api.

InnerError

Detail kesalahan dalam.

Name	Type	Description
errordetail	string	Pesan kesalahan internal atau cadangan pengecualian.
exceptiontype	string	Jenis pengecualian.

PatchAssessmentState

Menjelaskan ketersediaan patch tertentu.

Name	Type	Description
Available	string
Unknown	string

PatchOperationStatus

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

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

VirtualMachineAssessPatchesResult

Menjelaskan properti hasil AssessPatches.

Name	Type	Description
assessmentActivityId	string	ID aktivitas operasi yang menghasilkan hasil ini. Ini digunakan untuk berkorelasi di seluruh log CRP dan ekstensi.
availablePatches	VirtualMachineSoftwarePatchProperties[]	Daftar patch yang telah terdeteksi tersedia untuk penginstalan.
criticalAndSecurityPatchCount	integer	Jumlah patch penting atau keamanan yang telah terdeteksi sebagai tersedia dan belum diinstal.
error	ApiError	Kesalahan yang ditemui selama eksekusi operasi. Array detail berisi daftarnya.
otherPatchCount	integer	Jumlah semua patch yang tersedia tidak termasuk penting dan keamanan.
rebootPending	boolean	Status boot ulang keseluruhan VM. Ini akan benar ketika patch yang diinstal sebagian memerlukan boot ulang untuk menyelesaikan penginstalan tetapi boot ulang belum terjadi.
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 "Tidak Diketahui", "Gagal", "Berhasil", atau "CompletedWithWarnings."

VirtualMachineSoftwarePatchProperties

Menjelaskan properti patch perangkat lunak Komputer Virtual.

Name	Type	Description
activityId	string	ID aktivitas operasi yang menghasilkan hasil ini. Ini digunakan untuk berkorelasi di seluruh log CRP dan ekstensi.
assessmentState	PatchAssessmentState	Menjelaskan ketersediaan patch tertentu.
classifications	string[]	Klasifikasi patch sebagaimana disediakan oleh penerbit patch.
kbId	string	KBID patch. Hanya berlaku untuk patch Windows.
lastModifiedDateTime	string	Tanda waktu UTC dari pembaruan terakhir untuk rekaman patch ini.
name	string	Nama patch yang ramah.
patchId	string	Pengidentifikasi unik untuk patch.
publishedDate	string	Tanda waktu UTC ketika repositori menerbitkan patch ini.
rebootBehavior	VMGuestPatchRebootBehavior	Menjelaskan persyaratan reboot patch.
version	string	Nomor versi patch. Properti ini hanya berlaku untuk patch Linux.

VMGuestPatchRebootBehavior

Menjelaskan persyaratan reboot patch.

Name	Type	Description
AlwaysRequiresReboot	string
CanRequestReboot	string
NeverReboots	string
Unknown	string