Iot Alerts - List

Referência

Service:: Defender for Cloud

API Version:: 2019-08-01

Listar 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 URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Regex pattern: `^[-\w\._]+$`
solutionName	path	True	string	O nome da solução de Segurança IoT.
subscriptionId	path	True	string	ID de assinatura do Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versão da API para a operação
$limit	query		integer int32	Limitar o número de itens retornados em uma única página
$skipToken	query		string	Ignorar token usado para paginação
alertType	query		string	Filtrar por tipo de alerta
compromisedEntity	query		string	Filtrar por dispositivo comprometido
startTimeUtc<	query		string	Filtrar por startTimeUtc máximo (formato ISO 8601)
startTimeUtc>	query		string	Filtrar por startTimeUtc mínimo (formato ISO 8601)

Respostas

Nome	Tipo	Description
200 OK	IotAlertList	OK
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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
}

Definições

Nome	Description
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
IotAlert	Alerta de IoT
IotAlertList	Lista de alertas de IoT

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

IotAlert

Alerta de IoT

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.alertType	string	O nome do tipo do alerta
properties.compromisedEntity	string	Nome de exibição da entidade main que está sendo relatada
properties.endTimeUtc	string	A hora de término do impacto do alerta (a hora do último evento ou atividade incluído no alerta)
properties.entities	object[]	Uma lista de entidades relacionadas ao alerta
properties.extendedProperties	object	Um recipiente de campos que estende as informações de alerta
properties.startTimeUtc	string	A hora de início do impacto do alerta (a hora do primeiro evento ou atividade incluída no alerta)
properties.systemAlertId	string	Contém o identificador canônico do produto do alerta dentro do escopo de um produto
type	string	Tipo de recurso

IotAlertList

Lista de alertas de IoT

Nome	Tipo	Description
nextLink	string	Quando disponível, siga o URI para obter a próxima página de dados
totalCount	integer	Contagem total de alertas em conformidade com as opções de filtro fornecidas (não afetadas pelo tamanho da página)
value	IotAlert[]	Listar dados