Entities - Get Insights

Referencia

Szolgáltatás:: Sentinel

API-verzió:: 2025-04-01-preview

Elemzések végrehajtása egy entitáshoz.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getInsights?api-version=2025-04-01-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
entityId	path	True	string	entitás azonosítója
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	A munkaterület neve.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
endTime	True	string (date-time)	A befejezési idősor dátuma, így a visszaadott eredmények ennél a dátumnál korábbiak.
startTime	True	string (date-time)	A kezdő ütemterv dátuma, így a visszaadott eredmények ezt a dátumot követik.
addDefaultExtendedTimeRange		boolean	Azt jelzi, hogy a lekérdezés időtartományát ki kell-e terjeszteni a lekérdezés alapértelmezett időtartományával. Az alapértelmezett érték hamis
insightQueryIds		string[] (uuid)	Az Insights lekérdezésazonosítójának listája. Ha üres, az alapértelmezett érték az entitás összes elemzési értéke

Válaszok

Name	Típus	Description
200 OK	EntityGetInsightsResponse	OKÉ
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Entity Insight

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/getInsights?api-version=2025-04-01-preview

{
  "addDefaultExtendedTimeRange": false,
  "startTime": "2021-09-01T00:00:00.000Z",
  "endTime": "2021-10-01T00:00:00.000Z",
  "insightQueryIds": [
    "cae8d0aa-aa45-4d53-8d88-17dd64ffd4e4"
  ]
}

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "tableQueryResults": {
        "columns": [
          {
            "name": "Title",
            "type": "string"
          },
          {
            "name": "NameCount",
            "type": "long"
          },
          {
            "name": "SIDCount",
            "type": "long"
          },
          {
            "name": "InternalOrder",
            "type": "long"
          },
          {
            "name": "Index",
            "type": "long"
          }
        ],
        "rows": [
          [
            "MyTitle",
            "15",
            "SID",
            "1",
            "1"
          ]
        ]
      },
      "chartQueryResults": [
        {
          "columns": [
            {
              "name": "TimeGenerated",
              "type": "datetime"
            },
            {
              "name": "Count",
              "type": "long"
            },
            {
              "name": "Legend",
              "type": "string"
            }
          ],
          "rows": [
            [
              "2021-09-01T00:00:00.000Z",
              "55",
              "SomeLegend"
            ]
          ]
        }
      ],
      "queryTimeInterval": {
        "startTime": "2021-09-01T23:35:20Z",
        "endTime": "2021-09-01T23:35:20Z"
      },
      "queryId": "e29ee1ef-7445-455e-85f1-269f2d536d61"
    }
  ],
  "metaData": {
    "totalCount": 7,
    "errors": [
      {
        "kind": "Insight",
        "queryId": "4a70a63d-25c4-6312-b73e-4f302a90c06a",
        "errorMessage": "Internal server error"
      }
    ]
  }
}

Definíciók

Name	Description
CloudError	Hibaválasz-struktúra.
CloudErrorBody	Hiba részletei.
Columns	A tábla oszlopainak metaadatai
EntityGetInsightsParameters	Az adott entitás elemzési műveletének végrehajtásához szükséges paraméterek.
EntityGetInsightsResponse	A Get Insights eredményműveleti válasza.
EntityInsightItem	Entitáselemzési elem.
GetInsightsError	a lekérdezés típusa
GetInsightsErrorKind	GetInsights-lekérdezési hibák.
GetInsightsResultsMetadata	Insights-eredmények metaadatainak lekérése.
InsightsTableResult	Táblaelemzési lekérdezés lekérdezésének eredményei.
QueryTimeInterval	Az az időintervallum, amelyen a lekérdezés ténylegesen végrehajtva van.

CloudError

Objektum

Hibaválasz-struktúra.

Name	Típus	Description
error	CloudErrorBody	Hibaadatok

CloudErrorBody

Objektum

Hiba részletei.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.

Columns

Objektum

A tábla oszlopainak metaadatai

Name	Típus	Description
name	string	a kolum neve
type	string	a kolum típusa

EntityGetInsightsParameters

Objektum

Az adott entitás elemzési műveletének végrehajtásához szükséges paraméterek.

Name	Típus	Description
addDefaultExtendedTimeRange	boolean	Azt jelzi, hogy a lekérdezés időtartományát ki kell-e terjeszteni a lekérdezés alapértelmezett időtartományával. Az alapértelmezett érték hamis
endTime	string (date-time)	A befejezési idősor dátuma, így a visszaadott eredmények ennél a dátumnál korábbiak.
insightQueryIds	string[] (uuid)	Az Insights lekérdezésazonosítójának listája. Ha üres, az alapértelmezett érték az entitás összes elemzési értéke
startTime	string (date-time)	A kezdő ütemterv dátuma, így a visszaadott eredmények ezt a dátumot követik.

EntityGetInsightsResponse

Objektum

A Get Insights eredményműveleti válasza.

Name	Típus	Description
metaData	GetInsightsResultsMetadata	A get insights művelet eredményeinek metaadatai.
value	EntityInsightItem[]	Az elemzések értékeket eredményeznek.

EntityInsightItem

Objektum

Entitáselemzési elem.

Name	Típus	Description
chartQueryResults	InsightsTableResult[]	Táblaelemzési lekérdezés lekérdezésének eredményei.
queryId	string	Az elemzés lekérdezésazonosítója
queryTimeInterval	QueryTimeInterval	Az az időintervallum, amelyen a lekérdezés ténylegesen végrehajtva van.
tableQueryResults	InsightsTableResult	Táblaelemzési lekérdezés lekérdezésének eredményei.

GetInsightsError

Enumerálás

a lekérdezés típusa

Érték	Description
Insight

GetInsightsErrorKind

Objektum

GetInsights-lekérdezési hibák.

Name	Típus	Description
errorMessage	string	a hibaüzenet
kind	GetInsightsError	a lekérdezés típusa
queryId	string	a lekérdezés azonosítója

GetInsightsResultsMetadata

Objektum

Insights-eredmények metaadatainak lekérése.

Name	Típus	Description
errors	GetInsightsErrorKind[]	a sikertelen lekérdezésekkel kapcsolatos információk
totalCount	integer (int32)	az elemzési kérelemhez talált összes elem

InsightsTableResult

Objektum

Táblaelemzési lekérdezés lekérdezésének eredményei.

Name	Típus	Description
columns	Columns[]	A tábla oszlopainak metaadatai
rows	string[]	A tábla soradatai

QueryTimeInterval

Objektum

Az az időintervallum, amelyen a lekérdezés ténylegesen végrehajtva van.

Name	Típus	Description
endTime	string (date-time)	Elemzési lekérdezés befejezési ideje
startTime	string (date-time)	Elemzési lekérdezés kezdési időpontja

Megosztás a következőn keresztül:

Entities - Get Insights

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Entity Insight

Mintakérelem

Mintaválasz

Definíciók

CloudError

CloudErrorBody

Columns

EntityGetInsightsParameters

EntityGetInsightsResponse

EntityInsightItem

GetInsightsError

GetInsightsErrorKind

GetInsightsResultsMetadata

InsightsTableResult

QueryTimeInterval