Watchlist Items - List

Référence

Service:: Sentinel

API Version:: 2024-03-01

Obtenez tous les éléments de watchlist.

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
watchlistAlias	path	True	string	Alias watchlist
workspaceName	path	True	string	Nom de l’espace de travail. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$skipToken	query		string	Skiptoken est utilisé uniquement si une opération précédente a retourné un résultat partiel. Si une réponse précédente contient un élément nextLink, la valeur de l’élément nextLink inclut un paramètre skiptoken qui spécifie un point de départ à utiliser pour les appels suivants. Optionnel.

Réponses

Nom	Type	Description
200 OK	WatchlistItemList	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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": {}
      }
    }
  ]
}

Définitions

Nom	Description
CloudError	Structure de réponse d’erreur.
CloudErrorBody	Détails de l’erreur.
createdByType	Type d’identité qui a créé la ressource.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UserInfo	Informations utilisateur ayant effectué une action
WatchlistItem	Représente un élément watchlist dans Azure Security Insights.
WatchlistItemList	Répertorier tous les éléments de watchlist.

CloudError

Structure de réponse d’erreur.

Nom	Type	Description
error	CloudErrorBody	Données d’erreur

CloudErrorBody

Détails de l’erreur.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UserInfo

Informations utilisateur ayant effectué une action

Nom	Type	Description
email	string	L’e-mail de l’utilisateur.
name	string	Nom de l'utilisateur.
objectId	string	ID d’objet de l’utilisateur.

WatchlistItem

Représente un élément watchlist dans Azure Security Insights.

Nom	Type	Description
etag	string	Etag de la ressource Azure
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.created	string	Heure à laquelle l’élément watchlist a été créé
properties.createdBy	UserInfo	Décrit un utilisateur qui a créé l’élément watchlist
properties.entityMapping	object	paires clé-valeur pour un mappage d’entité d’élément watchlist
properties.isDeleted	boolean	Indicateur qui indique si l’élément watchlist est supprimé ou non
properties.itemsKeyValue	object	paires clé-valeur pour un élément watchlist
properties.tenantId	string	TenantId auquel appartient l’élément watchlist
properties.updated	string	La dernière fois que l’élément watchlist a été mis à jour
properties.updatedBy	UserInfo	Décrit un utilisateur qui a mis à jour l’élément watchlist
properties.watchlistItemId	string	ID (guid) de l’élément watchlist
properties.watchlistItemType	string	Type de l’élément watchlist
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

WatchlistItemList

Répertorier tous les éléments de watchlist.

Nom	Type	Description
nextLink	string	URL permettant d’extraire l’ensemble suivant d’éléments watchlist.
value	WatchlistItem[]	Tableau d’éléments watchlist.

Partager via