Watchlists - Create Or Update
Cree o actualice una lista de reproducción y sus elementos de lista de reproducción (creación masiva, por ejemplo, a través del tipo de contenido text/csv). Para crear una lista de reproducción y sus elementos, debemos llamar a este punto de conexión con propiedades rawContent y contentType.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}?api-version=2024-03-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
watchlist
|
path | True |
string |
Alias de lista de reproducción |
workspace
|
path | True |
string |
El nombre del área de trabajo. Regex pattern: |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
properties.displayName | True |
string |
Nombre para mostrar de la lista de reproducción |
properties.itemsSearchKey | True |
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.provider | True |
string |
Proveedor de la lista de reproducción |
etag |
string |
Etag del recurso de Azure |
|
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 |
Describe un usuario que creó la lista de reproducción. |
||
properties.defaultDuration |
string |
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.isDeleted |
boolean |
Marca que indica si se elimina o no la lista de reproducción. |
|
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.rawContent |
string |
Contenido sin procesar que representa los elementos de 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 |
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 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 |
Identificador (un guid) de la lista de reproducción |
|
properties.watchlistType |
string |
El tipo de la lista de reproducción |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar |
|
201 Created |
Creado |
|
Other Status Codes |
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
Create or update a watchlist and bulk creates watchlist items. |
Create or update a watchlist. |
Create or update a watchlist and bulk creates watchlist items.
Sample Request
PUT 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
{
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"displayName": "High Value Assets Watchlist",
"source": "Local file",
"provider": "Microsoft",
"description": "Watchlist from CSV content",
"numberOfLinesToSkip": 1,
"rawContent": "This line will be skipped\nheader1,header2\nvalue1,value2",
"itemsSearchKey": "header1",
"contentType": "text/csv"
}
}
Sample Response
{
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset",
"name": "highValueAsset",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"type": "Microsoft.SecurityInsights/Watchlists",
"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,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
}
}
{
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset",
"name": "highValueAsset",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"type": "Microsoft.SecurityInsights/Watchlists",
"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,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
}
}
Create or update a watchlist.
Sample Request
PUT 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
{
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"displayName": "High Value Assets Watchlist",
"source": "Local file",
"provider": "Microsoft",
"description": "Watchlist from CSV content",
"itemsSearchKey": "header1"
}
}
Sample Response
{
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset",
"name": "highValueAsset",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"type": "Microsoft.SecurityInsights/Watchlists",
"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,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
}
}
{
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset",
"name": "highValueAsset",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"type": "Microsoft.SecurityInsights/Watchlists",
"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,
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
}
}
Definiciones
Nombre | Description |
---|---|
Cloud |
Estructura de respuesta de error. |
Cloud |
Detalles del error. |
created |
Tipo de identidad que creó el recurso. |
system |
Metadatos relacionados con la creación y la última modificación del recurso. |
User |
Información del usuario que realizó alguna acción |
Watchlist |
Representa una lista de reproducción en Azure Security Insights. |
CloudError
Estructura de respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
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 su presentación 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 |
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 |
Tipo de identidad que modificó por última vez el recurso. |
UserInfo
Información del usuario que realizó alguna acción
Nombre | Tipo | Description |
---|---|---|
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 |
Describe un usuario que creó la lista de reproducción. |
|
properties.defaultDuration |
string |
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 se elimina o no la lista de reproducción. |
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 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 |
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 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 |
Identificador (un guid) de la lista de reproducción |
properties.watchlistType |
string |
El tipo de la lista de reproducción |
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" |