Partilhar via


Ponto de extremidade da API do Intune Data Warehouse

Pode utilizar a API do Armazém de Dados do Intune com uma conta com controlos de acesso baseados em funções específicos e credenciais do Microsoft Entra. Em seguida, irá autorizar o cliente REST com o Microsoft Entra ID através do OAuth 2.0. Por fim, irá formar um URL significativo para chamar um recurso do armazém de dados.

Requisitos de credenciais do Microsoft Entra ID e do Intune

A autenticação e autorização baseiam-se nas credenciais do Microsoft Entra e no controlo de acesso baseado em funções (RBAC) do Intune. Todos os administradores globais e administradores de serviços do Intune para o seu inquilino têm acesso ao Armazém de dados por predefinição. Utilize as funções do Intune para fornecer acesso a mais utilizadores ao conceder-lhes acesso ao recurso do armazém de dados do Intune .

Os requisitos para acessar o Intune Data Warehouse (incluindo a API) são:

  • O usuário deve ser um dos:
    • Administrador Global do Microsoft Entra
    • Um administrador de serviços do Intune
    • Utilizador com acesso baseado em funções ao recurso do armazém de dados do Intune
    • Autenticação sem utilizador através da autenticação apenas de aplicação

Importante

Para lhe ser atribuída uma função do Intune e aceder ao Armazém de Dados do Intune, o utilizador tem de ter uma licença do Intune. Para obter mais informações, veja Controlo de acesso baseado em funções (RBAC) com o Microsoft Intune e o licenciamento do Microsoft Intune.

Authorization

O Microsoft Entra ID utiliza o OAuth 2.0 para lhe permitir autorizar o acesso a aplicações Web e APIs Web no seu inquilino do Microsoft Entra. Este guia é independente de linguagem e descreve como enviar e receber mensagens HTTP sem utilizar bibliotecas open source. O fluxo de código de autorização OAuth 2.0 está descrito na secção 4.1 da especificação OAuth 2.0.

Para obter mais informações, consulte Autorizar o acesso a aplicações Web com o OAuth 2.0 e o Microsoft Entra ID.

Estrutura do URL da API

Os pontos finais da API do Armazém de Dados leem as entidades de cada conjunto. A API suporta um verbo GET HTTP e um subconjunto de opções de consulta.

O URL do Intune utiliza o seguinte formato:
https://fef.{location}.manage.microsoft.com/ReportingService/DataWarehouseFEService/{entity-collection}?api-version={api-version}

Observação

No URL acima, substitua {location}, {entity-collection}e {api-version} com base nos detalhes fornecidos na tabela abaixo.

O URL contém os seguintes elementos:

Elemento Exemplo Descrição
localização msua06 O URL base pode ser encontrado ao visualizar o painel API do Armazém de Dados no centro de administração do Microsoft Intune.
coleção de entidades devicePropertyHistories O nome da coleção de entidades OData. Para obter mais informações sobre coleções e entidades no modelo de dados, veja Modelo de Dados.
versão da API beta A versão é a versão da API a aceder. Para obter mais informações, consulte Versão.
maxhistorydays 7 (Opcional) O número máximo de dias do histórico a obter. Este parâmetro pode ser fornecido a qualquer coleção, mas só produzirá efeitos para coleções que incluam dateKey como parte da respetiva propriedade chave. Veja Filtros de Intervalo DateKey para obter mais informações.

Informações da versão da API

Agora, pode utilizar a versão v1.0 do Armazém de Dados do Intune ao definir o parâmetro api-version=v1.0de consulta . As atualizações às coleções no Armazém de Dados são aditivas por natureza e não interrompem os cenários existentes.

Pode experimentar as funcionalidades mais recentes do Armazém de Dados com a versão beta. Para utilizar a versão beta, o URL tem de conter o parâmetro api-version=betade consulta . A versão beta oferece funcionalidades antes de serem disponibilizadas geralmente como um serviço suportado. À medida que o Intune adiciona novas funcionalidades, a versão beta pode alterar o comportamento e os contratos de dados. Qualquer código personalizado ou ferramentas de relatórios dependentes da versão beta podem interromper as atualizações em curso.

Opções de consulta OData

A versão atual suporta os seguintes parâmetros de consulta OData: $filter, $selecte $skip,$top. No $filter, apenas DateKey ou RowLastModifiedDateTimeUTC pode ser suportado quando as colunas são aplicáveis e outras propriedades acionam um pedido incorreto.

Filtros de Intervalo DateKey

DateKey os filtros de intervalo podem ser utilizados para limitar a quantidade de dados a transferir para algumas das coleções com dateKey como uma propriedade chave. O DateKey filtro pode ser utilizado para otimizar o desempenho do serviço ao fornecer o seguinte $filter parâmetro de consulta:

  1. DateKey apenas no , suportando $filteros lt/le/eq/ge/gt operadores e associando-se ao operador andlógico , onde podem ser mapeados para uma data de início e/ou data de fim.
  2. maxhistorydays é fornecido como opção de consulta personalizada.

Exemplos de filtro

Observação

Os exemplos de filtro partem do princípio de que hoje é 21/02/2018.

Filter Otimização do Desempenho Descrição
maxhistorydays=7 Completo Devolver dados com DateKey entre 20180214 e 20180221.
$filter=DateKey eq 20180214 Inteiro Devolver dados com DateKey igual a 20180214.
$filter=DateKey ge 20180214 and DateKey lt 20180221 Inteiro Devolver dados com DateKey entre 20180214 e 20180220.
maxhistorydays=7&$filter=DateKey eq 20180214 Inteiro Devolver dados com DateKey igual a 20180214. maxhistorydays é ignorado.
$filter=RowLastModifiedDateTimeUTC ge 2018-02-21T23:18:51.3277273Z Inteiro Devolver dados com RowLastModifiedDateTimeUTC é maior ou igual a 2018-02-21T23:18:51.3277273Z