Watchlists - List

Referencia

Service:: Sentinel

API Version:: 2024-03-01

Obtener todas las listas de reproducción, sin elementos de la lista de reproducción.

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	El nombre del área de trabajo. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versión de API que se usará para la operación.
$skipToken	query		string	Skiptoken solo se usa si una operación anterior devolvió un resultado parcial. Si una respuesta anterior contiene un elemento nextLink, el valor del elemento nextLink incluirá un parámetro skiptoken que especifica un punto de partida que se usará para las llamadas posteriores. Opcional.

Respuestas

Nombre	Tipo	Description
200 OK	WatchlistList	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
CloudError	Estructura de respuesta de error.
CloudErrorBody	Detalles del error.
createdByType	Tipo de identidad que creó el recurso.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
UserInfo	Información del usuario que realizó alguna acción
Watchlist	Representa una lista de reproducción en Azure Security Insights.
WatchlistList	Enumera todas las listas de reproducción.

CloudError

Estructura de respuesta de error.

Nombre	Tipo	Description
error	CloudErrorBody	Datos inválidos

CloudErrorBody

Detalles del error.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserInfo

Información del usuario que realizó alguna acción

Nombre	Tipo	Description
email	string	el correo electrónico del usuario.
name	string	Nombre del usuario.
objectId	string	Identificador de objeto del usuario.

Watchlist

Representa una lista de reproducción en Azure Security Insights.

Nombre	Tipo	Description
etag	string	Etag del recurso de Azure
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.contentType	string	Tipo de contenido del contenido sin procesar. Por ahora, solo text/csv es válido
properties.created	string	Hora en que se creó la lista de reproducción
properties.createdBy	UserInfo	Describe un usuario que creó la lista de reproducción.
properties.defaultDuration	string	La duración predeterminada de una lista de reproducción (en formato de duración ISO 8601)
properties.description	string	Descripción de la lista de reproducción
properties.displayName	string	Nombre para mostrar de la lista de reproducción
properties.isDeleted	boolean	Marca que indica si la lista de reproducción se elimina o no.
properties.itemsSearchKey	string	La clave de búsqueda se usa para optimizar el rendimiento de las consultas al usar listas de reproducción para combinaciones con otros datos. Por ejemplo, habilite una columna con direcciones IP para que sea el campo SearchKey designado y, a continuación, use este campo como campo clave al unirse a otros datos de eventos por dirección IP.
properties.labels	string[]	Lista de etiquetas relevantes para esta lista de reproducción
properties.numberOfLinesToSkip	integer	Número de líneas de un contenido csv que se omitirá antes del encabezado.
properties.provider	string	Proveedor de la lista de reproducción
properties.rawContent	string	Contenido sin procesar que representa los elementos de la lista de reproducción que se van a crear. Ejemplo: esta línea se omitirá header1,header2 value1,value2
properties.source	string	Origen de la lista de reproducción. Solo acepta "Archivo local" y "Almacenamiento remoto". Y debe incluirse en la solicitud.
properties.tenantId	string	TenantId al que pertenece la lista de reproducción.
properties.updated	string	La última vez que se actualizó la lista de reproducción
properties.updatedBy	UserInfo	Describe un usuario que actualizó la lista de reproducción.
properties.uploadStatus	string	Estado de la carga de la lista de reproducción: Nuevo, InProgress o Completado. Nota : Cuando un estado de carga de la lista de reproducción es InProgress, no se puede eliminar la lista de reproducción
properties.watchlistAlias	string	Alias de la lista de reproducción
properties.watchlistId	string	El identificador (un guid) de la lista de reproducción
properties.watchlistType	string	Tipo de la lista de reproducción
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WatchlistList

Enumera todas las listas de reproducción.

Nombre	Tipo	Description
nextLink	string	Dirección URL para capturar el siguiente conjunto de listas de reproducción.
value	Watchlist[]	Matriz de listas de reproducción.

Compartir a través de