Watchlists - Get

Service:

Sentinel

API Version:

2024-03-01

Ottenere un elenco di controllo, senza i relativi elementi watchlist.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
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.
watchlistAlias	path	True	string	Alias watchlist
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	Watchlist	OK
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 watchlist.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset?api-version=2024-03-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset",
  "name": "highValueAsset",
  "type": "Microsoft.SecurityInsights/Watchlists",
  "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
  "properties": {
    "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
    "displayName": "High Value Assets Watchlist",
    "provider": "Microsoft",
    "source": "Local file",
    "created": "2020-09-28T00:26:54.7746089+00:00",
    "updated": "2020-09-28T00:26:57+00:00",
    "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"
    },
    "description": "Watchlist from CSV content",
    "watchlistType": "watchlist",
    "watchlistAlias": "highValueAsset",
    "itemsSearchKey": "header1",
    "isDeleted": false,
    "labels": [
      "Tag1",
      "Tag2"
    ],
    "defaultDuration": "P1279DT12H30M5S",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
  }
}

Definizioni

Nome	Descrizione
CloudError	Struttura di risposta degli errori.
CloudErrorBody	Dettagli degli errori.
createdByType	Tipo di identità che ha creato la risorsa.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserInfo	Informazioni utente che hanno eseguito un'azione
Watchlist	Rappresenta un elenco di controllo in Azure Security Insights.

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

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.

Watchlist

Rappresenta un elenco di controllo 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.contentType	string	Tipo di contenuto del contenuto non elaborato. Per il momento, solo il testo/csv è valido
properties.created	string	Ora in cui è stato creato l'elenco di controllo
properties.createdBy	UserInfo	Descrive un utente che ha creato l'elenco di controllo
properties.defaultDuration	string	Durata predefinita di un elenco di controllo (in formato di durata ISO 8601)
properties.description	string	Descrizione dell'elenco di controllo
properties.displayName	string	Nome visualizzato dell'elenco di controllo
properties.isDeleted	boolean	Flag che indica se l'elenco di controllo viene eliminato o meno
properties.itemsSearchKey	string	La chiave di ricerca viene usata per ottimizzare le prestazioni delle query quando si usano gli elenchi di controllo per i join con altri dati. Ad esempio, abilitare una colonna con indirizzi IP come campo SearchKey designato, quindi usare questo campo come campo chiave quando si aggiunge ad altri dati dell'evento in base all'indirizzo IP.
properties.labels	string[]	Elenco di etichette rilevanti per questo elenco di controllo
properties.numberOfLinesToSkip	integer	Numero di righe in un contenuto csv da ignorare prima dell'intestazione
properties.provider	string	Provider dell'elenco di controllo
properties.rawContent	string	Contenuto non elaborato che rappresenta per controllare gli elementi da creare. Esempio: questa riga verrà ignorata intestazione1,header2 value1,value2
properties.source	string	Origine dell'elenco di controllo. Accetta solo "File locale" e "Archiviazione remota". E deve essere incluso nella richiesta.
properties.tenantId	string	TenantId in cui appartiene l'elenco di controllo
properties.updated	string	L'ultima volta che l'elenco di controllo è stato aggiornato
properties.updatedBy	UserInfo	Descrive un utente che ha aggiornato l'elenco di controllo
properties.uploadStatus	string	Stato del caricamento Watchlist : Nuovo, InProgress o Complete. Nota : quando lo stato di caricamento watchlist è InProgress, l'elenco di controllo non può essere eliminato
properties.watchlistAlias	string	Alias dell'elenco di controllo
properties.watchlistId	string	ID (guid) dell'elenco di controllo
properties.watchlistType	string	Tipo dell'elenco di controllo
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"