Watchlist Items - List

Riferimento

Service:: Sentinel

API Version:: 2024-03-01

Ottiene tutti gli elementi dell'elenco di controllo.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems?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/{watchlistAlias}/watchlistItems?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.
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.
$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	WatchlistItemList	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 watchlist Items.

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/fd37d325-7090-47fe-851a-5b5a00c3f576",
      "name": "fd37d325-7090-47fe-851a-5b5a00c3f576",
      "etag": "\"f2089bfa-0000-0d00-0000-601c58b42021\"",
      "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems",
      "properties": {
        "watchlistItemType": "watchlist-item",
        "watchlistItemId": "fd37d325-7090-47fe-851a-5b5a00c3f576",
        "tenantId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797",
        "isDeleted": false,
        "created": "2021-02-04T12:27:32.3783333-08:00",
        "updated": "2021-02-04T12:27:32.3783333-08: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"
        },
        "itemsKeyValue": {
          "Header-1": "v1_1",
          "Header-2": "v1_2",
          "Header-3": "v1_3",
          "Header-4": "v1_4",
          "Header-5": "v1_5"
        },
        "entityMapping": {}
      }
    }
  ]
}

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
WatchlistItem	Rappresenta un elemento Watchlist in Azure Security Insights.
WatchlistItemList	Elencare tutti gli elementi 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.

WatchlistItem

Rappresenta un elemento 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.created	string	Ora di creazione dell'elemento watchlist
properties.createdBy	UserInfo	Descrive un utente che ha creato l'elemento watchlist
properties.entityMapping	object	coppie chiave-valore per un mapping di entità elemento watchlist
properties.isDeleted	boolean	Flag che indica se l'elemento watchlist viene eliminato o meno
properties.itemsKeyValue	object	coppie chiave-valore per un elemento watchlist
properties.tenantId	string	TenantId a cui appartiene l'elemento watchlist
properties.updated	string	Ultima volta che l'elemento watchlist è stato aggiornato
properties.updatedBy	UserInfo	Descrive un utente che ha aggiornato l'elemento watchlist
properties.watchlistItemId	string	ID (guid) dell'elemento watchlist
properties.watchlistItemType	string	Tipo dell'elemento watchlist
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"

WatchlistItemList

Elencare tutti gli elementi watchlist.

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