Watchlist Items - Create Or Update

Referencia

Service:: Sentinel

API Version:: 2024-03-01

Crea o actualiza un elemento de lista de reproducción.

PUT 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

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.
watchlistAlias	path	True	string	Alias de la lista de reproducción
watchlistItemId	path	True	string	Identificador de elemento de lista de reproducción (GUID)
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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.itemsKeyValue	True	object	pares clave-valor para un elemento de lista de reproducción
etag		string	Etag del recurso de Azure
properties.created		string	Hora en que se creó el elemento de lista de reproducción
properties.createdBy		UserInfo	Describe un usuario que creó el elemento de lista de reproducción.
properties.entityMapping		object	pares clave-valor para una asignación de entidades de elemento de lista de reproducción
properties.isDeleted		boolean	Marca que indica si el elemento de la lista de reproducción se elimina o no.
properties.tenantId		string	TenantId al que pertenece el elemento de lista de reproducción
properties.updated		string	La última vez que se actualizó el elemento de la lista de reproducción
properties.updatedBy		UserInfo	Describe un usuario que actualizó el elemento de lista de reproducción.
properties.watchlistItemId		string	El identificador (un guid) del elemento de lista de reproducción
properties.watchlistItemType		string	Tipo del elemento de lista de reproducción

Respuestas

Nombre	Tipo	Description
200 OK	WatchlistItem	Aceptar
201 Created	WatchlistItem	Creado
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

Create or update a watchlist item.

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset/watchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842?api-version=2024-03-01

{
  "etag": "0300bf09-0000-0000-0000-5c37296e0000",
  "properties": {
    "itemsKeyValue": {
      "Gateway subnet": "10.0.255.224/27",
      "Web Tier": "10.0.1.0/24",
      "Business tier": "10.0.2.0/24",
      "Data tier": "10.0.2.0/24",
      "Private DMZ in": "10.0.0.0/27",
      "Public DMZ out": "10.0.0.96/27"
    }
  }
}

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/82ba292c-dc97-4dfc-969d-d4dd9e666842",
  "etag": "0300bf09-0000-0000-0000-5c37296e0000",
  "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems",
  "properties": {
    "watchlistItemType": "watchlist-item",
    "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842",
    "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea",
    "isDeleted": false,
    "created": "2020-11-15T04:58:56.0748363+00:00",
    "updated": "2020-11-16T16:05:20+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"
    },
    "itemsKeyValue": {
      "Gateway subnet": "10.0.255.224/27",
      "Web Tier": "10.0.1.0/24",
      "Business tier": "10.0.2.0/24",
      "Data tier": "10.0.2.0/24",
      "Private DMZ in": "10.0.0.0/27",
      "Public DMZ out": "10.0.0.96/27"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842",
  "etag": "0300bf09-0000-0000-0000-5c37296e0000",
  "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems",
  "properties": {
    "watchlistItemType": "watchlist-item",
    "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842",
    "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea",
    "isDeleted": false,
    "created": "2020-11-15T04:58:56.0748363+00:00",
    "updated": "2020-11-16T16:05:20+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"
    },
    "itemsKeyValue": {
      "Gateway subnet": "10.0.255.224/27",
      "Web Tier": "10.0.1.0/24",
      "Business tier": "10.0.2.0/24",
      "Data tier": "10.0.2.0/24",
      "Private DMZ in": "10.0.0.0/27",
      "Public DMZ out": "10.0.0.96/27"
    }
  }
}

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
WatchlistItem	Representa un elemento de lista de reproducción en Azure Security Insights.

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.

WatchlistItem

Representa un elemento de 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.created	string	Hora en que se creó el elemento de lista de reproducción
properties.createdBy	UserInfo	Describe un usuario que creó el elemento de lista de reproducción.
properties.entityMapping	object	pares clave-valor para una asignación de entidades de elemento de lista de reproducción
properties.isDeleted	boolean	Marca que indica si el elemento de la lista de reproducción se elimina o no.
properties.itemsKeyValue	object	pares clave-valor para un elemento de lista de reproducción
properties.tenantId	string	TenantId al que pertenece el elemento de lista de reproducción
properties.updated	string	La última vez que se actualizó el elemento de la lista de reproducción
properties.updatedBy	UserInfo	Describe un usuario que actualizó el elemento de lista de reproducción.
properties.watchlistItemId	string	El identificador (un guid) del elemento de lista de reproducción
properties.watchlistItemType	string	Tipo del elemento de 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"

Share via