Ponto de extremidade da API do Intune Data Warehouse

Artigo
12/21/2023

Você pode usar a API Data Warehouse do Intune com uma conta com controles de acesso baseados em função específicos e credenciais de Microsoft Entra. Em seguida, você autorizará seu cliente REST com Microsoft Entra ID usando o OAuth 2.0. Por fim, você formará uma URL significativa para chamar um recurso de data warehouse.

Microsoft Entra requisitos de credencial e ID do Intune

A autenticação e a autorização baseiam-se nas credenciais Microsoft Entra e no RBAC (controle de acesso baseado em função) do Intune. Todos os administradores globais e administradores de serviços do Intune para seu locatário têm acesso ao Data warehouse por padrão. Use funções do Intune para fornecer acesso a mais usuários, dando-lhes acesso ao recurso do data warehouse 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
- Usuário com acesso baseado em função ao recurso de data warehouse do Intune
- Autenticação sem usuário usando autenticação somente aplicativo

Importante

Para receber uma função do Intune e acessar a Data Warehouse do Intune, o usuário deve ter uma licença do Intune. Para obter mais informações, consulte RBAC (controle de acesso baseado em função) com licenciamento de Microsoft Intune e Microsoft Intune.

Authorization

Microsoft Entra ID usa o OAuth 2.0 para permitir que você autorize o acesso a aplicativos Web e APIs Web em seu locatário Microsoft Entra. Este guia é independente de linguagem e descreve como enviar e receber mensagens HTTP sem usar bibliotecas de código aberto. O fluxo de código de autorização do OAuth 2.0 é descrito na seção 4.1 da especificação OAuth 2.0.

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

Estrutura de URL da API

Os pontos de extremidade da API Data Warehouse lêem as entidades de cada conjunto. A API dá suporte a um verbo GET HTTP e a um subconjunto de opções de consulta.

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

Observação

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

A URL contém os seguintes elementos:

Elemento	Exemplo	Descrição
localização	msua06	A URL base pode ser encontrada exibindo a folha Data Warehouse API no centro de administração Microsoft Intune.
entity-collection	devicePropertyHistories	O nome da coleção de entidades OData. Para obter mais informações sobre coleções e entidades no modelo de dados, consulte Modelo de Dados.
api-version	beta	A versão é a versão da API a ser acessada. Para obter mais informações, consulte Versão.
maxhistorydays	7	(Opcional) O número máximo de dias de histórico a ser recuperado. Esse parâmetro pode ser fornecido a qualquer coleção, mas só entrará em vigor para coleções que incluem `dateKey` como parte de sua propriedade chave. Consulte Filtros de Intervalo DateKey para obter mais informações.

Informações de versão da API

Agora você pode usar a versão v1.0 do intune Data Warehouse definindo o parâmetro api-version=v1.0de consulta . Atualizações às coleções no Data Warehouse são de natureza aditiva e não quebram cenários existentes.

Você pode experimentar a funcionalidade mais recente do Data Warehouse usando a versão beta. Para usar a versão beta, sua URL deve conter o parâmetro api-version=betade consulta . A versão beta oferece recursos antes de serem disponibilizados geralmente como um serviço com suporte. À medida que o Intune adiciona novos recursos, a versão beta pode alterar o comportamento e os contratos de dados. Qualquer código personalizado ou ferramentas de relatório dependentes da versão beta pode ser interrompido com atualizações em andamento.

Opções de consulta OData

A versão atual dá suporte aos seguintes parâmetros de consulta OData: $filter, $selecte $top$skip, . No $filter, somente DateKey ou RowLastModifiedDateTimeUTC pode ter suporte quando as colunas são aplicáveis e outras propriedades disparam uma solicitação incorreta.

Filtros de intervalo DateKey

DateKey Os filtros de intervalo podem ser usados para limitar a quantidade de dados a serem baixados para algumas das coleções com dateKey como uma propriedade chave. O DateKey filtro pode ser usado para otimizar o desempenho do serviço fornecendo o seguinte $filter parâmetro de consulta:

DateKey sozinho no $filter, dando suporte aos lt/le/eq/ge/gt operadores e ingressando com o operador andlógico , em que eles podem ser mapeados para uma data de início e/ou data de término.
maxhistorydays é fornecido como opção de consulta personalizada.

Filtrar exemplos