Compartilhar via

Get Recommendations - List

Serviço:
Sentinel
Versão da API:
2025-07-01-preview

Obtém uma lista de todas as recomendações.

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 URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.
workspaceName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$

O nome do espaço de trabalho.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

RecommendationList

OK
Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Get Recommendations list.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
        }
      }
    }
  ]
}

Definições

Nome Description
CloudError

Estrutura de resposta de erro.
CloudErrorBody

Detalhes do erro.
createdByType

O tipo de identidade que criou o recurso.
Recommendation

Objeto de recomendação.
RecommendationList

Uma lista de recomendações
RecommendedSuggestion

Quais sugestões devem ser feitas para concluir a recomendação.
State

Estado da recomendação.
systemData

Metadados relativos à criação e última modificação do recurso.

CloudError

Objeto

Estrutura de resposta de erro.

Nome Tipo Description
error

CloudErrorBody

Dados de erro

CloudErrorBody

Objeto

Detalhes do erro.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message

string

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

Recommendation

Objeto

Objeto de recomendação.

Nome Tipo Description
etag

string

Etag do recurso do azure
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

O nome do recurso
properties.additionalProperties

object

Coleção de propriedades adicionais para a recomendação.
properties.creationTimeUtc

string (date-time)

O carimbo de data/hora (UTC) quando a recomendação foi criada.
properties.description

string

Descrição da recomendação.
properties.lastEvaluatedTimeUtc

string (date-time)

O carimbo de data/hora (UTC) quando a recomendação foi avaliada pela última vez.
properties.lastModifiedTimeUtc

string (date-time)

O carimbo de data/hora (UTC) quando a recomendação foi modificada pela última vez.
properties.recommendationTypeId

string

ID do tipo de recomendação.
properties.resourceId

string

ID do recurso ao qual essa recomendação se refere.
properties.state

State

Estado da recomendação.
properties.suggestions

RecommendedSuggestion[]

Lista de sugestões a serem usadas para essa recomendação.
properties.title

string

Título da recomendação.
systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

RecommendationList

Objeto

Uma lista de recomendações

Nome Tipo Description
nextLink

string

Link para a próxima página de recursos.
value

Recommendation[]

Uma lista de recomendações

RecommendedSuggestion

Objeto

Quais sugestões devem ser feitas para concluir a recomendação.

Nome Tipo Description
action

string

Ação da sugestão.
additionalProperties

object

Coleção de propriedades adicionais para a sugestão.
description

string

Descrição da sugestão.
suggestionTypeId

string

ID do tipo de sugestão.
title

string

Título da sugestão.

State

Enumeração

Estado da recomendação.

Valor Description
Active

A recomendação está ativa.
InProgress

A recomendação está em andamento.
Dismissed

A recomendação foi ignorada.
CompletedByUser

A recomendação foi concluída pelo usuário.
CompletedBySystem

A recomendação foi concluída pelo sistema.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.