Iot Alerts - List

Referencia

Service:: Defender for Cloud

API Version:: 2019-08-01

Enumeración de alertas de IoT

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlerts?api-version=2019-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlerts?api-version=2019-08-01&startTimeUtc>={startTimeUtc>}&startTimeUtc<={startTimeUtc<}&alertType={alertType}&compromisedEntity={compromisedEntity}&$limit={$limit}&$skipToken={$skipToken}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción del usuario. El nombre distingue mayúsculas de minúsculas. Regex pattern: `^[-\w\._]+$`
solutionName	path	True	string	Nombre de la solución de seguridad de IoT.
subscriptionId	path	True	string	Identificador de suscripción de Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versión de API para la operación
$limit	query		integer int32	Limitar el número de elementos devueltos en una sola página
$skipToken	query		string	Omitir token usado para la paginación
alertType	query		string	Filtrar por tipo de alerta
compromisedEntity	query		string	Filtrar por dispositivo en peligro
startTimeUtc<	query		string	Filtrar por el valor máximo de startTimeUtc (formato ISO 8601)
startTimeUtc>	query		string	Filtrar por startTimeUtc mínimo (formato ISO 8601)

Respuestas

Nombre	Tipo	Description
200 OK	IotAlertList	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 IoT Alerts

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlerts?api-version=2019-08-01&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&alertType=IoT_PrivilegedContainer&compromisedEntity=device-1&$limit=1

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
      "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
      "type": "Microsoft.Security/iotAlerts",
      "properties": {
        "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
        "compromisedEntity": "device-1",
        "alertType": "IoT_PrivilegedContainer",
        "startTimeUtc": "2020-05-13T06:32:25Z",
        "endTimeUtc": "2020-05-13T06:32:25Z",
        "entities": [
          {
            "$id": "1",
            "CommandLine": "docker run --privileged",
            "Type": "process"
          }
        ],
        "extendedProperties": {
          "CommandLine": "docker run --privileged",
          "User Name": "aUser",
          "UserId": "",
          "ParentProcessId": 1593,
          "DeviceId": "device-1"
        }
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlerts?api-version=2019-08-01&alertType=IoT_PrivilegedContainer&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&compromisedEntity=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8",
  "totalCount": 23
}

Definiciones

Nombre	Description
CloudError	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
CloudErrorBody	Detalle del error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
IotAlert	Alerta de IoT
IotAlertList	Lista de alertas de IoT

CloudError

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
error.code	string	Código de error.
error.details	CloudErrorBody[]	Los detalles del error.
error.message	string	El mensaje de error.
error.target	string	Destino del error.

CloudErrorBody

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	CloudErrorBody[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

IotAlert

Alerta de IoT

Nombre	Tipo	Description
id	string	Id. de recurso
name	string	Nombre del recurso
properties.alertType	string	Nombre de tipo de la alerta
properties.compromisedEntity	string	Nombre para mostrar de la entidad principal en la que se notifica
properties.endTimeUtc	string	La hora de finalización del impacto de la alerta (la hora del último evento o actividad incluida en la alerta)
properties.entities	object[]	Lista de entidades relacionadas con la alerta
properties.extendedProperties	object	Un contenedor de campos que extiende la información de alerta
properties.startTimeUtc	string	La hora de inicio del impacto de la alerta (la hora del primer evento o actividad incluida en la alerta)
properties.systemAlertId	string	Contiene el identificador canónico del producto de la alerta dentro del ámbito de un producto.
type	string	Tipo de recurso

IotAlertList

Lista de alertas de IoT

Nombre	Tipo	Description
nextLink	string	Cuando esté disponible, siga el URI para obtener la siguiente página de datos.
totalCount	integer	Recuento total de alertas que se ajustan a las opciones de filtro especificadas (no afectadas por el tamaño de página)
value	IotAlert[]	Enumerar datos