Actividad de consulta de Microsoft Entra ID

Introducción

Una actividad de 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 una fuente para proporcionar datos en una operación.

Crear una actividad de consulta de Microsoft Entra ID

Se crea una instancia de una actividad Consulta de Microsoft Entra ID desde 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 de tela de diseño o cópielo y péguelo en él. Para obtener más información, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Se puede editar una actividad de 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ña Componentes del panel 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
  Asigne un nombre a 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 en 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, asigne un nombre a la actividad y seleccione un objeto. A continuación, se describe cada elemento de la interfaz de usuario de este paso.

• 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: Introduzca 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 se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el extremo durante la búsqueda, introduzca los criterios de búsqueda y actualice, como se describe a continuación.

  • Actualizar: Haga clic en el Utilice el icono de actualización o la palabra Actualizar para recargar objetos desde el extremo 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 crear la tabla de objetos que se muestra en la configuración.

  • Seleccionar 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 completa con los objetos disponibles, la conexión de Microsoft Entra ID podría no funcionar correctamente. Asegúrese de estar conectado reabriendo la conexión y probando las credenciales.

• Propiedades HTTP avanzadas: Haga clic en el icono Agregue un icono para agregar una fila a la tabla a continuación e ingrese un par clave-valor para cada parámetro de solicitud.

  Para guardar la fila, haga clic en el Icono 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 botón editar icono o {{ no such element: dict object['trash'] }} Icono de eliminar.

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

  Importante

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

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

• 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 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 pedirá 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: Introduzca 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 se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el extremo durante la búsqueda, introduzca los criterios de búsqueda y actualice, como se describe a continuación.

    • Actualizar: Haga clic en el Icono de actualización o la palabra Actualizar para recargar objetos desde el extremo 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 crear la tabla de objetos que se muestra en la configuración.

    • Añadir un objeto secundario: En la columna Objetos secundarios disponibles, haga clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. A continuación, haga clic en el icono de añadir. Para agregar las clases seleccionadas a la columna Objetos secundarios seleccionados.

  • Objetos secundarios seleccionados: Después de agregar una clase de objeto secundario, esta se lista aquí.

    • Eliminar un objeto secundario: En 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 icono de eliminar. Para devolver las clases seleccionadas a la columna Objetos secundarios disponibles.

• Atrás: Haga clic para guardar temporalmente la configuración de este paso y volver 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 pedirá 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 disponibles y la configuración de la consultar. 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 permite crear la Cadena de filtro con campos guiados.

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

Básico

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

• Campos de objeto: Seleccione los campos que se utilizarán en la consultar en función de la clase de objeto seleccionada.

  • Buscar: Introduzca 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 se filtran en tiempo real con cada pulsación de tecla.

  • Actualizar: Haga clic en el icono 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: Marque las casillas 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 usando la casilla principal.

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

  Nota

  Si se introduce un valor en este campo, el campo Superior debe dejarse vacío. De lo contrario, se producirá un error.

• 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: Introduzca términos de búsqueda para consultar objetos en la clase de objeto seleccionada. El extremo Microsoft Entra ID gestiona 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: Introduzca el número máximo de resultados que se recibirán en la respuesta de la consultar. Si no se introduce ningún valor en este campo, la consultar recibirá... 100Resultados por defecto. El valor máximo permitido es 999 Para obtener más de 999 resultados, utilice el campo Tamaño de página.

  Nota

  Si se introduce un valor en este campo, el campo Tamaño de página debe dejarse vacío. De lo contrario, se producirá un error.

• Cláusulas condicionales: Para añadir condicionales, utilice estos campos como entrada para construir las cláusulas, que luego aparecerán en la Cadena de filtro.

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

  • Campo: Utilice el menú desplegable para seleccionar el campo de la clase de objeto que se usará para el condicional.

  • Operador: Utilice el menú desplegable para seleccionar un operador adecuado:

    Comparación
    Igual a
    Mayor que
    Mayor o igual que
    Menos que
    Menor o igual que

  • Valor: Ingrese el valor deseado para compararlo 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 condicional 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

  Si _odata.nextLink Se proporciona en la transformación de la solicitud, se ignoran todos los parámetros presentes en la declaración de la cadena de filtro. Si está presente, un top 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 guardar 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 cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pedirá que confirme que desea descartar los cambios.

Avanzado

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

• Tamaño de página: Introduzca un tamaño de página para habilitar la paginación de resultados. El número de resultados en una página alcanzará el tamaño especificado. También se incluirá en la respuesta un enlace a la siguiente página de resultados. Si se introduce un valor en este campo, se mostrará un top No se puede proporcionar el filtro. De lo contrario, se produce un error.

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

  Importante

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

  • Una consultar no puede contener un valor para ambos top y el campo Tamaño de página. Cuando una consultar contiene ambos parámetros, se produce un error.
  • De forma predeterminada, la consultar recibirá 100 resultados. Al utilizar el top parámetro, el valor máximo permitido para el es 999 Para recibir más de 999 resultados, utilice el campo Tamaño de página.
  • Cuando _odata.nextLink se proporciona 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: Haga clic para validar la consultar. Si la consultar es válida, se muestra en una tabla una muestra de hasta 10 consultar recuperados. Si la consultar no es válida, se muestran los mensajes de error pertinentes. Si edita la cadena de filtro en el 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 guardar 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 cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pedirá 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 las transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformación.

  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 Microsoft Graph API v1.0. Consulte la documentación de la API para obtener información sobre los nodos y campos del esquema.

  Importante

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

• Editar: Haga clic en el ícono de edición Sobre el esquema de datos de respuesta para acceder al modo de edición de dicho esquema. El editor permite agregar, eliminar y reorganizar nodos y campos, así como cambiar sus tipos de datos. Todas las ocurrencias de nodos y campos se configuran como [0, 1] cardinalidad los cambios realizados en los esquemas de datos deben ser aceptables para el extremo y deben realizarse únicamente tras consultar la documentación disponible. Tras realizar modificaciones en el esquema, se muestra la fecha de la última edición en la parte superior del esquema extremo para indicar que se han realizado modificaciones manuales. Al actualizar los esquemas, se restablecerán a sus estructuras predeterminadas.

  Nota

  Los cambios se realizan directamente en la actividad sin confirmación. Si necesita revertir o restablecer algún cambio, repítalo en el modo de edición o vuelva a crear la actividad con una nueva instancia.

• Actualizar: Haga clic en el botón Utilice el icono 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 del proyecto donde se hace referencia al esquema, como en una transformación adyacente.

• Atrás: Haga clic para guardar 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 cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pedirá 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 o herramientas como pasos de la operación. También puede configurar los ajustes de la operación, lo que incluye la posibilidad de encadenar operaciones que se encuentren 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 más detalles, 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 ejecutar la operación y validar el comportamiento comprobando los registros de operación.