Get Recommendations - List

Referência

Serviço:: Sentinel

Versão da API:: 2025-01-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-01-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	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 um UUID.
workspaceName	path	True	string	O nome do espaço de trabalho. Padrão Regex: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	RecommendationList	OK
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get Recommendations list.

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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

Name	Description
CloudError	Estrutura de resposta a erros.
CloudErrorBody	Detalhes do erro.
createdByType	O tipo de identidade que criou o recurso.
Recommendation	Objeto de recomendação.
RecommendationList	Lista de recomendações
RecommendedSuggestion	Que sugestões devem ser tomadas para completar a recomendação.
State	Estado da recomendação.
systemData	Metadados referentes à criação e última modificação do recurso.

CloudError

Estrutura de resposta a erros.

Name	Tipo	Description
error	CloudErrorBody	Dados de erro

CloudErrorBody

Detalhes do erro.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Recommendation

Objeto de recomendação.

Name	Tipo	Description
etag	string	Etag do recurso azure
id	string	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.additionalProperties	object	Recolha de propriedades adicionais para a recomendação.
properties.creationTimeUtc	string	O carimbo de data/hora (UTC) quando a recomendação foi criada.
properties.description	string	Descrição da recomendação.
properties.lastEvaluatedTimeUtc	string	O carimbo de data/hora (UTC) quando a recomendação foi avaliada pela última vez.
properties.lastModifiedTimeUtc	string	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 a que esta recomendação se refere.
properties.state	State	Estado da recomendação.
properties.suggestions	RecommendedSuggestion[]	Lista de sugestões a ter em conta para esta recomendação.
properties.title	string	Título da recomendação.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

RecommendationList

Lista de recomendações

Name	Tipo	Description
nextLink	string	Link para a próxima página de recursos.
value	Recommendation[]	Uma lista de recomendações

RecommendedSuggestion

Que sugestões devem ser tomadas para completar a recomendação.

Name	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

Estado da recomendação.

Name	Tipo	Description
Active	string	A recomendação está ativa.
CompletedBySystem	string	A recomendação foi completada pelo sistema.
CompletedByUser	string	A recomendação foi concluída pelo utilizador.
Dismissed	string	A recomendação foi rejeitada.
InProgress	string	A recomendação está em curso.

systemData

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

Name	Tipo	Description
createdAt	string	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	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.

Partilhar via