Exportar a avaliação de configuração segura por dispositivo

Aplica-se a:

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

Devolve todas as configurações e respetivos estado, numa base por dispositivo.

Existem chamadas API diferentes para obter diferentes tipos de dados. Uma vez que a quantidade de dados pode ser grande, existem duas formas de ser recuperada:

  • Exportar resposta JSON de avaliação de configuração segura: A API extrai todos os dados na sua organização como respostas Json. Este método é mais adequado para pequenas organizações com dispositivos com menos de 100 K. A resposta é paginada, @pelo que pode utilizar o campo odata.nextLink da resposta para os resultados próximos.

  • Exportar uma avaliação de configuração segura através de ficheiros: esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável. Portanto, é recomendado para grandes organizações, com mais de 100 K dispositivos. Esta API obtete todos os dados na sua organização à medida que transfere ficheiros. A resposta contém URLs para transferir todos os dados do Azure Armazenamento. Esta API permite-lhe transferir todos os seus dados do Azure Armazenamento da seguinte forma:

    • Ligue para a API para obter uma lista de URLs de transferência com todos os dados da sua organização.

    • Transfira todos os ficheiros com os URLs de transferência e processe os dados como quiser.

Os dados recolhidos (utilizando a resposta JSON ou através de ficheiros ) são o instantâneo atual do estado atual e não contêm dados históricos. Para recolher dados históricos, os clientes têm de guardar os dados nos seus próprios armazenamentos de dados.

Nota

Salvo indicação em contrário, todos os métodos de avaliação de exportação listados são exportados na totalidade e por dispositivo (também referidos por dispositivo).

1. Exportar avaliação de configuração segura (resposta JSON)

1.1 Descrição do método de API

Esta resposta API contém a Avaliação de Configuração Segura nos seus dispositivos expostos e devolve uma entrada para cada combinação exclusiva de DeviceId, ConfigurationId.

1.1.1 Limitações

  • O tamanho máximo da página é 200.000.

  • As limitações de tarifas desta API são de 30 chamadas por minuto e de 1000 chamadas por hora.

1.2 Permissões

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

Tipo de permissão Permissão Nome a apresentar da permissão
Aplicação Vulnerability.Read.All 'Ler informações de vulnerabilidade da Gestão de Ameaças e Vulnerabilidades'
Delegado (conta escolar ou escolar) Vulnerability.Read 'Ler informações de vulnerabilidade da Gestão de Ameaças e Vulnerabilidades'

URL de 1.3

GET /api/machines/SecureConfigurationsAssessmentByMachine

1.4 Parâmetros

  • pageSize (default = 50.000): Número de resultados em resposta.
  • $top: O número de resultados a devolver (não @devolve odata.nextLink e, por isso, não importa todos os dados).

1,5 Propriedades

Nota

  • As propriedades definidas na seguinte tabela são listadas alfabeticamente por ID da propriedade. Ao executar esta API, o resultado resultado não será necessariamente devolvido na mesma ordem apresentada nesta tabela.
  • Poderão ser devolvidas algumas colunas adicionais na resposta. Estas colunas são temporárias e podem ser removidas. Utilize apenas as colunas documentadas.


Propriedade (ID) Tipo de dados Descrição Exemplo de um valor devolvido
ConfigurationCategory cadeia Categoria ou agrupamento ao qual a configuração pertence: Aplicação, SO, Rede, Contas, Controlos de Segurança Controlos de segurança
ConfigurationId cadeia Identificador exclusivo para uma configuração específica scid-10000
ConfigurationImpact cadeia Impacto classificado da configuração para o resultado de configuração geral (1-10) 9
ConfigurationName cadeia Nome a apresentar da configuração Dispositivos móveis para Microsoft Defender para Endpoint
ConfigurationSubcategory cadeia Subcategoria ou subgrupo ao qual a configuração pertence. Em muitos casos, isto descreve funcionalidades ou capacidades específicas. Dispositivos de Iva
DeviceId cadeia Identificador exclusivo do dispositivo no serviço. 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName cadeia Nome de domínio completamente qualificado (FQDN) do dispositivo. johnlaptop.europe.contoso.com
ÉApplicado bool Indica se a configuração ou política é aplicável true
ÉCompliente bool Indica se a configuração ou política está configurada corretamente falso
IsExpectedUserImpact bool Indica se vai haver impacto no utilizador se a configuração for aplicada true
OSPlatform cadeia Plataforma do sistema operativo em execução no dispositivo. Isto indica sistemas operativos específicos, incluindo variações na mesma família, como Windows 10 e Windows 11. Consulte plataformas e sistemas operativos suportados por tvm para obter detalhes. Windows10 e Windows 11
RbacGroupName cadeia O grupo controlo de acesso baseado em funções (RBAC). Se este dispositivo não estiver atribuído a nenhum grupo RBAC, o valor será "Não atribuído". Se a organização não contiver grupos RBAC, o valor será "Nenhum". Servidores
RecomendaçãoReferência cadeia Uma referência ao ID de recomendação relacionado com este software. sca-_-scid-20000
Timestamp cadeia Última vez que a configuração foi vista no dispositivo 2020-11-03 10:13:34.8476880

1.6 Exemplos

1.6.1 Exemplo de pedido

GET https://api.securitycenter.microsoft.com/api/machines/SecureConfigurationsAssessmentByMachine?pageSize=5

1.6.2 Exemplo de resposta

{
    "@odata.context": "api.securitycenter.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetConfiguration)",
    "value": [
        {
            "deviceId": "00013ee62c6b12345b10214e1801b217b50ab455c293d",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_5d96860d69c73fdd06fc8d1679e1eb73eceb8330",
            "osPlatform": "Windows10" "Windows11",
            "osVersion": "NT kernel 6.x",
            "timestamp": "2021-01-11 09:47:58.854",
            "configurationId": "scid-10000",
            "configurationCategory": "Network",
            "configurationSubcategory": "",
            "configurationImpact": 5,
            "isCompliant": true,
            "isApplicable": true,
            "isExpectedUserImpact": false,
            "configurationName": "Disable insecure administration protocol - Telnet",
            "recommendationReference": "sca-_-scid-10000"
        },
        {
            "deviceId": "0002a1be533813b9a8c6de739785365bce7910",
            "rbacGroupName": "hhh",
            "deviceName": null,
            "osPlatform": "Windows10" "Windows11",
            "osVersion": "10.0",
            "timestamp": "2021-01-11 09:47:58.854",
            "configurationId": "scid-20000",
            "configurationCategory": "Security controls",
            "configurationSubcategory": "Onboard Devices",
            "configurationImpact": 9,
            "isCompliant": false,
            "isApplicable": true,
            "isExpectedUserImpact": false,
            "configurationName": "Onboard devices to Microsoft Defender for Endpoint",
            "recommendationReference": "sca-_-scid-20000"
        },
        {
            "deviceId": "0002a1de123456a8c06de736785395d4ce7610",
            "rbacGroupName": "hhh",
            "deviceName": null,
            "osPlatform": "Windows10" "Windows11",
            "osVersion": "10.0",
            "timestamp": "2021-01-11 09:47:58.854",
            "configurationId": "scid-10000",
            "configurationCategory": "Network",
            "configurationSubcategory": "",
            "configurationImpact": 5,
            "isCompliant": true,
            "isApplicable": true,
            "isExpectedUserImpact": false,
            "configurationName": "Disable insecure administration protocol - Telnet",
            "recommendationReference": "sca-_-scid-10000"
        },
        {
            "deviceId": "00044f912345bdaf756492dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18663d45912eed224b2be2f5ea3142726e63f16a.DomainPII_21eeb80b086e76bdfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "osVersion": "10.0.17763.1637",
            "timestamp": "2021-01-11 09:47:58.854",
            "configurationId": "scid-39",
            "configurationCategory": "OS",
            "configurationSubcategory": "",
            "configurationImpact": 5,
            "isCompliant": true,
            "isApplicable": true,
            "isExpectedUserImpact": false,
            "configurationName": "Enable 'Domain member: Digitally sign secure channel data (when possible)'",
            "recommendationReference": "sca-_-scid-39"
        },
        {
            "deviceId": "00044f912345daf759462bde6bd733d6a9c56ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18663b45612eeb224d2de2f5ea3142726e63f16a.DomainPII_21eed80d086e76dbfa178eadfa25e8be9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "osVersion": "10.0.17763.1637",
            "timestamp": "2021-01-11 09:47:58.854",
            "configurationId": "scid-6093",
            "configurationCategory": "Security controls",
            "configurationSubcategory": "Antivirus",
            "configurationImpact": 5,
            "isCompliant": false,
            "isApplicable": false,
            "isExpectedUserImpact": false,
            "configurationName": "Enable Microsoft Defender Antivirus real-time behavior monitoring for Linux",
            "recommendationReference": "sca-_-scid-6093"
        }
    ],
    "@odata.nextLink": "https://api.securitycenter.microsoft.com/api/machines/SecureConfigurationsAssessmentByMachine?pagesize=5&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMS0wMS0xMS8xMTAxLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

2. Exportar uma avaliação de configuração segura (através de ficheiros)

2.1 Descrição do método de API

Esta resposta API contém a Avaliação de Configuração Segura nos seus dispositivos expostos e devolve uma entrada para cada combinação exclusiva de DeviceId, ConfigurationId.

2.1.2 Limitações

As limitações de tarifas desta API são de 5 chamadas por minuto e 20 chamadas por hora.

2.2 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 Microsoft Defender para Endpoint dados para obter detalhes.

Tipo de permissão Permissão Nome a apresentar da permissão
Aplicação Vulnerability.Read.All 'Ler informações de vulnerabilidade "Gestão de Vulnerabilidades e Ameaças"'
Delegado (conta escolar ou escolar) Vulnerability.Read 'Ler informações de vulnerabilidade "Gestão de Vulnerabilidades e Ameaças"'

2.3 URL

GET /api/machines/SecureConfigurationsAssessmentExport

Parâmetros

  • sasValidHours: O número de horas que os URLs de transferência serão válidos durante (máximo de 24 horas).

2.5 Propriedades

Nota

  • Os ficheiros são comprimidos em formato Gzip & formato Json com várias linhas.
  • Os URLs da transferência só são válidos durante 3 horas; Caso contrário, pode utilizar o parâmetro.
  • Para uma velocidade de transferência máxima dos seus dados, pode certificar-se de que está a transferir a partir da mesma região do Azure onde se encontram os seus dados.


Propriedade (ID) Tipo de dados Descrição Exemplo de um valor devolvido
Exportar ficheiros cadeia de[matriz] Uma lista de URLs de transferência de ficheiros com o instantâneo atual da organização ["Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime cadeia A hora em que a exportação foi gerada. 2021-05-20T08:00:00Z

2.6 Exemplos

2.6.1 Exemplo de pedido

GET https://api.securitycenter.microsoft.com/api/machines/SecureConfigurationsAssessmentExport

2.6.2 Exemplo de resposta

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#contoso.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/ScaExport/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00393-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/ScaExport/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/ScaExport/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c001.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=..."
    ],
    "generatedTime": "2021-01-11T11:01:00Z"
}

Consulte também

Outros relacionados