Get Recommendations - List

Reference

Služba:: Sentinel

Verze rozhraní API:: 2025-01-01-preview

Získá seznam všech doporučení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
workspaceName	path	True	string	Název pracovního prostoru. Vzor regulárního výrazu: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	RecommendationList	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get Recommendations list.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
        }
      }
    }
  ]
}

Definice

Name	Description
CloudError	Struktura odpovědi na chybu
CloudErrorBody	Podrobnosti o chybě
createdByType	Typ identity, která prostředek vytvořila.
Recommendation	Objekt doporučení.
RecommendationList	Seznam doporučení
RecommendedSuggestion	Jaké návrhy by se měly provést k dokončení doporučení.
State	Stav doporučení.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Struktura odpovědi na chybu

Name	Typ	Description
error	CloudErrorBody	Data o chybách

CloudErrorBody

Podrobnosti o chybě

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Recommendation

Objekt doporučení.

Name	Typ	Description
etag	string	Označení prostředku Azure
id	string	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.additionalProperties	object	Kolekce dalších vlastností doporučení
properties.creationTimeUtc	string	Časové razítko (UTC) při vytvoření doporučení
properties.description	string	Popis doporučení
properties.lastEvaluatedTimeUtc	string	Časové razítko (UTC) při posledním vyhodnocení doporučení
properties.lastModifiedTimeUtc	string	Časové razítko (UTC) při poslední změně doporučení
properties.recommendationTypeId	string	ID typu doporučení.
properties.resourceId	string	ID prostředku, na který toto doporučení odkazuje.
properties.state	State	Stav doporučení.
properties.suggestions	RecommendedSuggestion[]	Seznam návrhů pro toto doporučení
properties.title	string	Název doporučení
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

RecommendationList

Seznam doporučení

Name	Typ	Description
nextLink	string	Odkaz na další stránku prostředků
value	Recommendation[]	Seznam doporučení

RecommendedSuggestion

Jaké návrhy by se měly provést k dokončení doporučení.

Name	Typ	Description
action	string	Akce návrhu
additionalProperties	object	Kolekce dalších vlastností návrhu
description	string	Popis návrhu
suggestionTypeId	string	ID typu návrhu
title	string	Název návrhu

State

Stav doporučení.

Name	Typ	Description
Active	string	Doporučení je aktivní.
CompletedBySystem	string	Systém dokončil doporučení.
CompletedByUser	string	Doporučení dokončil uživatel.
Dismissed	string	Doporučení bylo zamítnuto.
InProgress	string	Doporučení probíhá.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím