Bookmarks - Get

Riferimento

Service:: Sentinel

API Version:: 2024-03-01

Ottiene un segnalibro.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
bookmarkId	path	True	string	ID segnalibro
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
workspaceName	path	True	string	Nome dell'area di lavoro. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	Bookmark	OK, operazione completata correttamente
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
Bookmark	Rappresenta un segnalibro in Azure Security Insights.
CloudError	Struttura di risposta degli errori.
CloudErrorBody	Dettagli degli errori.
createdByType	Tipo di identità che ha creato la risorsa.
IncidentInfo	Descrive le informazioni relative agli eventi imprevisti per il segnalibro
IncidentSeverity	Gravità dell'evento imprevisto
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserInfo	Informazioni utente che hanno eseguito un'azione

Bookmark

Rappresenta un segnalibro in Azure Security Insights.

Nome	Tipo	Descrizione
etag	string	Etag della risorsa di Azure
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.created	string	Ora in cui è stato creato il segnalibro
properties.createdBy	UserInfo	Descrive un utente che ha creato il segnalibro
properties.displayName	string	Nome visualizzato del segnalibro
properties.eventTime	string	Ora dell'evento segnalibro
properties.incidentInfo	IncidentInfo	Descrive un evento imprevisto correlato al segnalibro
properties.labels	string[]	Elenco delle etichette rilevanti per questo segnalibro
properties.notes	string	Note del segnalibro
properties.query	string	Query del segnalibro.
properties.queryEndTime	string	Ora di fine della query
properties.queryResult	string	Risultato della query del segnalibro.
properties.queryStartTime	string	Ora di inizio della query
properties.updated	string	Ultima volta che il segnalibro è stato aggiornato
properties.updatedBy	UserInfo	Descrive un utente che ha aggiornato il segnalibro
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createBy e modificateBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

CloudError

Struttura di risposta degli errori.

Nome	Tipo	Descrizione
error	CloudErrorBody	Dati di errore

CloudErrorBody

Dettagli degli errori.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

IncidentInfo

Descrive le informazioni relative agli eventi imprevisti per il segnalibro

Nome	Tipo	Descrizione
incidentId	string	ID evento imprevisto
relationName	string	Nome relazione
severity	IncidentSeverity	Gravità dell'evento imprevisto
title	string	Titolo dell'evento imprevisto

IncidentSeverity

Gravità dell'evento imprevisto

Nome	Tipo	Descrizione
High	string	Gravità alta
Informational	string	Gravità delle informazioni
Low	string	Gravità bassa
Medium	string	Gravità media

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

UserInfo

Informazioni utente che hanno eseguito un'azione

Nome	Tipo	Descrizione
email	string	indirizzo di posta elettronica dell'utente.
name	string	Nome dell'utente.
objectId	string	ID oggetto dell'utente.