Get Recommendations - List

リファレンス

サービス:: Sentinel

API バージョン:: 2025-01-01-preview

すべての推奨事項の一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/recommendations?api-version=2025-01-01-preview

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
workspaceName	path	True	string	ワークスペースの名前。正規表現パターン: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	RecommendationList	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get Recommendations list.

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/recommendations?api-version=2025-01-01-preview

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f",
      "name": "ceea048e-923e-4eeb-8fcb-6cb0c06b101f",
      "type": "Microsoft.SecurityInsights/Recommendations",
      "properties": {
        "recommendationTypeId": "ThreatIntelligence_Example",
        "state": "CompletedBySystem",
        "title": "someText",
        "description": "someText",
        "creationTimeUtc": "2022-02-19T03:09:03.4888396+00:00",
        "lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00",
        "lastModifiedTimeUtc": "2022-02-19T03:57:31.7964447+00:00",
        "suggestions": [
          {
            "suggestionTypeId": "ThreatIntelligence_Example_Suggestion_Example",
            "title": "someText",
            "description": "someText",
            "action": "someText",
            "additionalProperties": {
              "someKey": "someValue"
            }
          }
        ],
        "resourceId": "someId",
        "additionalProperties": {
          "someKey": "someValue"
        }
      }
    }
  ]
}

定義

名前	説明
CloudError	エラー応答の構造。
CloudErrorBody	エラーの詳細。
createdByType	リソースを作成した ID の種類。
Recommendation	Recommendation オブジェクト。
RecommendationList	推奨事項の一覧
RecommendedSuggestion	推奨事項を完了するには、どのような提案を行う必要があります。
State	推奨事項の状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

CloudError

エラー応答の構造。

名前	型	説明
error	CloudErrorBody	エラーデータ

CloudErrorBody

エラーの詳細。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

Recommendation

Recommendation オブジェクト。

名前	型	説明
etag	string	Azure リソースの Etag
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.additionalProperties	object	推奨事項の追加プロパティのコレクション。
properties.creationTimeUtc	string	推奨事項が作成されたときのタイムスタンプ (UTC)。
properties.description	string	推奨事項の説明。
properties.lastEvaluatedTimeUtc	string	推奨事項が最後に評価されたときのタイムスタンプ (UTC)。
properties.lastModifiedTimeUtc	string	推奨事項が最後に変更されたときのタイムスタンプ (UTC)。
properties.recommendationTypeId	string	推奨事項の種類の ID。
properties.resourceId	string	この推奨事項が参照するリソースの ID。
properties.state	State	推奨事項の状態。
properties.suggestions	RecommendedSuggestion[]	この推奨事項に対して実行する候補の一覧。
properties.title	string	推奨事項のタイトル。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

RecommendationList

推奨事項の一覧

名前	型	説明
nextLink	string	リソースの次のページへのリンク。
value	Recommendation[]	推奨事項の一覧

RecommendedSuggestion

推奨事項を完了するには、どのような提案を行う必要があります。

名前	型	説明
action	string	提案のアクション。
additionalProperties	object	提案の追加プロパティのコレクション。
description	string	提案の説明。
suggestionTypeId	string	提案の種類の ID。
title	string	提案のタイトル。

State

推奨事項の状態。

名前	型	説明
Active	string	推奨事項はアクティブです。
CompletedBySystem	string	推奨事項はシステムによって完了しました。
CompletedByUser	string	ユーザーが推奨事項を完了しました。
Dismissed	string	推奨事項は無視されました。
InProgress	string	推奨事項が進行中です。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有