Get Recommendations - List

Riferimento

Servizio:: Sentinel

Versione API:: 2025-01-01-preview

Ottiene un elenco di tutte le raccomandazioni.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
workspaceName	path	True	string	Nome dell'area di lavoro. Criterio di espressione regolare: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	RecommendationList	OK
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get Recommendations list.

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Struttura della risposta di errore.
CloudErrorBody	Dettagli errore.
createdByType	Tipo di identità che ha creato la risorsa.
Recommendation	Oggetto Raccomandazione.
RecommendationList	Elenco di raccomandazioni
RecommendedSuggestion	Quali suggerimenti devono essere presi per completare la raccomandazione.
State	Stato della raccomandazione.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CloudError

Struttura della risposta di errore.

Nome	Tipo	Descrizione
error	CloudErrorBody	Dati degli errori

CloudErrorBody

Dettagli errore.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Recommendation

Oggetto Raccomandazione.

Nome	Tipo	Descrizione
etag	string	Etag della risorsa di Azure
id	string	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.additionalProperties	object	Raccolta di proprietà aggiuntive per la raccomandazione.
properties.creationTimeUtc	string	Timestamp (UTC) al momento della creazione della raccomandazione.
properties.description	string	Descrizione della raccomandazione.
properties.lastEvaluatedTimeUtc	string	Timestamp (UTC) dell'ultima valutazione della raccomandazione.
properties.lastModifiedTimeUtc	string	Timestamp (UTC) dell'ultima modifica della raccomandazione.
properties.recommendationTypeId	string	ID del tipo di raccomandazione.
properties.resourceId	string	ID della risorsa a cui fa riferimento questa raccomandazione.
properties.state	State	Stato della raccomandazione.
properties.suggestions	RecommendedSuggestion[]	Elenco di suggerimenti da prendere per questa raccomandazione.
properties.title	string	Titolo della raccomandazione.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

RecommendationList

Elenco di raccomandazioni

Nome	Tipo	Descrizione
nextLink	string	Collegarsi alla pagina successiva delle risorse.
value	Recommendation[]	Elenco di raccomandazioni

RecommendedSuggestion

Quali suggerimenti devono essere presi per completare la raccomandazione.

Nome	Tipo	Descrizione
action	string	Azione del suggerimento.
additionalProperties	object	Raccolta di proprietà aggiuntive per il suggerimento.
description	string	Descrizione del suggerimento.
suggestionTypeId	string	ID del tipo di suggerimento.
title	string	Titolo del suggerimento.

State

Stato della raccomandazione.

Nome	Tipo	Descrizione
Active	string	La raccomandazione è attiva.
CompletedBySystem	string	La raccomandazione è stata completata dal sistema.
CompletedByUser	string	La raccomandazione è stata completata dall'utente.
Dismissed	string	La raccomandazione è stata ignorata.
InProgress	string	La raccomandazione è in corso.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite