Entities - Get Insights

Referencia

Servicio:: Sentinel

Versión de la API:: 2025-04-01-preview

Ejecute Insights para una entidad.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
entityId	path	True	string	id. de entidad
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nombre del área de trabajo.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
endTime	True	string (date-time)	Fecha de la escala de tiempo de finalización, por lo que los resultados devueltos son anteriores a esta fecha.
startTime	True	string (date-time)	La fecha de la escala de tiempo de inicio, por lo que los resultados devueltos son posteriores a esta fecha.
addDefaultExtendedTimeRange		boolean	Indica si el intervalo de tiempo de consulta debe extenderse con el intervalo de tiempo predeterminado de la consulta. El valor predeterminado es False
insightQueryIds		string[] (uuid)	Lista de identificadores de consulta de Insights. Si está vacío, el valor predeterminado es toda la información de esta entidad.

Respuestas

Nombre	Tipo	Description
200 OK	EntityGetInsightsResponse	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Entity Insight

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
CloudError	Estructura de respuesta de error.
CloudErrorBody	Detalles del error.
Columns	Metadatos de columnas de la tabla
EntityGetInsightsParameters	Los parámetros necesarios para ejecutar la operación insights en la entidad especificada.
EntityGetInsightsResponse	Respuesta de la operación de resultados de Get Insights.
EntityInsightItem	Elemento de información de entidad.
GetInsightsError	el tipo de consulta
GetInsightsErrorKind	Errores de consulta de GetInsights.
GetInsightsResultsMetadata	Obtiene los metadatos de resultados de Insights.
InsightsTableResult	Resultados de la consulta para la consulta de Table Insights.
QueryTimeInterval	Intervalo de tiempo en el que se ejecutó realmente la consulta.

CloudError

Object

Estructura de respuesta de error.

Nombre	Tipo	Description
error	CloudErrorBody	Datos de error

CloudErrorBody

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

Columns

Object

Metadatos de columnas de la tabla

Nombre	Tipo	Description
name	string	el nombre del colum
type	string	el tipo del colum

EntityGetInsightsParameters

Object

Los parámetros necesarios para ejecutar la operación insights en la entidad especificada.

Nombre	Tipo	Description
addDefaultExtendedTimeRange	boolean	Indica si el intervalo de tiempo de consulta debe extenderse con el intervalo de tiempo predeterminado de la consulta. El valor predeterminado es False
endTime	string (date-time)	Fecha de la escala de tiempo de finalización, por lo que los resultados devueltos son anteriores a esta fecha.
insightQueryIds	string[] (uuid)	Lista de identificadores de consulta de Insights. Si está vacío, el valor predeterminado es toda la información de esta entidad.
startTime	string (date-time)	La fecha de la escala de tiempo de inicio, por lo que los resultados devueltos son posteriores a esta fecha.

EntityGetInsightsResponse

Object

Respuesta de la operación de resultados de Get Insights.

Nombre	Tipo	Description
metaData	GetInsightsResultsMetadata	Los metadatos de los resultados de la operación get insights.
value	EntityInsightItem[]	Valores de resultado de la información.

EntityInsightItem

Object

Elemento de información de entidad.

Nombre	Tipo	Description
chartQueryResults	InsightsTableResult[]	Resultados de la consulta para la consulta de Table Insights.
queryId	string	Identificador de consulta de la información
queryTimeInterval	QueryTimeInterval	Intervalo de tiempo en el que se ejecutó realmente la consulta.
tableQueryResults	InsightsTableResult	Resultados de la consulta para la consulta de Table Insights.

GetInsightsError

Enumeración

el tipo de consulta

Valor	Description
Insight

GetInsightsErrorKind

Object

Errores de consulta de GetInsights.

Nombre	Tipo	Description
errorMessage	string	el mensaje de error
kind	GetInsightsError	el tipo de consulta
queryId	string	el identificador de consulta

GetInsightsResultsMetadata

Object

Obtiene los metadatos de resultados de Insights.

Nombre	Tipo	Description
errors	GetInsightsErrorKind[]	información sobre las consultas con errores
totalCount	integer (int32)	el total de elementos encontrados para la solicitud de información

InsightsTableResult

Object

Resultados de la consulta para la consulta de Table Insights.

Nombre	Tipo	Description
columns	Columns[]	Metadatos de columnas de la tabla
rows	string[]	Datos de filas de la tabla

QueryTimeInterval

Object

Intervalo de tiempo en el que se ejecutó realmente la consulta.

Nombre	Tipo	Description
endTime	string (date-time)	Hora de finalización de la consulta de información
startTime	string (date-time)	Hora de inicio de la consulta de información

Compartir a través de

Entities - Get Insights

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Entity Insight

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorBody

Columns

EntityGetInsightsParameters

EntityGetInsightsResponse

EntityInsightItem

GetInsightsError

GetInsightsErrorKind

GetInsightsResultsMetadata

InsightsTableResult

QueryTimeInterval