Virtual Machines - Assess Patches

リファレンス

Service:: Compute

API Version:: 2024-03-01

VM 上のパッチを評価します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
vmName	path	True	string	仮想マシンの名前。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	VirtualMachineAssessPatchesResult	OK
202 Accepted		同意
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Assess patch state of a virtual machine.

Sample Request

HTTP

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

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

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピューティングサービスからのエラー応答。
InnerError	内部エラーの詳細。
PatchAssessmentState	特定のパッチの可用性について説明します。
PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで、"InProgress" のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。
VirtualMachineAssessPatchesResult	AssessPatches 結果のプロパティについて説明します。
VirtualMachineSoftwarePatchProperties	インストール可能として検出されたパッチの一覧。
VMGuestPatchRebootBehavior	パッチの再起動要件について説明します。

ApiError

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api の内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

CloudError

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

PatchAssessmentState

特定のパッチの可用性について説明します。

名前	型	説明
Available	string
Unknown	string

PatchOperationStatus

操作の全体的な成功または失敗の状態。操作が完了するまで、"InProgress" のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

名前	型	説明
CompletedWithWarnings	string
Failed	string
InProgress	string
Succeeded	string
Unknown	string

VirtualMachineAssessPatchesResult

AssessPatches 結果のプロパティについて説明します。

名前	型	説明
assessmentActivityId	string	この結果を生成した操作のアクティビティ ID。これは、CRP ログと拡張機能ログ間で相互に関連付けるために使用されます。
availablePatches	VirtualMachineSoftwarePatchProperties[]	インストール可能として検出されたパッチの一覧。
criticalAndSecurityPatchCount	integer	使用可能として検出され、まだインストールされていないクリティカルパッチまたはセキュリティパッチの数。
error	ApiError	操作の実行中に発生したエラー。 details 配列には、それらのリストが含まれています。
otherPatchCount	integer	クリティカルおよびセキュリティを除く使用可能なすべてのパッチの数。
rebootPending	boolean	VM の全体的な再起動状態。これは、部分的にインストールされたパッチがインストールを完了するために再起動を必要とするが、再起動がまだ発生していない場合に当てはまります。
startDateTime	string	操作が開始されたときの UTC タイムスタンプ。
status	PatchOperationStatus	操作の全体的な成功または失敗の状態。操作が完了するまで、"InProgress" のままです。その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

VirtualMachineSoftwarePatchProperties

インストール可能として検出されたパッチの一覧。

名前	型	説明
activityId	string	この結果を生成した操作のアクティビティ ID。これは、CRP ログと拡張機能ログ間で相互に関連付けるために使用されます。
assessmentState	PatchAssessmentState	特定のパッチの可用性について説明します。
classifications	string[]	パッチ発行者によって提供されるパッチの分類。
kbId	string	パッチの KBID。 Windows パッチにのみ適用されます。
lastModifiedDateTime	string	このパッチレコードに対する最後の更新プログラムの UTC タイムスタンプ。
name	string	パッチのフレンドリ名。
patchId	string	パッチの一意識別子。
publishedDate	string	リポジトリがこのパッチを発行したときの UTC タイムスタンプ。
rebootBehavior	VMGuestPatchRebootBehavior	パッチの再起動要件について説明します。
version	string	パッチのバージョン番号。このプロパティは、Linux パッチにのみ適用されます。

VMGuestPatchRebootBehavior

パッチの再起動要件について説明します。

名前	型	説明
AlwaysRequiresReboot	string
CanRequestReboot	string
NeverReboots	string
Unknown	string