Bookmarks - Get

Referencia

Service:: Sentinel

API Version:: 2024-03-01

Obtiene un marcador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}?api-version=2024-03-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
bookmarkId	path	True	string	Id. de marcador
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	El nombre del área de trabajo. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	Bookmark	Correcto, operación completada correctamente
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Get a bookmark.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5?api-version=2024-03-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
  "type": "Microsoft.SecurityInsights/bookmarks",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "displayName": "My bookmark",
    "createdBy": {
      "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
      "email": "john@contoso.com",
      "name": "john doe"
    },
    "updatedBy": {
      "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
      "email": "john@contoso.com",
      "name": "john doe"
    },
    "updated": "2019-01-01T13:15:30Z",
    "created": "2019-01-01T13:15:30Z",
    "notes": "Found a suspicious activity",
    "labels": [
      "Tag1",
      "Tag2"
    ],
    "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)",
    "queryResult": "Security Event query result",
    "incidentInfo": {
      "incidentId": "DDA55F97-170B-40B9-B8ED-CBFD05481E7D",
      "severity": "Low",
      "title": "New case 1",
      "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0018"
    }
  }
}

Definiciones

Nombre	Description
Bookmark	Representa un marcador en Azure Security Insights.
CloudError	Estructura de respuesta de error.
CloudErrorBody	Detalles del error.
createdByType	Tipo de identidad que creó el recurso.
IncidentInfo	Describe información relacionada sobre incidentes para el marcador.
IncidentSeverity	Gravedad del incidente
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
UserInfo	Información del usuario que realizó alguna acción

Bookmark

Representa un marcador en Azure Security Insights.

Nombre	Tipo	Description
etag	string	Etag del recurso de Azure
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.created	string	Hora en que se creó el marcador
properties.createdBy	UserInfo	Describe un usuario que creó el marcador.
properties.displayName	string	Nombre para mostrar del marcador
properties.eventTime	string	Hora del evento de marcador
properties.incidentInfo	IncidentInfo	Describe un incidente relacionado con el marcador.
properties.labels	string[]	Lista de etiquetas relevantes para este marcador
properties.notes	string	Notas del marcador
properties.query	string	Consulta del marcador.
properties.queryEndTime	string	Hora de finalización de la consulta
properties.queryResult	string	Resultado de la consulta del marcador.
properties.queryStartTime	string	Hora de inicio de la consulta
properties.updated	string	La última vez que se actualizó el marcador
properties.updatedBy	UserInfo	Describe un usuario que actualizó el marcador.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

CloudError

Estructura de respuesta de error.

Nombre	Tipo	Description
error	CloudErrorBody	Datos inválidos

CloudErrorBody

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 su presentación en una interfaz de usuario.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IncidentInfo

Describe información relacionada sobre incidentes para el marcador.

Nombre	Tipo	Description
incidentId	string	Identificador de incidente
relationName	string	Nombre de relación
severity	IncidentSeverity	Gravedad del incidente
title	string	Título del incidente

IncidentSeverity

Gravedad del incidente

Nombre	Tipo	Description
High	string	Gravedad alta
Informational	string	Gravedad informativa
Low	string	Low severity
Medium	string	Gravedad media

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserInfo

Información del usuario que realizó alguna acción

Nombre	Tipo	Description
email	string	el correo electrónico del usuario.
name	string	Nombre del usuario.
objectId	string	Identificador de objeto del usuario.