Get Recommendations - List

Referenz

Dienst:: Sentinel

API-Version:: 2025-01-01-preview

Ruft eine Liste aller Empfehlungen ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string uuid	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceName	path	True	string	Der Name des Arbeitsbereichs. RegEx-Muster: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	RecommendationList	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get Recommendations list.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
CloudError	Fehlerantwortstruktur.
CloudErrorBody	Fehlerdetails.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Recommendation	Empfehlungsobjekt.
RecommendationList	Eine Liste der Empfehlungen
RecommendedSuggestion	Welche Vorschläge sollten ergriffen werden, um die Empfehlung abzuschließen.
State	Stand der Empfehlung.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CloudError

Fehlerantwortstruktur.

Name	Typ	Beschreibung
error	CloudErrorBody	Fehlerdaten

CloudErrorBody

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Recommendation

Empfehlungsobjekt.

Name	Typ	Beschreibung
etag	string	Etag der Azure-Ressource
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.additionalProperties	object	Sammlung zusätzlicher Eigenschaften für die Empfehlung.
properties.creationTimeUtc	string	Der Zeitstempel (UTC), als die Empfehlung erstellt wurde.
properties.description	string	Beschreibung der Empfehlung.
properties.lastEvaluatedTimeUtc	string	Der Zeitstempel (UTC), als die Empfehlung zuletzt ausgewertet wurde.
properties.lastModifiedTimeUtc	string	Der Zeitstempel (UTC), als die Empfehlung zuletzt geändert wurde.
properties.recommendationTypeId	string	ID des Empfehlungstyps.
properties.resourceId	string	Die ID der Ressource, auf die sich diese Empfehlung bezieht.
properties.state	State	Stand der Empfehlung.
properties.suggestions	RecommendedSuggestion[]	Liste der Vorschläge für diese Empfehlung.
properties.title	string	Titel der Empfehlung.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

RecommendationList

Eine Liste der Empfehlungen

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite von Ressourcen.
value	Recommendation[]	Eine Liste der Empfehlungen

RecommendedSuggestion

Welche Vorschläge sollten ergriffen werden, um die Empfehlung abzuschließen.

Name	Typ	Beschreibung
action	string	Aktion des Vorschlags.
additionalProperties	object	Sammlung zusätzlicher Eigenschaften für den Vorschlag.
description	string	Beschreibung des Vorschlags.
suggestionTypeId	string	ID des Vorschlagstyps.
title	string	Titel des Vorschlags.

State

Stand der Empfehlung.

Name	Typ	Beschreibung
Active	string	Empfehlung ist aktiv.
CompletedBySystem	string	Die Empfehlung wurde vom System abgeschlossen.
CompletedByUser	string	Die Empfehlung wurde vom Benutzer abgeschlossen.
Dismissed	string	Empfehlung wurde zurückgewiesen.
InProgress	string	Empfehlung wird ausgeführt.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über