Actividad de Consulta de Microsoft Entra ID

Introducción

Una actividad de Consulta de Microsoft Entra ID, utilizando su conexión de Microsoft Entra ID, consulta datos de objetos en Microsoft Entra ID y está destinada a ser utilizada como fuente para proporcionar datos en una operación.

Crear una actividad de Consulta de Microsoft Entra ID

Una instancia de una actividad de Consulta de Microsoft Entra ID se crea 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 lienzo de diseño o copie el tipo de actividad y péguelo en el lienzo de diseño. Para más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad de Consulta de Microsoft Entra ID existente se puede editar desde estas ubicaciones:

• El lienzo de diseño (consulte Menú de acciones de componentes en Lienzo de diseño).
• La pestaña Componentes del panel del proyecto (consulte Menú de acciones de componentes en Pestaña de componentes del panel del proyecto).

Configurar una actividad de Consulta de Microsoft Entra ID

Siga estos pasos para configurar una actividad de 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
  Selecciona objetos secundarios para consultar.

• Paso 3: Definir una cadena de filtro
  Establece condiciones para una consulta sobre los objetos secundarios seleccionados.

• Paso 4: Revisar los esquemas de datos
  Se muestran los esquemas de solicitud o respuesta generados desde el endpoint.

Paso 1: Ingresa un nombre y selecciona un objeto

En este paso, proporciona un nombre para la actividad y selecciona un objeto. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Nombre: Ingresa 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 / ni dos puntos :.

• Seleccionar Objeto: Esta sección muestra los objetos disponibles en el endpoint de Microsoft Entra ID.

  • Objeto Seleccionado: Después de seleccionar un objeto, se lista aquí.

  • Buscar: Ingresa 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 los objetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el endpoint al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

  • Actualizar: Haz clic en el ícono de actualización o en la palabra Actualizar para recargar objetos desde el endpoint de Microsoft Entra ID. Esto puede ser útil si se han agregado objetos a Microsoft Entra ID. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrada en la configuración.

• Seleccionar un objeto: Dentro de la tabla, haz 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 endpoint de 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 haber sido exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

• Propiedades HTTP avanzadas: Haz clic en el icono para agregar una fila a la tabla de abajo e ingresa un par clave-valor para cada parámetro de solicitud.

  Para guardar la fila, haz clic en el icono en la columna más a la derecha.

  Para editar o eliminar una sola fila, pasa el cursor sobre la columna más a la derecha y utiliza el icono para editar o el icono {{ no such element: dict object['trash'] }} para eliminar.

  Para eliminar todas las filas, haz clic en Limpiar todo.

  Importante

  Los campos en la tabla de Propiedades HTTP avanzadas muestran el icono de variable solo en modo de edición. Para que los valores de variable de estos campos se llenen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

  Los campos en la tabla de Propiedades HTTP avanzadas no admiten el uso de variables para pasar JSON sin procesar. Si tu caso de uso no admite definir JSON sin procesar en los campos directamente, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Guardar y salir: Si está habilitado, haz clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Terminado en el último paso.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.

Paso 2: Seleccionar objetos secundarios

En este paso, selecciona el objeto secundario a consultar. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Clases de Objetos: Esta sección muestra las clases de objetos secundarios disponibles y seleccionadas con las que interactuar en el punto final de Microsoft Entra ID.

  • Objetos Secundarios Disponibles: Esta sección muestra una lista de clases de objetos secundarios disponibles en Microsoft Entra ID.

    • Buscar: Ingresa 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 los objetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el punto final al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

    • Actualizar: Haz clic en el ícono de actualización o en la palabra Actualizar para recargar objetos desde el punto final de Microsoft Entra ID. Esto puede ser útil si se han agregado objetos a Microsoft Entra ID. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrados en la configuración.

    • Agregar un Objeto Secundario: Dentro de la columna Objetos Secundarios Disponibles, haz clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. Luego haz clic en el ícono de agregar para añadir las clases seleccionadas a la columna Objetos Secundarios Seleccionados.

  • Objetos Secundarios Seleccionados: Después de que se agrega una clase de objeto secundario, se lista aquí.

    • Eliminar un Objeto Secundario: Dentro de la columna Objeto Secundario Seleccionado, haz clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. Luego haz clic en el ícono de eliminar para devolver las clases seleccionadas a la columna Objetos Secundarios Disponibles.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Paso 3: Definir una cadena de filtro

En este paso, se define una Cadena de Filtro para una consulta utilizando los campos de objeto disponibles y la configuración de la consulta. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

La interfaz utilizada en este paso de la configuración de una actividad de Consulta de Microsoft Entra ID depende de la pestaña seleccionada:

• Básico: Esta opción te permite construir la Cadena de Filtro con campos guiados.

• Avanzado: Esta opción oculta los campos guiados y te permite modificar la Cadena de Filtro directamente.

Básico

Si se selecciona la pestaña Básico, se presenta esta interfaz:

• Campos de Objeto: Selecciona los campos que se utilizarán en la consulta según la clase de objeto seleccionada.

  • Buscar: Ingresa cualquier parte del nombre de un campo en el cuadro de búsqueda para filtrar la lista de campos para el objeto seleccionado. La búsqueda no distingue entre mayúsculas y minúsculas. Los resultados listados se filtran en tiempo real con cada pulsación de tecla.

  • Actualizar: Haz clic en el ícono de actualización o en la palabra Actualizar para recargar los campos del objeto desde el endpoint de Microsoft Entra ID.

  • Seleccionar Todo en Clase de Objeto: Al usar el cuadro de búsqueda para filtrar, puedes usar esta casilla de verificación para seleccionar todos los campos visibles a la vez.

  • Seleccionar Campos: Selecciona las casillas de verificación de los campos que deseas incluir en la consulta para que se agreguen automáticamente a la Cadena de Filtro. También puedes seleccionar todos los campos a la vez usando la casilla de verificación principal.

• Tamaño de Página: Ingresa un tamaño de página para habilitar la paginación de resultados. El número de resultados en una página totalizará el tamaño especificado. También se incluirá un enlace a la siguiente página de resultados en la respuesta.

  Nota

  Si se ingresa un valor para este campo, el campo Top debe dejarse vacío. De lo contrario, se produce un error.

• Incluir Conteo: Selecciona para incluir el número de resultados de una consulta como parte de la respuesta.

• Búsqueda de Texto Completo: Ingresa términos de búsqueda para consultar objetos en la clase de objeto seleccionada. El endpoint de Microsoft Entra ID maneja cómo se interpreta la búsqueda para una clase de objeto.

• Saltar: Ingresa un número de resultados a omitir en la respuesta de la consulta.

  Importante

  La API de Microsoft Graph no admite el parámetro skip con objetos de Directorio, incluidos Usuarios y Grupos.

• Top: Ingresa un número máximo de resultados para recibir en la respuesta de la consulta. Cuando no se ingresa un valor para este campo, la consulta recibirá 100 resultados por defecto. El valor máximo permitido es 999. Para recibir más de 999 resultados, utiliza el campo Tamaño de Página en su lugar.

  Nota

  Si se ingresa un valor para este campo, el campo Tamaño de Página debe dejarse vacío. De lo contrario, se produce un error.

• Cláusulas Condicionales: Para agregar condicionales, utiliza estos campos como entrada para ayudar a construir las cláusulas, que luego aparecerán en la Cadena de Filtro.

  • Objeto: Usa el menú desplegable para seleccionar la clase de objeto que se utilizará para el condicional.

• Campo: Utiliza el menú desplegable para seleccionar el campo de la clase de objeto que se usará para la condición.

• Operador: Utiliza el menú desplegable para seleccionar un operador apropiado:

  | Comparación             |
  | ----------------------- |
  | Igual a                 |
  | Mayor que               |
  | Mayor o igual que       |
  | Menor que               |
  | Menor o igual que       |
  

• Valor: Ingresa el valor deseado para comparar con las selecciones del menú desplegable anteriores.

• Eliminar: Haz clic en el ícono de eliminar para quitar la condición de la tabla.

• Agregar: Haz clic para añadir una nueva condición a la tabla y Cadena de Filtro.

• Eliminar Todo: Haz clic para eliminar todas las condiciones de la tabla y Cadena de Filtro.

• Cadena de Filtro: A medida que completes los otros campos en la pestaña Básica, la declaración de la cadena de filtro en este cuadro de texto se llena automáticamente con los campos seleccionados, condiciones y opciones de consulta.

  Importante

  Si se proporciona _odata.nextLink en la transformación de la solicitud, todos los parámetros presentes en la declaración de la cadena de filtro se ignoran. Si está presente, un parámetro top proporcionado en la transformación de la solicitud también se ignora.

• Probar Consulta: Haz clic para validar la consulta. Este botón debe ser presionado para habilitar el botón Siguiente.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Avanzado

Si se selecciona la pestaña Avanzado, se presenta esta interfaz:

• Tamaño de Página: Ingresa un tamaño de página para habilitar la paginación de resultados. El número de resultados en una página será hasta el tamaño especificado. También se incluirá un enlace a la siguiente página de resultados en la respuesta. Si se ingresa un valor para este campo, no se puede proporcionar un filtro top. De lo contrario, ocurre un error.

• Cadena de Filtro: Edita la declaración de la cadena de filtro directamente.

  Important

  Al editar la declaración de la cadena de filtro, ten en cuenta lo siguiente:

  • Una consulta no puede contener un valor tanto para el parámetro top como para el campo Tamaño de Página. Cuando una consulta contiene ambos parámetros, ocurre un error.
  • Por defecto, la consulta recibirá 100 resultados. Al usar el parámetro top, el valor máximo permitido es 999. Para recibir más de 999 resultados, utiliza el campo Tamaño de Página en su lugar.
  • Cuando se proporciona _odata.nextLink en la transformación de la solicitud, se ignoran todos los parámetros presentes en la declaración de la cadena de filtro.

• Consulta de Prueba: Haz clic para validar la consulta. Si la consulta es válida, se muestra una muestra de hasta 10 registros recuperados de la consulta en una tabla. Si la consulta no es válida, se muestran mensajes de error relevantes. Si editas la cadena de filtro mientras estás en modo Avanzado, la consulta debe ser válida y validada a través de este botón para habilitar el botón Siguiente.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Aparecerá un mensaje pidiéndote que confirmes que deseas descartar los cambios.

Paso 4: Revisar los esquemas de datos

Cualquier esquema de solicitud o respuesta generado desde el endpoint se muestra. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Esquemas de Datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.

  Nota

  Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.

  El conector de Microsoft Entra ID utiliza la API de Microsoft Graph v1.0. Consulta la documentación de la API para obtener información sobre los nodos y campos del esquema.

  Importante

  Si se proporciona _odata.nextLink en la transformación de solicitud, se ignoran todos los parámetros presentes en la declaración de cadena de filtro en el paso 3. Si está presente, también se ignora un parámetro top proporcionado en la transformación de solicitud.

• Editar: Haz clic en el ícono de editar sobre el esquema de datos de respuesta para entrar en el modo de edición de ese esquema de datos. El editor te permite agregar, eliminar y reorganizar nodos y campos, así como cambiar sus tipos de datos. Todas las ocurrencias de nodos y campos se establecen como [0, 1] cardinalidad. Los cambios realizados en los esquemas de datos deben ser aceptables para el endpoint y deben hacerse solo después de consultar cualquier documentación disponible para el endpoint. Después de realizar ediciones en el esquema, se muestra una fecha de última edición en la parte superior del esquema aplicable para indicar que el esquema ha tenido ediciones manuales. Actualizar los esquemas restablecerá los esquemas a sus estructuras predeterminadas.

  Nota

  Cualquier cambio se realiza directamente en la actividad sin confirmación. Si necesitas revertir o restablecer algún cambio, vuelve a hacerlo mientras estás en modo de edición o recrea la actividad utilizando una nueva instancia de la actividad.

• Actualizar: Haz clic en el ícono de actualización o en la palabra Actualizar para regenerar esquemas desde el punto final de Microsoft Entra ID. Esta acción también regenera un esquema en otras ubicaciones a lo largo del proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Terminado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.

Siguientes pasos

Después de configurar una actividad de Consulta de Microsoft Entra ID, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puedes configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

Las acciones del menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para más detalles, consulta el menú de acciones de actividad en Conceptos básicos de conectores.

Las actividades de Consulta de Microsoft Entra ID se pueden utilizar como fuente con estos patrones de operación:

• Patrón de transformación
• Patrón de archivo de dos objetivos (como la primera fuente solamente)
• Patrón de archivo HTTP de dos objetivos (como la primera fuente solamente)
• Patrón de dos transformaciones (como la primera fuente solamente)

Para utilizar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego utiliza esa ubicación temporal en la función de scripting.

Cuando estés listo, despliega y ejecuta la operación y valida el comportamiento revisando los registros de la operación.