Adicionar, atualizar ou eliminar uma definição de análise

Artigo
05/03/2024

Aplica-se a:

Quer experimentar o Microsoft Defender para Ponto Final? Inscrever-se para uma avaliação gratuita.

Quer experimentar Gestão de vulnerabilidades do Microsoft Defender? Saiba mais sobre como se pode inscrever na Gestão de vulnerabilidades do Microsoft Defender avaliação de pré-visualização pública.

Importante

Algumas informações neste artigo estão relacionadas com um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado comercialmente. A Microsoft não concede garantias, expressas ou implícitas, relativamente às informações aqui fornecidas.

Nota

Se for um cliente do Us Government, utilize os URIs listados no Microsoft Defender para Endpoint para clientes do Us Government.

Sugestão

Para um melhor desempenho, pode utilizar o servidor mais próximo da localização geográfica:

us.api.security.microsoft.com
eu.api.security.microsoft.com
uk.api.security.microsoft.com
au.api.security.microsoft.com
swa.api.security.microsoft.com

Descrição da API

API para adicionar, atualizar ou eliminar uma análise autenticada.

Limitações

As limitações de taxa para esta API são 100 chamadas por minuto e 1500 chamadas por hora.

Pode publicar em computadores vistos pela última vez de acordo com o período de retenção configurado.

Permissões

É necessária uma das seguintes permissões para chamar esta API. Para saber mais, incluindo como escolher permissões, veja Utilizar as APIs do Defender para Endpoint.

Tipo de permissão	Permissão	Nome a apresentar da permissão
Aplicação	Machine.ReadWrite.All	Leia e escreva todas as informações de análise.
Delegado (conta escolar ou profissional)	Machine.Read.Write	Leia e escreva todas as informações de análise.

Nota

Ao obter um token com credenciais de utilizador:

Para ver os dados, o utilizador tem de ter, pelo menos, a seguinte permissão de função: ViewData ou TvmViewData (Consulte Create e gerir funções para obter mais informações)
Para editar dados, o utilizador tem de ter, pelo menos, a seguinte permissão de função: ManageSecurity (Consulte Create e gerir funções para obter mais informações)

Pedido HTTP

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions

Cabeçalhos de pedido

Name	Tipo	Descrição
Autorização	Cadeia	Portador {token}. Obrigatório.
Tipo de Conteúdo	cadeia	application/json. Obrigatório.

Corpo do pedido

No corpo do pedido, forneça um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Descrição
scanType	Enumeração	O tipo de análise. Os valores possíveis são: "Windows", "Rede". Obrigatório.
scanName	Cadeia	Nome da análise. Obrigatório.
isActive	Booleano	Estado de se a análise está a ser executada ativamente. Obrigatório.
destino	Cadeia	Uma lista separada por vírgulas de destinos a analisar, endereços IP ou nomes de anfitrião. Obrigatório.
intervalInHours	Int	O intervalo no qual a análise é executada. Obrigatório.
targetType	Cadeia	O tipo de destino no campo de destino. Os tipos possíveis são "Endereço IP" ou "Nome do anfitrião". O valor predefinido é Endereço IP. Obrigatório.
scannerAgent	Objeto	ID do computador. Obrigatório.
scanAuthenticationParams	Objeto	Um objeto que representa os parâmetros de autenticação, veja Propriedades de objetos de parâmetros de autenticação para campos esperados. Esta propriedade é obrigatória ao criar uma nova análise e é opcional ao atualizar uma análise.

Resposta

Se for bem-sucedido, este método devolve o código de resposta 200 - Ok e a definição de análise nova ou atualizada no corpo da resposta.

Pedido de exemplo para adicionar uma nova análise

Eis um exemplo de um pedido que adiciona uma nova análise.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions

 {
"scanType": "Windows", 
"scanName": "Test Windows scan", 
"isActive": true, 
"target": "127.0.0.1", 
"intervalInHours": 1, 
"targetType": "Ip",
"scannerAgent": {
    "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
},
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
}

Resposta de exemplo

Eis um exemplo da resposta.

 {
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity",
    "id": "289224fb-1686-472c-9751-5555960854ca",
    "scanType": "Windows",
    "scanName": "Test Windows scan",
    "isActive": true,
    "target": "127.0.0.1",
    "orgId": "0335a792-18d2-424b-aeed-559567054570",
    "intervalInHours": 1,
    "createdBy": "username@test.com",
    "targetType": "Ip",
    "scanAuthenticationParams": null,
    "scannerAgent": {
        "id": "0335a792-18d2-424b-aeed-559567054570_ eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineName": "DESKTOP-TEST",
        "lastSeen": "2023-01-04T09:40:03.2787058Z",
        "assignedApplicationId": "ae4a5cde-b4a1-4b76-8635-458b2cf15752",
        "scannerSoftwareVersion": "7.6.0.0",
        "lastCommandExecutionTimestamp": "2023-01-04T09:33:16Z",
        "mdeClientVersion": "10.8295.22621.1010"
    },
    "latestScan": {
        "status": null,
        "failureReason": null,
        "executionDateTime": null
    }

}

Pedido de exemplo para atualizar uma análise

Eis um exemplo de um pedido que atualiza uma análise.

PATCH  https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/289224fb-1686-472c-9751-5555960854ca

{
"scanName": "Test Update Windows scan", 
"isActive": false, 
"target": "127.0.0.2,127.0.0.3", 
"intervalInHours": 1, 
"targetType": "Ip",
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
 }

Exemplo de resposta