Compartilhar via

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

  • Artigo

Aplica-se a:

Quer experimentar Gerenciamento de Vulnerabilidades do Microsoft Defender? Saiba mais sobre como você pode se inscrever no Gerenciamento de Vulnerabilidades do Microsoft Defender avaliação de visualização pública.

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

  • Resposta JSON A API puxa todos os dados em sua organização como respostas JSON. Esse método é melhor para organizações pequenas com menos de 100 K dispositivos. A resposta é paginada, para que você possa usar o campo @odata.nextLink da resposta para buscar os próximos resultados.

  • por meio de arquivos Essa solução de API permite extrair quantidades maiores de dados de forma mais rápida e confiável. Portanto, é recomendável para organizações grandes, com mais de 100 K dispositivos. Essa API puxa todos os dados em sua organização como arquivos de download. A resposta contém URLs para baixar todos os dados do Armazenamento do Azure. Você pode baixar dados do Armazenamento do Azure da seguinte maneira:

    • Chame a API para obter uma lista de URLs de download com todos os dados da organização.
    • Baixe todos os arquivos usando as URLs de download e processe os dados como quiser.

Os dados coletados usando 'resposta JSON ou por meio de arquivos' são os instantâneo atuais do estado atual. Ele não contém dados históricos. Para coletar dados históricos, os clientes devem salvar os dados em seus próprios armazenamentos de dados.

Observação

A menos que indicado caso contrário, todos os métodos de avaliação de hardware e firmware de exportação listados são exportação completa e por dispositivo (também conhecido como por dispositivo)

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

1.1 Descrição do método de API

Retorna todas as avaliações de hardware e firmware para todos os dispositivos, por dispositivo. Ele retorna 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 é de 200.000.
  • As limitações de taxa para essa 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, consulte Usar APIs Microsoft Defender para Ponto de Extremidade para obter detalhes.

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

1.3 URL

GET api/machines/HardwareFirmwareInventoryByMachine

1.4 Parâmetros

  • pageSize (padrão = 50.000): número de resultados em resposta.
  • $top: número de resultados a serem retornados (não retorna @odata.nextLink e, portanto, não puxa todos os dados).

1.5 Propriedades (resposta JSON)

Observação

Cada registro tem aproximadamente 1 KB de dados. Você deve levar isso em conta ao escolher o parâmetro pageSize correto.

Algumas colunas adicionais podem ser retornadas na resposta. Essas colunas são temporárias e podem ser removidas. Use apenas as colunas documentadas.

As propriedades definidas na tabela a seguir são listadas em ordem alfabética por ID da propriedade. Ao executar essa API, a saída resultante não será necessariamente retornada na mesma ordem listada nesta tabela.

Propriedade (ID) Tipo de dados Descrição
deviceId Cadeia de caracteres Identificador exclusivo para o dispositivo no serviço.
rbacGroupId Int A ID do grupo RBAC (controle de acesso baseado em função). Se o dispositivo não for 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 RBAC (controle de acesso baseado em função). Se o dispositivo não for 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 FQDN (nome de domínio totalmente qualificado) 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.

Exemplo 1.6

1.6.1 Exemplo de solicitação

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 (por meio de arquivos)

Descrição do método de API 2.1

Retorna todas as avaliações de hardware e firmware para todos os dispositivos, por dispositivo. Ele retorna uma tabela com uma entrada separada para cada combinação exclusiva de DeviceId, ComponentType e ComponentName.

Limitações 2.1.1

  • As limitações de taxa para essa 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, consulte Usar APIs Microsoft Defender para Ponto de Extremidade para obter detalhes.

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

2.3 URL

GET /api/machines/HardwareFirmwareInventoryExport

Parâmetros 2.4

  • sasValidHours: o número de horas para o qual as URLs de download serão válidas (no máximo 24 horas).

2.5 Propriedades (resposta JSON)

Observação

Os arquivos são compactados gzip & no formato Json multiline.

As URLs de download são válidas apenas por 3 horas; caso contrário, você pode usar o parâmetro.

Para maximizar as velocidades de download, verifique se você está baixando os dados da mesma região do Azure em que seus dados residem.

Cada registro é aproximadamente 1KB de dados. Você deve levar isso em conta ao escolher o parâmetro pageSize que funciona para você.

Algumas colunas adicionais podem ser retornadas na resposta. Essas colunas são temporárias e podem ser removidas. Use apenas as colunas documentadas.

Propriedade (ID) Tipo de dados Descrição
Exportar arquivos String[array] Uma lista de URLs de download para arquivos que contêm o instantâneo atual da organização.
GeneratedTime DateTime O tempo em que a exportação foi gerada.

Exemplo 2.6

2.6.1 Exemplo de solicitação

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

Exemplo de resposta 2.6.2

    {
        "@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"

   }