Udostępnij przez

Get Recommendations - List

Usługa:
Sentinel
Wersja interfejsu API:
2025-07-01-preview

Pobiera listę wszystkich zaleceń.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
workspaceName
 path True

string

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

Nazwa obszaru roboczego.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

RecommendationList

OK
Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Get Recommendations list.

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
CloudError

Struktura odpowiedzi na błędy.
CloudErrorBody

Szczegóły błędu.
createdByType

Typ tożsamości, która utworzyła zasób.
Recommendation

Obiekt rekomendacji.
RecommendationList

Lista zaleceń
RecommendedSuggestion

Jakie sugestie należy podjąć, aby ukończyć zalecenie.
State

Stan zalecenia.
systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Objekt

Struktura odpowiedzi na błędy.

Nazwa Typ Opis
error

CloudErrorBody

Dane o błędzie

CloudErrorBody

Objekt

Szczegóły błędu.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość Opis
User
Application
ManagedIdentity
Key

Recommendation

Objekt

Obiekt rekomendacji.

Nazwa Typ Opis
etag

string

Etag zasobu platformy Azure
id

string (arm-id)

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Nazwa zasobu
properties.additionalProperties

object

Kolekcja dodatkowych właściwości rekomendacji.
properties.creationTimeUtc

string (date-time)

Sygnatura czasowa (UTC) utworzona przez zalecenie.
properties.description

string

Opis zalecenia.
properties.lastEvaluatedTimeUtc

string (date-time)

Sygnatura czasowa (UTC), kiedy zalecenie zostało ostatnio ocenione.
properties.lastModifiedTimeUtc

string (date-time)

Sygnatura czasowa (UTC), kiedy zalecenie zostało ostatnio zmodyfikowane.
properties.recommendationTypeId

string

Identyfikator typu zalecenia.
properties.resourceId

string

Identyfikator zasobu, do których odwołuje się to zalecenie.
properties.state

State

Stan zalecenia.
properties.suggestions

RecommendedSuggestion[]

Lista sugestii do wykonania dla tego zalecenia.
properties.title

string

Tytuł zalecenia.
systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

RecommendationList

Objekt

Lista zaleceń

Nazwa Typ Opis
nextLink

string

Łącze do następnej strony zasobów.
value

Recommendation[]

Lista zaleceń

RecommendedSuggestion

Objekt

Jakie sugestie należy podjąć, aby ukończyć zalecenie.

Nazwa Typ Opis
action

string

Akcja sugestii.
additionalProperties

object

Kolekcja dodatkowych właściwości sugestii.
description

string

Opis sugestii.
suggestionTypeId

string

Identyfikator typu sugestii.
title

string

Tytuł sugestii.

State

Wyliczanie

Stan zalecenia.

Wartość Opis
Active

Zalecenie jest aktywne.
InProgress

Zalecenie jest w toku.
Dismissed

Zalecenie zostało odrzucone.
CompletedByUser

Zalecenie zostało ukończone przez użytkownika.
CompletedBySystem

Zalecenie zostało ukończone przez system.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).
createdBy

string

Tożsamość, która utworzyła zasób.
createdByType

createdByType

Typ tożsamości, która utworzyła zasób.
lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.