Get Recommendations - List

Service:: Sentinel

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

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

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

URI パラメーター

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

応答

Name	型	説明
200 OK	RecommendationList	Azureの運用は無事に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

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

スコープ

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

例

Get Recommendations list.

要求のサンプル

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-07-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.securityinsight import SecurityInsightsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-securityinsight
# USAGE
    python get_recommendations.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 = SecurityInsightsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.get_recommendations.list(
        resource_group_name="myRg",
        workspace_name="myWorkspace",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-07-01-preview/recommendations/GetRecommendations.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 armsecurityinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/securityinsights/armsecurityinsights/v2"
)

// Generated from example definition: 2025-07-01-preview/recommendations/GetRecommendations.json
func ExampleGetRecommendationsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurityinsights.NewClientFactory("d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGetRecommendationsClient().NewListPager("myRg", "myWorkspace", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsecurityinsights.GetRecommendationsClientListResponse{
		// 	RecommendationList: armsecurityinsights.RecommendationList{
		// 		Value: []*armsecurityinsights.Recommendation{
		// 			{
		// 				Name: to.Ptr("ceea048e-923e-4eeb-8fcb-6cb0c06b101f"),
		// 				Type: to.Ptr("Microsoft.SecurityInsights/Recommendations"),
		// 				ID: to.Ptr("/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f"),
		// 				Properties: &armsecurityinsights.RecommendationProperties{
		// 					Description: to.Ptr("someText"),
		// 					AdditionalProperties: map[string]*string{
		// 						"someKey": to.Ptr("someValue"),
		// 					},
		// 					CreationTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-19T03:09:03.4888396+00:00"); return t}()),
		// 					LastEvaluatedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-19T03:09:03.4888396+00:00"); return t}()),
		// 					LastModifiedTimeUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-02-19T03:57:31.7964447+00:00"); return t}()),
		// 					RecommendationTypeID: to.Ptr("ThreatIntelligence_Example"),
		// 					ResourceID: to.Ptr("someId"),
		// 					State: to.Ptr(armsecurityinsights.StateCompletedBySystem),
		// 					Suggestions: []*armsecurityinsights.RecommendedSuggestion{
		// 						{
		// 							Description: to.Ptr("someText"),
		// 							Action: to.Ptr("someText"),
		// 							AdditionalProperties: map[string]*string{
		// 								"someKey": to.Ptr("someValue"),
		// 							},
		// 							SuggestionTypeID: to.Ptr("ThreatIntelligence_Example_Suggestion_Example"),
		// 							Title: to.Ptr("someText"),
		// 						},
		// 					},
		// 					Title: to.Ptr("someText"),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityInsights } = require("@azure/arm-securityinsight");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a list of all recommendations.
 *
 * @summary gets a list of all recommendations.
 * x-ms-original-file: 2025-07-01-preview/recommendations/GetRecommendations.json
 */
async function getRecommendationsList() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
  const client = new SecurityInsights(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.getRecommendations.list("myRg", "myWorkspace")) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "name": "ceea048e-923e-4eeb-8fcb-6cb0c06b101f",
      "type": "Microsoft.SecurityInsights/Recommendations",
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f",
      "properties": {
        "description": "someText",
        "additionalProperties": {
          "someKey": "someValue"
        },
        "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",
        "recommendationTypeId": "ThreatIntelligence_Example",
        "resourceId": "someId",
        "state": "CompletedBySystem",
        "suggestions": [
          {
            "description": "someText",
            "action": "someText",
            "additionalProperties": {
              "someKey": "someValue"
            },
            "suggestionTypeId": "ThreatIntelligence_Example_Suggestion_Example",
            "title": "someText"
          }
        ],
        "title": "someText"
      }
    }
  ]
}

定義

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

CloudError

Object

エラー応答の構造。

Name	型	説明
error	CloudErrorBody	エラーデータ

CloudErrorBody

Object

エラーの詳細。

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

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

Recommendation

Object

レコメンデーションオブジェクト。

Name	型	説明
etag	string	Azure リソースの Etag
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.additionalProperties	object	推奨事項の追加プロパティのコレクション。
properties.creationTimeUtc	string (date-time)	推奨事項が作成されたときのタイムスタンプ (UTC)。
properties.description	string	推奨事項の説明。
properties.lastEvaluatedTimeUtc	string (date-time)	推奨事項が最後に評価されたときのタイムスタンプ (UTC)。
properties.lastModifiedTimeUtc	string (date-time)	推奨事項が最後に変更されたときのタイムスタンプ (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

Object

推奨事項の一覧

Name	型	説明
nextLink	string (uri)	アイテムの次のページへのリンク
value	Recommendation[]	このページの推奨項目

RecommendedSuggestion

Object

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

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

State

列挙

推薦状。

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

systemData

Object

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

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