Get Recommendations - List

Servicio:: Sentinel

Versión de la API:: 2025-07-01-preview

Obtiene una lista de todas las recomendaciones.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nombre del área de trabajo.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	RecommendationList	OK
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get Recommendations list.

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
CloudError	Estructura de respuesta de error.
CloudErrorBody	Detalles del error.
createdByType	Tipo de identidad que creó el recurso.
Recommendation	Objeto de recomendación.
RecommendationList	Lista de recomendaciones
RecommendedSuggestion	Qué sugerencias se deben tomar para completar la recomendación.
State	Estado de la recomendación.
systemData	Metadatos relativos a la creación y última modificación del recurso.

CloudError

Object

Estructura de respuesta de error.

Nombre	Tipo	Description
error	CloudErrorBody	Datos de error

CloudErrorBody

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

Recommendation

Object

Objeto de recomendación.

Nombre	Tipo	Description
etag	string	Etag del recurso de Azure
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.additionalProperties	object	Colección de propiedades adicionales para la recomendación.
properties.creationTimeUtc	string (date-time)	Marca de tiempo (UTC) cuando se creó la recomendación.
properties.description	string	Descripción de la recomendación.
properties.lastEvaluatedTimeUtc	string (date-time)	Marca de tiempo (UTC) cuando se evaluó por última vez la recomendación.
properties.lastModifiedTimeUtc	string (date-time)	Marca de tiempo (UTC) cuando se modificó por última vez la recomendación.
properties.recommendationTypeId	string	Identificador del tipo de recomendación.
properties.resourceId	string	Identificador del recurso al que hace referencia esta recomendación.
properties.state	State	Estado de la recomendación.
properties.suggestions	RecommendedSuggestion[]	Lista de sugerencias que se deben tomar para esta recomendación.
properties.title	string	Título de la recomendación.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

RecommendationList

Object

Lista de recomendaciones

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de recursos.
value	Recommendation[]	Una lista de recomendaciones

RecommendedSuggestion

Object

Qué sugerencias se deben tomar para completar la recomendación.

Nombre	Tipo	Description
action	string	Acción de la sugerencia.
additionalProperties	object	Colección de propiedades adicionales para la sugerencia.
description	string	Descripción de la sugerencia.
suggestionTypeId	string	Identificador del tipo de sugerencia.
title	string	Título de la sugerencia.

State

Enumeración

Estado de la recomendación.

Valor	Description
Active	La recomendación está activa.
InProgress	La recomendación está en curso.
Dismissed	Se ha descartado la recomendación.
CompletedByUser	El usuario ha completado la recomendación.
CompletedBySystem	El sistema ha completado la recomendación.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Get Recommendations - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get Recommendations list.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorBody

createdByType

Recommendation

RecommendationList

RecommendedSuggestion

State

systemData