Usar la CLI de conectores de Microsoft Power Platform.
No todas las tareas del ciclo de vida de un conector personalizado se pueden realizar mediante una interfaz de usuario de conector personalizado en el portal del fabricante. La herramienta de línea de comandos paconn debe usarse como parte del ciclo de vida de su conector personalizado para las siguientes tareas:
Descargar un conector personalizado para editar y controlar el código fuente después de haberlo creado o editado mediante el Maker Portal. Por ejemplo, para agregar propiedades de conexión personalizadas, debe descargar y editar los archivos.
Crear un nuevo conector personalizado en un entorno a partir de los archivos de definición individuales descargados. El conector que se creó no está incluido en una solución. Por ejemplo, este conector podría usarse para crear el mismo conector con un id. único diferente en el mismo entorno si desea una copia manteniendo intacto el original.
Actualización de un conector existente. Este paso se puede utilizar para actualizar un conector personalizado independiente o uno que esté incluido en una solución. Por ejemplo, puede actualizar un conector después de haber editado las propiedades de la conexión.
Validar su conector. Este paso es necesario para la certificación, pero muchos de los errores que se detectan pueden mejorar la calidad de cualquier conector personalizado.
Para evitar la pérdida de los cambios, asegúrese de que no haya nadie editando su conector personalizado y utilizando el portal y los archivos descargados simultáneamente. Cuando se hace la carga utilizando la herramienta de línea de comandos, esta no comprueba si hay conflictos y solo reemplaza la definición existente sin fusión.
Instalar la herramienta de línea de comandos
La herramienta de línea de comandos paconn requiere Python 3.5 o una versión superior. Python debe instalarse primero, seguido del comando pip install paconn para instalar la herramienta. Dispone de Instrucciones de instalación detalladas.
Archivo de configuración o parámetros
Puede configurar las opciones de la herramienta mediante el uso de parámetros de la línea de comandos cuando está ejecutando un comando o mediante el uso de un archivo settings.json. Especifique un archivo de configuración mediante -settings o -s parameter. Cuando se utiliza el archivo de configuración, el resto de los parámetros de la línea de comandos se ignoran.
El uso del archivo de configuración puede facilitarle la ejecución de comandos varias veces. Cuando descarga un conector personalizado, se crea un archivo settings.json como parte de la descarga. En la captura de pantalla siguiente, se muestra un ejemplo de archivo settings.json.
Puede revisar la lista detallada de configuraciones para obtener más detalles sobre los valores de cada configuración.
Autenticar
Para usar cualquiera de los comandos de paconn, primero debe autenticarse usando el comando paconn login. Este comando le dará un código y le dirigirá a https://microsoft.com/devicelogin, donde iniciará sesión con su cuenta y proporcionará ese código.
La finalización del inicio de sesión interactivo establecerá una sesión para ser utilizada por otros comandos paconn. La sesión caducará después de un tiempo y deberá restablecerla para seguir usando la herramienta. Puede forzar el final de la sesión en cualquier momento con el comando paconn logout.
Debido a que se requiere un inicio de sesión de usuario interactivo para autenticarse, la herramienta de línea de comandos se puede usar con scripts de automatización atendidos, pero no funcionaría en escenarios desasistidos, como una canalización de compilación.
Descarga
Utilice el comando paconn download para descargar un conector existente. Si no proporciona los parámetros, se le pedirá que elija entre una lista de entornos y luego entre una lista de conectores del entorno seleccionado.
Utilice el parámetro -e para preseleccionar un entorno específico y omitir la lista de entornos. La forma más sencilla de obtener un identificador de entorno es desde la URL del portal del creador.
El uso de esta opción presentaría una selección de los conectores de ese entorno solamente.
En lugar de seleccionar un conector de forma interactiva, puede especificar un conector concreto pasando un identificador de conector en el parámetro -c. La forma más sencilla de obtener el identificador del conector es descargar el conector una vez y luego copiar el valor del archivo de configuración.
Como resultado, el comando sería similar al del siguiente ejemplo:
paconn download -e d80faec4-eb14-4076-9681-9b46b97adbfd -c shared_cr83e-5fcontoso-20invoicing-5f20493607d490e1e0
Este comando descargaría los archivos del conector sin indicaciones.
La otra ventaja de usar identificadores es que, a diferencia de los números de orden en las listas de selección, los identificadores no cambian a medida que se crean o eliminan entornos y conectores.
Los archivos descargados se colocan en una carpeta cuyo nombre incluye el id. del conector. Si el directorio ya existe, el comando fallará y deberá eliminar manualmente la carpeta. Los archivos descargados constan de los cuatro archivos siguientes:
apiDefinition.swagger.json: este archivo de definición de API describe la API para el conector personalizado mediante la especificación de OpenAPI.
apiProperties.json: el archivo de propiedades de la API contiene propiedades para el conector personalizado y las plantillas de directivas.
Icon.png: el archivo de icono es una imagen pequeña que representa el icono del conector personalizado.
settings.json: puede utilizar este archivo de configuración preconfigurado en lugar de proporcionar parámetros a cada comando.
Creación
El comando paconn create crearía un conector personalizado en el entorno de destino utilizando los archivos de definición especificados. La definición de la API, las propiedades de la API y el icono deben especificarse mediante parámetros o un archivo de configuración. El comando create solicitará cualquier otro parámetro, como el id. de entorno, si no se proporcionan parámetros. El siguiente ejemplo muestra el comando create:
paconn create ^
-e [Microsoft Power Platform Environment GUID] ^
--api-prop [Path to apiProperties.json] ^
--api-def [Path to apiDefinition.swagger.json] ^
--icon [Path to icon.png] ^
--secret [The OAuth2 client secret for the connector]
Si su conector usa OAuth2, entonces puede usar el parámetro -secret para especificar el valor secreto del cliente.
Actualización
El comando paconn update actualiza un conector personalizado existente en el entorno de destino utilizando los archivos de definición especificados. La definición de la API, las propiedades de la API y el icono deben especificarse mediante parámetros o un archivo de configuración. El comando update solicitará cualquier otro parámetro, como el id. de entorno, si no se proporcionan parámetros. El siguiente ejemplo muestra el comando update:
paconn update ^
-e [Microsoft Power Platform Environment GUID] ^
-c [Connector ID] ^
--api-prop [Path to apiProperties.json] ^
--api-def [Path to apiDefinition.swagger.json] ^
--icon [Path to icon.png] ^
--secret [The OAuth2 client secret for the connector]
Importante
La actualización reemplazará la definición en el entorno de destino, incluso si se ha modificado desde que descargó su copia. Es importante coordinarse con cualquier otra persona que esté realizando actualizaciones en el conector.
La CLI de conectores de Microsoft Power Platform es una herramienta esencial cuando se crean conectores personalizados. Úsela como parte de su ciclo de vida para hacer cambios en los conectores y descargar copias de los archivos de definición del conector para el control de código fuente.