Actividad de consulta de Microsoft Entra ID
Introducción
Una actividad Consulta de Microsoft Entra ID, que utiliza su conexión de Microsoft Entra ID, consulta datos de objetos en Microsoft Entra ID y está destinado a ser utilizado como fuente para proporcionar datos en una operación.
Importante
Microsoft Entra ID anteriormente se conocía como Azure Active Directory (Azure AD).
Crear una actividad de consulta de Microsoft Entra ID
Se crea una instancia de una actividad Consulta de Microsoft Entra ID a partir de una conexión de Microsoft Entra ID utilizando su tipo de actividad Consulta.
Para crear una instancia de una actividad, arrastre el tipo de actividad al tela de diseño o copie el tipo de actividad y péguelo en el tela de diseño. Para obtener más detalles, consulte Creación de una instancia de actividad en Reutilización de componentes.
Se puede editar una actividad Consulta de Microsoft Entra ID existente desde estas ubicaciones:
- El tela de diseño (vea menú de acciones del componente en Lienzo de diseño).
- La pestaña Componentes del panel del proyecto (vea menú de acciones de componentes en la pestañaComponentes del panel Proyecto).
Configurar una actividad de consulta de Microsoft Entra ID
Siga estos pasos para configurar una actividad Consulta de Microsoft Entra ID:
-
Paso 1: Ingrese un nombre y seleccione un objeto
Proporcione un nombre para la actividad y seleccione un objeto. -
Paso 2: Seleccionar objetos secundarios
Seleccione objetos secundarios para consultar. -
Paso 3: Definir una cadena de filtro
Establecer condiciones para una consultar sobre los objetos secundarios seleccionados. -
Paso 4: Revisar los esquemas de datos
Se muestran todos los esquemas de solicitud o respuesta generados desde el extremo.
Paso 1: Ingrese un nombre y seleccione un objeto
En este paso, proporcione un nombre para la actividad y seleccione un objeto. A continuación se describe cada elemento de la interfaz de usuario de este paso.
Sugerencia
Campos con un ícono de variable admite el uso de variables globales, variables del proyecto y variables Jitterbit. Comience escribiendo un corchete abierto [
en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes para elegir.
-
Nombre: Ingrese un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Consulta de Microsoft Entra ID y no debe contener barras diagonales.
/
o dos puntos:
. -
Seleccionar objeto: Esta sección muestra los objetos disponibles en el extremo de Microsoft Entra ID.
-
Objeto seleccionado: Después de seleccionar un objeto, este aparece aquí.
-
Buscar: Ingrese el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de objetos. La búsqueda no distingue entre mayúsculas y minúsculas. Si ya se muestran objetos en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para volver a cargar objetos desde el extremo durante la búsqueda, ingrese los criterios de búsqueda y luego actualice, como se describe a continuación.
-
Actualizar: Haga clic en el ícono de actualización o la palabra Actualizar para volver a cargar objetos desde el extremo de Microsoft Entra ID. Esto puede resultar útil si se han agregado objetos a Microsoft Entra ID. Esta acción actualiza todos los metadatos utilizados para crear la tabla de objetos que se muestran en la configuración.
-
Selección de un objeto: Dentro de la tabla, haga clic en cualquier parte de una fila para seleccionar un objeto. Solo se puede seleccionar un objeto. La información disponible para cada objeto se obtiene del extremo Microsoft Entra ID:
-
Nombre: El nombre del objeto de Microsoft Entra ID.
-
Descripción: La descripción del objeto de Microsoft Entra ID.
-
Consejo
Si la tabla no se llena con los objetos disponibles, la conexión de Microsoft Entra ID puede no funcionar correctamente. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.
-
-
Propiedades HTTP avanzadas: Haga clic en el ícono de agregar para agregar una fila a la tabla a continuación e ingresar un par clave-valor para cada parámetro de solicitud.
Para guardar la fila, haga clic en el ícono de envío en la columna más a la derecha.
Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de edición o eliminar icono .
Para eliminar todas las filas, haga clic en Borrar todo.
Importante
Los campos de la tabla Propiedades HTTP avanzadas muestran el ícono de variable solo en modo de edición. Para que los valores de las variables de estos campos se completen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.
-
Guardar y salir: Si está habilitado, haga clic para guardar la configuración de este paso y cerrar la configuración de la actividad.
-
Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.
-
Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.
Paso 2: Seleccionar objetos secundarios
En este paso, seleccione el objeto secundario que desea consultar. A continuación, se describe cada elemento de la interfaz de usuario de este paso.
-
Clases de objeto: Esta sección muestra las clases de objetos secundarios disponibles y seleccionadas para interactuar en el extremo de Microsoft Entra ID.
-
Objetos secundarios disponibles: Esta sección muestra una lista de clases de objetos secundarios disponibles en Microsoft Entra ID.
-
Buscar: Ingrese el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de objetos. La búsqueda no distingue entre mayúsculas y minúsculas. Si ya se muestran objetos en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para volver a cargar objetos desde el extremo durante la búsqueda, ingrese los criterios de búsqueda y luego actualice, como se describe a continuación.
-
Actualizar: Haga clic en el ícono de actualización o la palabra Actualizar para volver a cargar objetos desde el extremo de Microsoft Entra ID. Esto puede resultar útil si se han agregado objetos a Microsoft Entra ID. Esta acción actualiza todos los metadatos utilizados para crear la tabla de objetos que se muestran en la configuración.
-
Agregar un objeto secundario: Dentro de la columna Objetos secundarios disponibles, haga clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. Luego, haga clic en el ícono Agregar para agregar las clases seleccionadas a la columna Objetos secundarios seleccionados:
-
-
Objetos secundarios seleccionados: Después de agregar una clase de objeto secundario, se incluye aquí.
-
Eliminación de un objeto secundario: Dentro de la columna Objeto secundario seleccionado, haga clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. Luego, haga clic en el ícono de eliminación para devolver las clases seleccionadas a la columna Objetos secundarios disponibles:
-
-
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.
-
Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.
-
Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.
Paso 3: Definir una cadena de filtro
En este paso, se define la cadena de filtro de una consultar mediante los campos de objeto y las configuraciones de consultar disponibles. A continuación, se describe cada elemento de la interfaz de usuario de este paso.
La interfaz utilizada en este paso de la configuración de una actividad Consulta de Microsoft Entra ID depende de la pestaña seleccionada:
-
Básico: Esta opción le permite crear la Cadena de filtro con campos guiados.
-
Avanzado: Esta opción oculta los campos guiados y le permite modificar la Cadena de filtro directamente.
Básico
Si se selecciona la pestaña Básico, se presenta esta interfaz:
Sugerencia
Campos con un ícono de variable admite el uso de variables globales, variables del proyecto y variables Jitterbit. Comience escribiendo un corchete abierto [
en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes para elegir.
-
Campos de objeto: Seleccione los campos que se utilizarán en la consultar en función de la clase de objeto seleccionada.
-
Buscar: Ingrese cualquier parte del nombre de un campo en el cuadro de búsqueda para filtrar la lista de campos del objeto seleccionado. La búsqueda no distingue entre mayúsculas y minúsculas. Los resultados de la lista se filtran en tiempo real con cada pulsación de tecla.
-
Actualizar: Haga clic en el ícono de actualización o la palabra Actualizar para volver a cargar los campos del objeto desde el extremo de Microsoft Entra ID.
-
Seleccionar todo en la clase de objeto: Al usar el cuadro de búsqueda para filtrar, puede usar esta casilla de verificación para seleccionar todos los campos visibles a la vez.
-
Seleccionar campos: Seleccione las casillas de verificación de los campos que desea incluir en la consultar para que se agreguen automáticamente a la Cadena de filtro. También puede seleccionar todos los campos a la vez utilizando la casilla de verificación principal.
-
-
Tamaño de página: Ingrese un tamaño de página para habilitar la paginación de resultados. La cantidad de resultados en una página totalizará hasta el tamaño especificado. También se incluirá en la respuesta un enlace a la siguiente página de resultados.
-
Incluir recuento: Seleccione esta opción para incluir la cantidad de resultados de una consultar como parte de la respuesta.
-
Búsqueda de texto completo: Ingrese términos de búsqueda para consultar objetos en la clase de objeto seleccionada. El extremo de Microsoft Entra ID maneja cómo se interpreta la búsqueda para una clase de objeto.
-
Omitir: Ingrese una cantidad de resultados para omitir en la respuesta de la consultar.
Importante
La API de Microsoft Graph no es compatible con
skip
parámetro con objetos de directorio que incluyen usuarios y grupos. -
Arriba: Ingrese un número máximo de resultados para recibir en la respuesta de la consultar.
top
El parámetro proporcionado en la transformación de la solicitud anula cualquiertop
parámetro definido en este paso. -
Cláusulas condicionales: Para agregar condicionales, use estos campos como entrada para ayudar a construir las cláusulas, que luego aparecen en la Cadena de filtro.
-
Objeto: Use el menú desplegable para seleccionar la clase de objeto que se usará para la condicional.
-
Campo: Use el menú desplegable para seleccionar el campo de la clase de objeto que se usará para la condicional.
-
Operador: Use el menú desplegable para seleccionar un operador apropiado:
Comparación Igual a Mayor que Mayor o igual que Menos que Menor o igual que -
Valor: Ingrese el valor deseado para comparar con las selecciones desplegables anteriores.
-
Eliminar: Haga clic en el ícono de eliminar para eliminar el condicional de la tabla.
-
Agregar: Haga clic para agregar una nueva condición a la tabla y filtrar cadena.
-
Eliminar todo: Haga clic para eliminar todos los condicionales de la tabla y la cadena de filtro.
-
-
Cadena de filtro: A medida que completa los demás campos en la pestaña Básico, la declaración de cadena de filtro en este cuadro de texto se completa automáticamente con los campos, las condiciones y las opciones de consultar seleccionados.
Importante
A
top
El parámetro proporcionado en la transformación de la solicitud anula cualquiertop
parámetro definido en este paso.Si
_odata.nextLink
se proporciona en la transformación de la solicitud, se ignoran todos los parámetros presentes en la declaración de cadena de filtro. Si está presente, setop
El parámetro proporcionado en la transformación de la solicitud también se ignora. -
Consulta de prueba: Haga clic para validar la consultar. Debe hacer clic en este botón para habilitar el botón Siguiente.
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
Siguiente: Haga clic para guardar temporalmente la configuración de este paso y continuar con el siguiente. La configuración no se guardará hasta que haga clic en el botón Finalizado en el último paso.
-
Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.
Avanzado
Si se selecciona la pestaña Avanzado, se presenta esta interfaz:
Sugerencia
Campos con un ícono de variable admite el uso de variables globales, variables del proyecto y variables Jitterbit. Comience escribiendo un corchete abierto [
en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes para elegir.
-
Tamaño de página: Ingrese un tamaño de página para habilitar la paginación de resultados. La cantidad de resultados en una página totalizará hasta el tamaño especificado. También se incluirá en la respuesta un enlace a la siguiente página de resultados.
-
Cadena de filtro: Edite la declaración de la cadena de filtro directamente.
Importante
A
top
El parámetro proporcionado en la transformación de la solicitud anula cualquiertop
parámetro definido en este paso.Si
_odata.nextLink
se proporciona en la transformación de la solicitud, se ignoran todos los parámetros presentes en la declaración de cadena de filtro. Si está presente, setop
El parámetro proporcionado en la transformación de la solicitud también se ignora. -
Consulta de prueba: Haga clic para validar la consultar. Si la consultar es válida, se muestra en una tabla una muestra de hasta 10 registros recuperados de la consultar. Si la consultar no es válida, se muestran los mensajes de error pertinentes. Si edita la cadena de filtro mientras está en modo Avanzado, la consultar debe ser válida y validarse mediante este botón para habilitar el botón Siguiente.
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
Siguiente: Haga clic para guardar temporalmente la configuración de este paso y continuar con el siguiente. La configuración no se guardará hasta que haga clic en el botón Finalizado en el último paso.
-
Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.
Paso 4: Revisar los esquemas de datos
Se muestran todos los esquemas de solicitud o respuesta generados desde el extremo. A continuación, se describe cada elemento de la interfaz de usuario de este paso.
-
Esquemas de datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformación.
El conector de Microsoft Entra ID utiliza Microsoft Graph API v1.0. Consulte la documentación de la API para obtener información sobre los nodos y campos del esquema.
Importante
A
top
El parámetro proporcionado en la transformación de la solicitud anula cualquiertop
parámetro definido en el paso 3.Si
_odata.nextLink
se proporciona en la transformación de la solicitud, se ignoran todos los parámetros presentes en la declaración de cadena de filtro en el paso 3. Si está presente, setop
El parámetro proporcionado en la transformación de la solicitud también se ignora. -
Actualizar: Haga clic en el ícono de actualización o la palabra Actualizar para regenerar esquemas desde el extremo de Microsoft Entra ID. Esta acción también regenera un esquema en otras ubicaciones en todo el proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
Terminado: Haga clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.
-
Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.
Próximos pasos
Después de configurar una actividad de consulta de Microsoft Entra ID, complete la configuración de la operación agregando y configurando otras actividades, transformaciones o secuencias de comandos como pasos de la operación. También puede configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujo de trabajo o en flujos de trabajo diferentes.
Se puede acceder a las acciones del menú de una actividad desde el panel del proyecto y el tela de diseño. Para obtener más información, consulte menú de acciones de la actividad en Conceptos básicos del conector.
Las actividades de Consulta de Microsoft Entra ID se pueden usar como fuente con estos patrones de operación:
- Patrón de Transformación
- Patrón de archivo de dos objetivos (solo como primera fuente)
- Patrón de archivo HTTP de dos destinos (solo como primera fuente)
- Patrón de dos transformaciones (solo como primera fuente)
Para utilizar la actividad con funciones de script, escriba los datos en una ubicación temporal y luego use esa ubicación temporal en la función de script.
Cuando esté listo, desplegar y ejecute la operación y validar el comportamiento comprobando los registros de operación.