Exportar avaliação de configuração segura por dispositivo
Aplica-se a:
- Plano 1 do Microsoft Defender para Ponto de Extremidade
- Plano 2 do Microsoft Defender para Ponto de Extremidade
- Gerenciamento de Vulnerabilidades do Microsoft Defender
- Microsoft Defender XDR
Deseja experimentar o Microsoft Defender para Ponto de Extremidade? Inscreva-se para uma avaliação gratuita.
Devolve todas as configurações e os respetivos status, por dispositivo.
Existem diferentes chamadas à API para obter diferentes tipos de dados. Uma vez que a quantidade de dados pode ser grande, existem duas formas de os obter:
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 é melhor para pequenas organizações com menos de 100 K dispositivos. A resposta é paginada, pelo que pode utilizar o campo @odata.nextLink da resposta para obter os resultados seguintes.
Exportar a 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. Por conseguinte, é recomendado para grandes organizações, com mais de 100 K dispositivos. Esta API extrai todos os dados na sua organização como ficheiros de transferência. A resposta contém URLs para transferir todos os dados do Armazenamento do Azure. Esta API permite-lhe transferir todos os seus dados do Armazenamento do Azure da seguinte forma:
Chame 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 conforme quiser.
Os dados recolhidos (utilizando a resposta JSON ou através de ficheiros) são a snapshot 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.
Observação
Salvo indicação em contrário, todos os métodos de avaliação de exportação listados são de exportação completa e por dispositivo (também referidos como por dispositivo).
1. Exportar avaliação de configuração segura (resposta JSON)
1.1 Descrição do método da API
Esta resposta da 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 taxa para esta API são 30 chamadas por minuto e 1000 chamadas por hora.
1.2 Permissões
Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, veja Utilizar Microsoft Defender para Ponto de Extremidade APIs para obter detalhes.
Tipo de permissão | Permissão | Nome a apresentar da permissão |
---|---|---|
Application | Vulnerability.Read.All | "Ler informações sobre vulnerabilidades da Gestão de Ameaças e Vulnerabilidades" |
Delegado (conta corporativa ou de estudante) | Vulnerabilidade.Leitura | "Ler informações sobre vulnerabilidades da Gestão de Ameaças e Vulnerabilidades" |
1,3 URL
GET /api/machines/SecureConfigurationsAssessmentByMachine
1.4 Parâmetros
- pageSize (predefinição = 50 000): número de resultados em resposta.
- $top: número de resultados a devolver (não devolve @odata.nextLink e, portanto, não extrai todos os dados).
1.5 Propriedades
Observação
- As propriedades definidas na tabela seguinte são listadas alfabeticamente, por ID de propriedade. Ao executar esta API, o resultado resultante não será necessariamente devolvido pela mesma ordem listada nesta tabela.
- Algumas colunas adicionais podem ser devolvidas 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 | string | Categoria ou agrupamento ao qual a configuração pertence: aplicativo, sistema operacional, rede, contas, controles de segurança | Controles de segurança |
ConfigurationId | string | Identificador exclusivo para uma configuração específica | scid-10000 |
ConfigurationImpact | string | Impacto avaliado da configuração na classificação total (1-10) | 9 |
ConfigurationName | string | Exibir o nome da configuração | Dispositivos integrados ao Microsoft Defender para Ponto de Extremidade |
ConfigurationSubcategory | string | Subcategoria ou subgrupo ao qual a configuração pertence. Em muitos casos, isso descreve capacidades ou recursos específicos. | Integrar Dispositivos |
DeviceId | cadeia de caracteres | Identificador exclusivo do dispositivo no serviço. | 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1 |
DeviceName | string | Nome de domínio completamente qualificado (FQDN) do dispositivo. | johnlaptop.europe.contoso.com |
IsApplicable | bool | Indica se a configuração ou a política é aplicável | verdadeiro |
IsCompliant | bool | Indica se a configuração ou política está configurada corretamente | falso |
IsExpectedUserImpact | bool | Indica se haverá impacto do utilizador se a configuração será aplicada | verdadeiro |
OSPlatform | cadeia de caracteres | Plataforma do sistema operativo em execução no dispositivo. Isto indica sistemas operativos específicos, incluindo variações dentro da mesma família, como Windows 10 e Windows 11. Veja Gerenciamento de Vulnerabilidades do Microsoft Defender (MDVM) suportadas sistemas operativos e plataformas para obter detalhes. | Windows10 e Windows 11 |
RbacGroupName | cadeia de caracteres | O grupo de 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 nenhum grupo RBAC, o valor será "Nenhum". | Servidores |
RecommendationReference | cadeia de caracteres | Uma referência ao ID de recomendação relacionado com este software. | sca-_-scid-20000 |
Carimbo de data/hora | cadeia de caracteres | Ú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 avaliação de configuração segura (através de ficheiros)
Descrição do método da API 2.1
Esta resposta da 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.1 Limitações
As limitações de taxa para esta API são 5 chamadas por minuto e 20 chamadas por hora.
2.2 Permissões
Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, veja Utilizar Microsoft Defender para Ponto de Extremidade APIs para obter detalhes.
Tipo de permissão | Permissão | Nome a apresentar da permissão |
---|---|---|
Application | Vulnerability.Read.All | "Ler informações sobre vulnerabilidades da Gestão de Ameaças e Vulnerabilidades" |
Delegado (conta corporativa ou de estudante) | Vulnerabilidade.Leitura | "Ler informações sobre vulnerabilidades da Gestão de Ameaças e Vulnerabilidades" |
2.3 URL
GET /api/machines/SecureConfigurationsAssessmentExport
2.4 Parâmetros
-
sasValidHours
: o número de horas para as quais os URLs de transferência são válidos. O máximo é de 6 horas.
2.5 Propriedades
Observação
- Os ficheiros são comprimidos GZIP & no formato JSON multiline.
- Os URLs de transferência são válidos durante 1 hora, a menos que o
sasValidHours
parâmetro seja utilizado. - Para obter a velocidade máxima de transferência dos seus dados, pode certificar-se de que está a transferir a partir da mesma região do Azure na qual os seus dados residem.
Propriedade (ID) | Tipo de dados | Descrição | Exemplo de um valor devolvido |
---|---|---|---|
Exportar ficheiros | matriz[cadeia] | Uma lista de URLs de transferência para ficheiros que contêm o snapshot atual da organização | ["Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"] |
GeneratedTime | cadeia de caracteres | 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"
}
Confira também
- Exportar métodos e propriedades de avaliação por dispositivo
- Exportar a avaliação do inventário de software por dispositivo
- Exportar avaliação de vulnerabilidades de software por dispositivo
Outros relacionados
Dica
Você deseja aprender mais? Engage com a comunidade de Segurança da Microsoft na nossa Comunidade Tecnológica: Microsoft Defender para Ponto de Extremidade Tech Community.