Watchlists - Get

Référence

Service:: Sentinel

API Version:: 2024-03-01

Obtenez une watchlist, sans ses éléments 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

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.

Réponses

Nom	Type	Description
200 OK	Watchlist	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 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"
  }
}

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
Watchlist	Représente une watchlist dans Azure Security Insights.

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.

Watchlist

Représente une 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.contentType	string	Type de contenu du contenu brut. Pour l’instant, seul le texte/csv est valide
properties.created	string	Heure à laquelle la watchlist a été créée
properties.createdBy	UserInfo	Décrit un utilisateur qui a créé la watchlist
properties.defaultDuration	string	Durée par défaut d’une watchlist (au format de durée ISO 8601)
properties.description	string	Description de la watchlist
properties.displayName	string	Nom complet de la watchlist
properties.isDeleted	boolean	Indicateur qui indique si la watchlist est supprimée ou non
properties.itemsSearchKey	string	La clé de recherche est utilisée pour optimiser les performances des requêtes lors de l’utilisation de watchlists pour les jointures avec d’autres données. Par exemple, activez une colonne avec des adresses IP comme champ SearchKey désigné, puis utilisez ce champ comme champ clé lors de la jointure à d’autres données d’événement par adresse IP.
properties.labels	string[]	Liste des étiquettes pertinentes pour cette watchlist
properties.numberOfLinesToSkip	integer	Nombre de lignes dans un contenu csv à ignorer avant l’en-tête
properties.provider	string	Fournisseur de la watchlist
properties.rawContent	string	Contenu brut qui représente les éléments de watchlist à créer. Exemple : cette ligne sera ignorée header1,header2 value1,value2
properties.source	string	Source de la watchlist. Accepte uniquement « Fichier local » et « Stockage distant ». Et il doit être inclus dans la demande.
properties.tenantId	string	TenantId auquel appartient la watchlist
properties.updated	string	La dernière fois que la watchlist a été mise à jour
properties.updatedBy	UserInfo	Décrit un utilisateur qui a mis à jour la watchlist
properties.uploadStatus	string	La status du chargement de watchlist : New, InProgress ou Complete. Remarque : Lorsqu’un chargement de watchlist status est InProgress, la watchlist ne peut pas être supprimée
properties.watchlistAlias	string	Alias de la watchlist
properties.watchlistId	string	ID (guid) de la watchlist
properties.watchlistType	string	Type de la 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 »

Partager via