Punto de conexión de API de Data Warehouse de Microsoft Intune

Artículo
12/21/2023

Puede usar la API de Data Warehouse de Intune con una cuenta con controles de acceso específicos basados en roles y credenciales de Microsoft Entra. A continuación, autorizará el cliente REST con Microsoft Entra id. mediante OAuth 2.0. Y, por último, formará una dirección URL significativa para llamar a un recurso de almacenamiento de datos.

requisitos de credenciales de Intune y identificador de Microsoft Entra

La autenticación y autorización se basan en las credenciales de Microsoft Entra y el control de acceso basado en rol (RBAC) de Intune. De forma predeterminada, todos los administradores globales y administradores de servicios de Intune del inquilino tienen acceso al almacenamiento de datos. Use roles de Intune para proporcionar acceso a más usuarios al concederles acceso al recurso de almacenamiento de datos de Intune .

Los requisitos para acceder a Data Warehouse de Intune (incluida la API) son:

El usuario debe ser uno de los siguientes:
- Administrador global de Microsoft Entra
- Administrador del servicio de Intune
- Usuario con acceso basado en rol al recurso de almacenamiento de datos de Intune
- Autenticación sin usuario mediante la autenticación de solo aplicación

Importante

Para tener asignado un rol de Intune y acceder a la Data Warehouse de Intune, el usuario debe tener una licencia de Intune. Para obtener más información, consulte Control de acceso basado en rol (RBAC) con licencias de Microsoft Intune y Microsoft Intune.

Autorización

Microsoft Entra id. usa OAuth 2.0 para permitir el acceso a aplicaciones web y API web en el inquilino de Microsoft Entra. Esta guía es independiente del lenguaje y describe cómo enviar y recibir mensajes HTTP sin usar ninguna biblioteca de código abierto. El flujo de código de autorización de OAuth 2.0 se describe en la sección 4.1 de la especificación de OAuth 2.0.

Para obtener más información, consulte Autorización del acceso a aplicaciones web mediante OAuth 2.0 e identificador de Microsoft Entra.

Estructura de dirección URL de API

Los puntos de conexión Data Warehouse API leen las entidades de cada conjunto. La API admite un verbo HTTP GET y un subconjunto de opciones de consulta.

La dirección URL de Intune usa el formato siguiente:
https://fef.{location}.manage.microsoft.com/ReportingService/DataWarehouseFEService/{entity-collection}?api-version={api-version}

Nota:

En la dirección URL anterior, reemplace {location}, {entity-collection}y {api-version} en función de los detalles proporcionados en la tabla siguiente.

La dirección URL contiene los siguientes elementos:

Elemento	Ejemplo	Descripción
ubicación	msua06	Para encontrar la dirección URL base, consulte la hoja api de Data Warehouse en el centro de administración de Microsoft Intune.
entity-collection	devicePropertyHistories	Nombre de la colección de entidades OData. Para obtener más información sobre las colecciones y entidades en el modelo de datos, vea Modelo de datos.
api-version	beta	La versión es la versión de la API a la que se va a acceder. Para obtener más información, vea Versión.
maxhistorydays	7	(Opcional) Número máximo de días de historial que se van a recuperar. Este parámetro se puede proporcionar a cualquier colección, pero solo surtirá efecto para las colecciones que se incluyen `dateKey` como parte de su propiedad key. Consulte Filtros de intervalo datekey para obtener más información.

Información de versión de API

Ahora puede usar la versión v1.0 del Data Warehouse de Intune estableciendo el parámetro api-version=v1.0de consulta . Novedades a las colecciones de los Data Warehouse son aditivos por naturaleza y no interrumpen los escenarios existentes.

Puede probar la funcionalidad más reciente de la Data Warehouse mediante la versión beta. Para usar la versión beta, la dirección URL debe contener el parámetro api-version=betade consulta . La versión beta ofrece características antes de que estén disponibles con carácter general como un servicio compatible. A medida que Intune agrega nuevas características, la versión beta puede cambiar el comportamiento y los contratos de datos. Cualquier código personalizado o herramientas de informes que dependan de la versión beta pueden interrumpirse con las actualizaciones en curso.

Opciones de consulta de OData

La versión actual admite los siguientes parámetros de consulta de OData: $filter, $select$skip, y $top. En $filter, solo DateKey se puede admitir o RowLastModifiedDateTimeUTC cuando las columnas son aplicables, y otras propiedades desencadenarían una solicitud incorrecta.

Filtros de intervalo datekey

DateKey Los filtros de intervalo se pueden usar para limitar la cantidad de datos que se van a descargar para algunas de las colecciones con dateKey como propiedad de clave. El DateKey filtro se puede usar para optimizar el rendimiento del servicio proporcionando el siguiente $filter parámetro de consulta:

DateKey solo en , $filterque admite los lt/le/eq/ge/gt operadores y se une con el operador andlógico , donde se pueden asignar a una fecha de inicio o una fecha de finalización.
maxhistorydays se proporciona como opción de consulta personalizada.

Ejemplos de filtro