API do Microsoft Intune Data WarehouseMicrosoft Intune Data Warehouse API

Esta página é útil?

A API do Data Warehouse do Intune permite acessar os dados do Intune em um formato legível para o computador para que eles sejam usados em sua ferramenta de análise favorita.The Intune Data Warehouse API lets you access your Intune data in a machine-readable format for use in your favorite analytics tool. Use a API para criar relatórios que fornecem informações sobre seu ambiente móvel da empresa.You can use the API to build reports that provide insight into your enterprise mobile environment. A API usa o protocolo OData, que segue os padrões para:The API uses the OData protocol, which follows standard patterns for:

  • Cabeçalhos de solicitação e respostaRequest and response headers
  • Códigos de statusStatus codes
  • Métodos de HTTPHTTP methods
  • Convenções de URLURL conventions
  • Tipos de mídiaMedia types
  • Formatos de cargaPayload formats
  • Opções de consultaQuery options

O OData (Protocolo Open Data) é uma organização para o Avanço de Padrões de informações estruturadas (OASIS) que define a prática recomendada para criação e consumo de APIs RESTful.The OData (Open Data Protocol) is an Organization for the Advancement of Structured Information Standards (OASIS) standard that defines the best practice for building and consuming RESTful APIs. O Intune Data Warehouse usa a versão 4.0 do OData.The Intune Data Warehouse uses OData version 4.0.

Esta seção de referência fornece uma visão geral dos pontos de extremidade, métodos HTTP com suporte, formatos de carga de retorno e documentação do modelo de dados do Intune Data Warehouse.This reference section provides an overview of endpoints, supported HTTP methods, return payload formats, and documentation of the Intune Data Warehouse data model.

Importante

Você pode testar a funcionalidade mais recente do Data Warehouse usando a versão beta.You can try out the latest functionality of the Data Warehouse by using the beta version. Para usar a versão beta, a URL deve conter o parâmetro de consulta api-version=beta.To use the beta version, your URL must contain the query parameter api-version=beta. A versão beta oferece recursos antes que eles estejam disponíveis como um serviço com suporte.The beta version offers features before they are made generally available as a supported service. Como o Intune adiciona novos recursos, a versão beta pode ter dados e o comportamento diferentes dos contratos.As Intune adds new features, the beta version may change behavior and data contracts. Qualquer código personalizado ou quaiquer ferramentas de relatório dependentes da versão beta de relatório podem ser corrompidas com atualizações contínuas.Any custom code or reporting tools dependent on the beta version may break with ongoing updates.

Cliente personalizado do ODataOData custom client

Você pode acessar o modelo de dados do Data Warehouse do Intune por meio de pontos de extremidade RESTful.You can access the Intune Data Warehouse data model through RESTful endpoints. Para obter acesso aos seus dados, seu cliente deve ser autorizado no Azure AD (Azure Active Directory) usando OAuth 2.0.To gain access to your data, your client must authorize with Azure Active Directory (Azure AD) using OAuth 2.0. Primeiro você configura um aplicativo Web e um aplicativo cliente no Azure e concede permissões para o cliente.You first set up a web app and a client app in Azure, grant permissions to the client. Seu cliente local obterá a autorização e, assim, poderá se comunicar com os pontos de extremidade do Data Warehouse.Your local client gets authorization and can then communicate with the Data Warehouse endpoints.

Para obter mais informações, consulte Obter dados da API do Data Warehouse com um cliente RESTFor more information, see Get data from the Data Warehouse API with a REST client

Observação

Você pode acessar o repositório do Data Warehouse do Intune do GitHub no Github para obter exemplos de código.You can access the GitHub Intune Data Warehouse repo on Github for code samples.

Interação com a APIInteracting with the API

A API requer autorização com o Azure AD.The API requires authorization with Azure AD. O Azure AD usa OAuth 2.0.Azure AD uses OAuth 2.0. Uma vez autorizado, você pode obter dados da API usando um verbo HTTP GET e entrar em contato com as coleções de entidades expostas.Once authorized, you can get data from the API using an HTTP GET verb and contacting the exposed entity collections. Para obter detalhes, consulte:For details see:

Modelo de dados do Intune Data WarehouseIntune Data Warehouse data model

OData define um modelo de dados abstrato e um protocolo que permite que qualquer cliente acesse informações expostas por qualquer fonte de dados.OData defines an abstract data model and a protocol that let any client access information exposed by any data source. O tópico de documentação do modelo de dados contém uma explicação sobre os namespaces, entidades e objetos de retorno no modelo de dados do Intune Data Warehouse.The data model documentation topic contains an explanation of the namespaces, entities, and return objects in the Intune Data Warehouse data model. Para saber mais, consulte Modelo de dados do Data Warehouse.For more information, see Data Warehouse Data Model.

Próximas etapasNext steps

Saiba mais sobre como trabalhar com o Azure AD lendo os Cenários de autenticação do Azure AD.Learn more about working with Azure AD by reading the Authentication Scenarios for Azure AD.

Localize recursos do OData em odata.org.Find OData resources at odata.org.

Examine o padrão do OData Versão 4.0 em [OData Version 4.0] (https://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html)Review the OData Version 4.0 standard at [OData Version 4.0] (https://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html)