Watchlists - List

Riferimento

Service:: Sentinel

API Version:: 2024-03-01

Ottiene tutte le watchlist, senza elementi watchlist.

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

With optional parameters:

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

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.
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.
$skipToken	query		string	Skiptoken viene usato solo se un'operazione precedente ha restituito un risultato parziale. Se una risposta precedente contiene un elemento nextLink, il valore dell'elemento nextLink includerà un parametro skiptoken che specifica un punto di partenza da usare per le chiamate successive. facoltativo.

Risposte

Nome	Tipo	Descrizione
200 OK	WatchlistList	OK
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui 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 all watchlists.

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?api-version=2024-03-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "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 della risposta di errore.
CloudErrorBody	Dettagli errore.
createdByType	Tipo di identità che ha creato la risorsa.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserInfo	Informazioni sull'utente che hanno eseguito un'azione
Watchlist	Rappresenta un watchlist in Azure Security Insights.
WatchlistList	Elencare tutte le watchlist.

CloudError

Struttura della risposta di errore.

Nome	Tipo	Descrizione
error	CloudErrorBody	Dati degli errori

CloudErrorBody

Dettagli errore.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	string	Messaggio che descrive l'errore, che deve 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 volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UserInfo

Informazioni sull'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 watchlist in Azure Security Insights.

Nome	Tipo	Descrizione
etag	string	Etag della risorsa di Azure
id	string	ID di risorsa completo per la risorsa. Ad esempio - /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 testo/csv è valido
properties.created	string	Ora in cui è stata creata l'elenco di controllo
properties.createdBy	UserInfo	Descrive un utente che ha creato l'elenco di controllo
properties.defaultDuration	string	Durata predefinita di un watchlist (in formato 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 watchlist per join con altri dati. Ad esempio, abilitare una colonna con indirizzi IP come campo SearchKey designato, quindi usare questo campo come campo chiave durante l'unione ad altri dati dell'evento in base all'indirizzo IP.
properties.labels	string[]	Elenco di etichette rilevanti per l'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 gli elementi watchlist da creare. Esempio: questa riga verrà ignorata header1,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 a cui appartiene l'elenco di controllo
properties.updated	string	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: New, InProgress o Complete. Nota : quando lo stato di caricamento di un elenco di controllo è 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	Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WatchlistList

Elencare tutte le watchlist.

Nome	Tipo	Descrizione
nextLink	string	URL per recuperare il set successivo di watchlist.
value	Watchlist[]	Matrice di watchlist.