Get Recommendations - List

Служба:: 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

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (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, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	RecommendationList	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
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-07-01-preview

Пример ответа

Код состояния:: 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"
      }
    }
  ]
}

Определения

Имя	Описание
CloudError	Структура ответа на ошибки.
CloudErrorBody	Сведения об ошибке.
createdByType	Тип удостоверения, создавшего ресурс.
Recommendation	Объект рекомендации.
RecommendationList	Список рекомендаций
RecommendedSuggestion	Какие предложения следует принять для выполнения рекомендации.
State	Штат рекомендаций.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CloudError

Объект

Структура ответа на ошибки.

Имя	Тип	Описание
error	CloudErrorBody	Данные об ошибках

CloudErrorBody

Объект

Сведения об ошибке.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

Recommendation

Объект

Объект рекомендации.

Имя	Тип	Описание
etag	string	Etag ресурса Azure
id	string (arm-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	Идентификатор типа рекомендации.
properties.resourceId	string	Идентификатор ресурса, на который ссылается эта рекомендация.
properties.state	State	Состояние рекомендации.
properties.suggestions	RecommendedSuggestion[]	Список предложений, которые следует принять для этой рекомендации.
properties.title	string	Заголовок рекомендации.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

RecommendationList

Объект

Список рекомендаций

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	Recommendation[]	Рекомендации на этой странице

RecommendedSuggestion

Объект

Какие предложения следует принять для выполнения рекомендации.

Имя	Тип	Описание
action	string	Действие предложения.
additionalProperties	object	Коллекция дополнительных свойств для предложения.
description	string	Описание предложения.
suggestionTypeId	string	Идентификатор типа предложения.
title	string	Заголовок предложения.

State

Перечисление

Штат рекомендаций.

Значение	Описание
Active	Рекомендация активна.
InProgress	Выполняется рекомендация.
Dismissed	Рекомендация была отклонена.
CompletedByUser	Рекомендация завершена пользователем.
CompletedBySystem	Рекомендация завершена системой.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Get Recommendations - List

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Get Recommendations list.

Образец запроса

Пример ответа

Определения

CloudError

CloudErrorBody

createdByType

Recommendation

RecommendationList

RecommendedSuggestion

State

systemData