Get Recommendations - List

Referens

Tjänst:: Sentinel

API-version:: 2025-01-01-preview

Hämtar en lista över alla rekommendationer.

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-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string uuid	ID för målprenumerationen. Värdet måste vara ett UUID.
workspaceName	path	True	string	Namnet på arbetsytan. Reguljärt uttrycksmönster: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	RecommendationList	OKEJ
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get Recommendations list.

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
CloudError	Felsvarsstruktur.
CloudErrorBody	Felinformation.
createdByType	Den typ av identitet som skapade resursen.
Recommendation	Rekommendationsobjekt.
RecommendationList	En lista över rekommendationer
RecommendedSuggestion	Vilka förslag bör tas för att slutföra rekommendationen.
State	Rekommendationens tillstånd.
systemData	Metadata som rör skapande och senaste ändring av resursen.

CloudError

Felsvarsstruktur.

Name	Typ	Description
error	CloudErrorBody	Feldata

CloudErrorBody

Felinformation.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Recommendation

Rekommendationsobjekt.

Name	Typ	Description
etag	string	Etag för azure-resursen
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.additionalProperties	object	Samling ytterligare egenskaper för rekommendationen.
properties.creationTimeUtc	string	Tidsstämpeln (UTC) när rekommendationen skapades.
properties.description	string	Beskrivning av rekommendationen.
properties.lastEvaluatedTimeUtc	string	Tidsstämpeln (UTC) när rekommendationen senast utvärderades.
properties.lastModifiedTimeUtc	string	Tidsstämpeln (UTC) när rekommendationen senast ändrades.
properties.recommendationTypeId	string	ID för rekommendationstypen.
properties.resourceId	string	ID för resursen som den här rekommendationen refererar till.
properties.state	State	Rekommendationens tillstånd.
properties.suggestions	RecommendedSuggestion[]	Lista över förslag att ta för den här rekommendationen.
properties.title	string	Rekommendationens rubrik.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

RecommendationList

En lista över rekommendationer

Name	Typ	Description
nextLink	string	Länka till nästa sida med resurser.
value	Recommendation[]	En lista över rekommendationer

RecommendedSuggestion

Vilka förslag bör tas för att slutföra rekommendationen.

Name	Typ	Description
action	string	Förslagsåtgärd.
additionalProperties	object	Samling ytterligare egenskaper för förslaget.
description	string	Beskrivning av förslaget.
suggestionTypeId	string	ID för förslagstypen.
title	string	Förslagets rubrik.

State

Rekommendationens tillstånd.

Name	Typ	Description
Active	string	Rekommendationen är aktiv.
CompletedBySystem	string	Rekommendationen har slutförts av systemet.
CompletedByUser	string	Rekommendationen har slutförts av användaren.
Dismissed	string	Rekommendationen har avvisats.
InProgress	string	Rekommendationen pågår.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via