Bookmarks - Get

Service:

Sentinel

API Version:

2024-03-01

Ruft ein Lesezeichen ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
bookmarkId	path	True	string	Lesezeichen-ID
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
workspaceName	path	True	string	Den Namen des Arbeitsbereichs Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	Bookmark	OK, Vorgang erfolgreich abgeschlossen
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
Bookmark	Stellt eine Lesezeichen in Azure Security Insights dar.
CloudError	Fehlerantwortstruktur.
CloudErrorBody	Fehlerdetails.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
IncidentInfo	Beschreibt verwandte Incidentinformationen für das Lesezeichen
IncidentSeverity	Schweregrad des Vorfalls
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserInfo	Benutzerinformationen, die eine Aktion ausgeführt haben

Bookmark

Stellt eine Lesezeichen in Azure Security Insights dar.

Name	Typ	Beschreibung
etag	string	Etag der Azure-Ressource
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.created	string	Der Zeitpunkt, zu dem das Lesezeichen erstellt wurde
properties.createdBy	UserInfo	Beschreibt einen Benutzer, der das Lesezeichen erstellt hat.
properties.displayName	string	Der Anzeigename des Lesezeichens
properties.eventTime	string	Die Lesezeichenereigniszeit
properties.incidentInfo	IncidentInfo	Beschreibt einen Vorfall, der sich auf ein Lesezeichen bezieht.
properties.labels	string[]	Liste der Bezeichnungen, die für dieses Lesezeichen relevant sind
properties.notes	string	Die Notizen des Lesezeichens
properties.query	string	Die Abfrage des Lesezeichens.
properties.queryEndTime	string	Endzeit für die Abfrage
properties.queryResult	string	Das Abfrageergebnis des Lesezeichens.
properties.queryStartTime	string	Die Startzeit für die Abfrage
properties.updated	string	Der Zeitpunkt, zu dem das Lesezeichen zuletzt aktualisiert wurde
properties.updatedBy	UserInfo	Beschreibt einen Benutzer, der das Lesezeichen aktualisiert hat.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

CloudError

Fehlerantwortstruktur.

Name	Typ	Beschreibung
error	CloudErrorBody	Fehlerdaten

CloudErrorBody

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

IncidentInfo

Beschreibt verwandte Incidentinformationen für das Lesezeichen

Name	Typ	Beschreibung
incidentId	string	Incident-ID
relationName	string	Beziehungsname
severity	IncidentSeverity	Schweregrad des Vorfalls
title	string	Titel des Vorfalls

IncidentSeverity

Schweregrad des Vorfalls

Name	Typ	Beschreibung
High	string	Hoher Schweregrad
Informational	string	Informationsschweregrad
Low	string	Niedriger Schweregrad
Medium	string	Mittlerer Schweregrad

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserInfo

Benutzerinformationen, die eine Aktion ausgeführt haben

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse des Benutzers.
name	string	Der Name des Benutzers.
objectId	string	Die Objekt-ID des Benutzers.