Watchlist Items - Get

Service:

Sentinel

API Version:

2024-03-01

Rufen Sie ein Watchlistelement ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
watchlistAlias	path	True	string	Der Watchlistalias
watchlistItemId	path	True	string	Die Id des Watchlistelements (GUID)
workspaceName	path	True	string	Den Namen des Arbeitsbereichs Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	WatchlistItem	OK
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get a watchlist item.

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/3f8901fe-63d9-4875-9ad5-9fb3b8105797?api-version=2024-03-01

Sample Response

Status code:

200

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

Definitionen

Name	Beschreibung
CloudError	Fehlerantwortstruktur.
CloudErrorBody	Fehlerdetails.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserInfo	Benutzerinformationen, die eine Aktion ausgeführt haben
WatchlistItem	Stellt ein Watchlist-Element in Azure Security Insights dar.

CloudError

Fehlerantwortstruktur.

Name	Typ	Beschreibung
error	CloudErrorBody	Fehlerdaten

CloudErrorBody

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserInfo

Benutzerinformationen, die eine Aktion ausgeführt haben

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse des Benutzers.
name	string	Der Name des Benutzers.
objectId	string	Die Objekt-ID des Benutzers.

WatchlistItem

Stellt ein Watchlist-Element in Azure Security Insights dar.

Name	Typ	Beschreibung
etag	string	Etag der Azure-Ressource
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.created	string	Der Zeitpunkt, zu dem das Watchlistelement erstellt wurde
properties.createdBy	UserInfo	Beschreibt einen Benutzer, der das Watchlistelement erstellt hat.
properties.entityMapping	object	Schlüssel-Wert-Paare für eine Entitätszuordnung von Watchlistelementen
properties.isDeleted	boolean	Ein Flag, das angibt, ob das Watchlistelement gelöscht wurde oder nicht
properties.itemsKeyValue	object	Schlüssel-Wert-Paare für ein Watchlistelement
properties.tenantId	string	Die tenantId, zu der das Watchlistelement gehört
properties.updated	string	Das letzte Mal, wenn das Watchlistelement aktualisiert wurde
properties.updatedBy	UserInfo	Beschreibt einen Benutzer, der das Watchlistelement aktualisiert hat.
properties.watchlistItemId	string	Die ID (guid) des Watchlistelements
properties.watchlistItemType	string	Der Typ des Watchlistelements
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"