Exportar inventário de avaliação de hardware e firmware por dispositivo

Artigo
01/22/2025

Aplica-se a:

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

Existem diferentes chamadas à API para obter diferentes tipos de dados. Em geral, cada chamada à API contém os dados necessários para os dispositivos na sua organização.

Resposta JSON 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.
através de ficheiros Esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável. Por isso, é 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. Pode transferir 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 através de "resposta JSON ou através de ficheiros" são a snapshot atual do estado atual. 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 hardware e firmware de exportação listados são de exportação completa e por dispositivo (também referidos como por dispositivo)

1. Exportar avaliação de hardware e firmware (resposta JSON)

1.1 Descrição do método da API

Devolve todas as avaliações de hardware e firmware para todos os dispositivos, numa base por dispositivo. Devolve uma tabela com uma entrada separada para cada combinação exclusiva de deviceId e componentType.

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	Software.Read.All	"Ler informações de software de Gestão de Ameaças e Vulnerabilidades"
Delegado (conta corporativa ou de estudante)	Software.Read	"Ler informações de software de Gestão de Ameaças e Vulnerabilidades"

1,3 URL

GET api/machines/HardwareFirmwareInventoryByMachine

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, por isso, não extrai todos os dados).

1.5 Propriedades (resposta JSON)

Observação

Cada registo tem aproximadamente 1 KB de dados. Deve ter isto em conta ao escolher o parâmetro pageSize correto.

Algumas colunas adicionais podem ser devolvidas na resposta. Estas colunas são temporárias e podem ser removidas. Utilize apenas as colunas documentadas.

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.

Propriedade (ID)	Tipo de dados	Descrição
deviceId	Cadeia de caracteres	Identificador exclusivo do dispositivo no serviço.
rbacGroupId	Int	O ID de grupo do controlo de acesso baseado em funções (RBAC). Se o 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".
rbacGroupName	Cadeia de caracteres	O grupo de controlo de acesso baseado em funções (RBAC). Se o 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".
deviceName	Cadeia de caracteres	Nome de domínio completamente qualificado (FQDN) do dispositivo.
componentType	Cadeia de caracteres	Tipo de componente de hardware ou firmware.
fabricante	Cadeia de caracteres	Fabricante de um componente de hardware ou firmware específico.
componentName	Cadeia de caracteres	Nome de um componente de hardware ou firmware específico.
componentVersion	Cadeia de caracteres	Versão de um componente de hardware ou firmware específico.
additionalFields	Cadeia de caracteres	Informações adicionais sobre os componentes no formato de matriz JSON.

1.6 Exemplo

1.6.1 Exemplo de pedido

GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryByMachine

1.6.2 Exemplo de resposta

      {
        "@odata.context": "https://api-df.securitycenter.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetHardwareFirmware)",
        "value":[
        {
            "deviceId": "49126b9e4a5473b5229c73799e9e55c48668101b",
            "rbacGroupId": 39,
            "rbacGroupName": "testO6343398Gq31",
            "deviceName": "testmachine5",
            "componentType": "Hardware",
            "manufacturer": "razer",
            "componentName": "blade_15_advanced_model_(mid_2021)_-_rz09-0409",
            "componentVersion": "7.04",
            "additionalFields": "{\"SystemSKU\":\"RZ09-0409CE53\",\"BaseBoardManufacturer\":\"Razer\",\"BaseBoardProduct\":\"CH570\",\"BaseBoardVersion\":\"4\",\"DeviceFamily\":\"Workstation\"}"
          }  
        ]  
      },

2. Exportar avaliação de hardware e firmware (através de ficheiros)

Descrição do método da API 2.1

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

Tipo de permissão	Permissão	Nome a apresentar da permissão
Application	Software.Read.All	"Ler informações de software de Gestão de Ameaças e Vulnerabilidades"
Delegado (conta corporativa ou de estudante)	Software.Read	"Ler informações de software de Gestão de Ameaças e Vulnerabilidades"

2.3 URL

GET /api/machines/HardwareFirmwareInventoryExport

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 (resposta JSON)

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 maximizar as velocidades de transferência, certifique-se de que está a transferir os dados da mesma região do Azure onde residem os seus dados.
Cada registo tem aproximadamente 1 KB de dados. Deve ter isto em conta ao escolher o parâmetro pageSize que funciona para si.
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
Exportar ficheiros	Cadeia[matriz]	Uma lista de URLs de transferência para ficheiros que contêm a snapshot atual da organização.
GeneratedTime	DateTime	A hora em que a exportação foi gerada.

2.6 Exemplos

2.6.1 Exemplo de pedido

GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryExport

2.6.2 Exemplo de resposta

    {
        "@odata.context":"https://api-df.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_RbacGroupId=39/part-00999-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=muN8Sq6rVN6bFMtR0u3S5Wzh3D9qNPgN5vpU7lWvULg%3D",
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_RbacGroupId=9/part-00968-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=%2BA0%2B4qOOBCS5E4UenJPbMdLM%2FkbXHnz%2F1pvfSOCq%2F2s%3D",
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_RbacGroupId=9/part-00969-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=sZUgYMwSr5zk6BZvS%2BoYIWlHJWk2oJ7YjiC8R26S1X4%3D"
    ],
    "generatedTime": "2022-07-11T11:01:00Z"

   }

Compartilhar via

Exportar inventário de avaliação de hardware e firmware por dispositivo

1. Exportar avaliação de hardware e firmware (resposta JSON)

1.1 Descrição do método da API

1.1.1 Limitações

1.2 Permissões

1,3 URL

1.4 Parâmetros

1.5 Propriedades (resposta JSON)

1.6 Exemplo

1.6.1 Exemplo de pedido

1.6.2 Exemplo de resposta

2. Exportar avaliação de hardware e firmware (através de ficheiros)

Descrição do método da API 2.1

2.1.1 Limitações

2.2 Permissões

2.3 URL

2.4 Parâmetros

2.5 Propriedades (resposta JSON)

2.6 Exemplos

2.6.1 Exemplo de pedido

2.6.2 Exemplo de resposta

Comentários

Recursos adicionais