Obter definições de análise

Artigo
08/14/2024

Aplica-se a:

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

Quer experimentar a Gestão de Vulnerabilidades do Microsoft Defender? Saiba como se inscrever numa avaliação gratuita.

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
ina.api.security.microsoft.com

Descrição da API

Obtém uma lista de todas as definições de análise.

Limitações

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

Permissões

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

Tipo de permissão	Permissão	Nome a apresentar da permissão
Aplicação	Machine.Read.All	Leia todas as informações de análise.
Delegado (conta escolar ou profissional)	Machine.Read.All	Leia 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 Criar e gerir funções para obter mais informações)

Pedido HTTP

GET /api/DeviceAuthenticatedScanDefinitions

Cabeçalhos de pedido

Name	Tipo	Descrição
Autorização	Cadeia	Portador {token}. Obrigatório.

Corpo do pedido

Vazio

Resposta

Se for bem-sucedido, este método devolve o código de resposta 200 - OK com uma lista de definições de análise autenticadas.

Exemplos:

Exemplo de pedido

Eis um exemplo do pedido.

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

Exemplo de resposta

Eis um exemplo da resposta.

{
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#DeviceAuthenticatedScanDefinitions",
    "value": [
    {
    "id": "60c4vv57-asdf-3454-a456-2e45t9d79ec9d",
    "scanType": "Windows",
    "scanName": "Test Windows scan",
    "isActive": true,
    "target": "127.0.0.1",
    "orgId": "47d21a0c-cccd-45d3-bffa-a93dbc0bfcaa",
    "intervalInHours": 1,
    "createdBy": "test@contoso.com",
    "targetType": "Ip",
    "scanAuthenticationParams": {
        "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams",
        "type": "Kerberos",
        "username": "username",
        "domain": "password",
        "isGmsaUser": true
        },
    "scannerAgent": {
        "id": "47d41a0c-xxx-46d3-bbea-93dbc0bfcaa_1bc268a79eedf14c4b90f77",
        "machineId": "eb663asadf345dfg4bc268a79eedf14c4b90f77",
        "machineName": "DESKTOP-TEST",
        "lastSeen": "2021-12-19T20:29:04.8242449Z",
        "AssignedApplicationId": "9E0FA0EB-0A51-4357-9C87-C21BFBE07571",
        "ScannerSoftwareVersion": "7.1.1",
        "LastCommandExecutionTimestamp": "2021-12-19T20:29:04.8242449Z",
        "mdeClientVersion": "10.8295.22621.1195"
        },
    "latestScan": {
        "status": "Fail",
        "failureReason": null,
        "executionDateTime": "2021-12-19T20:06:55.2295854Z"
       },
    {
    "id": "60c4aa57-ioi3-1290-7ff6-09fr14792a92",
    "scanType": "Network",
    "scanName": "Network-test-scan",
    "isActive": true,
    "target": "127.0.0.1",
    "orgId": "asdf781a0c-792d-46d3-bbea-a93dbc0bfcaa",
    "intervalInHours": 1,
    "createdBy": "test@contoso.com",
    "targetType": "Ip",
    "scanAuthenticationParams": {
    "@odata.type": "#microsoft.windowsDefenderATP.api.SnmpAuthParams"",
        type": "AuthPriv",
        "username": "username",
        "authProtocol": "authProtocol",
        "authPassword": "authPassword",
        "privProtocol": "privProtocol",
        "privPassword": "privPassword",
        "communityString": "community-string"
            },
    "scannerAgent": {
        "id": "4asdff0c-3344-46d3-bxxe-a9334rtgfcaa_eb6df89dfdf9032f61eedf14c4b90f77",
        "machineId": "eb663a27676kjhj61bc268a79eedf14c4t78u7",
        "machineName": "DESKTOP-Test",
        "lastSeen": "2022-12-21T14:34:19.5698988Z",
        "AssignedApplicationId": "9E0FA0EB-0A51-4357-9C87-C21BFBE07571",
        "ScannerSoftwareVersion": "7.1.1",
        "LastCommandExecutionTimestamp": "2022-12-21T14:34:19.5698988Z",
        "mdeClientVersion": "10.8295.22621.1195"
                },
    "latestScan": {
    "status": "Fail",
    "failureReason": null,
    "executionDateTime": "2022-12-21T14:35:55.6702703Z"
        }
    },
     }
    ]
}