Scripts de Webhooks

Parámetros y uso del script Publish-Webhooks.ps1 para implementar o actualizar Webhooks en Orchestrator.

Publicación en Webhooks

La tabla siguiente describe todos los parámetros que puedes usar con el script Publish-Webhooks.ps1.

Parámetro	Descripción
-action	Indica el escenario que se ejecuta, las opciones disponibles son: Deploy - especifica que se trata de una instalación limpia; Update: especifica que estás actualizando tu instancia de servicio de Webhook.
-azureAccountApplicationId	El ID principal del servicio de Azure. Nota: Al director de servicio indicado se le debe asignar el rol de Contribuidor al servicio de aplicación en el ámbito de la suscripción.
-azureAccountPassword	La contraseña de token de Azure para el ID principal de servicio.
-azureSubscriptionId	El ID de suscripción de Azure para el Servicio de aplicaciones correspondiente.
-azureAccountTenantId	El ID de tenant de Azure.
-appServiceName	El nombre del servicio de aplicaciones de Azure de Webhook. Nota: este debe ser distinto a tu nombre del Servicio de aplicaciones de Orchestrator.
-resourceGroupName	El nombre del grupo de recursos de Azure que contiene el Servicio de aplicaciones de Webhook.
-package	Indica la ruta completa o relativa del archivo UiPath.WebhookService.zip.
-stopApplicationBeforePublish	Cuando está presente, detiene la aplicación antes de iniciar la implementación y luego la reinicia una vez que la implementación finaliza.
-noAzureAuthentication	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the UseServicePrincipal parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.
-azureUSGovernmentLogin	Opcional. Este parámetro solo se utiliza para las implementaciones del gobierno de EE. UU.

El script Publish-Webhooks.ps1 se usa para la implementación inicial o la actualización de Webhooks. El script supone que la aplicación web ya tiene configurada la cadena de conexión de la base de datos DefaultConnection.

.\Publish-Webhooks.ps1 `
-action deploy `
-package ".\UiPath.WebhookService.Web.zip" `
-azureAccountApplicationId "<AzureApplicationID>" `
-azureAccountPassword "<AzureAccountPassword>" `
-azureSubscriptionId "<SubscriptionID>" `
-azureAccountTenantId "<TenantID>" `
-resourceGroupName "<AzureResourceGroupYouPickedInStep1>" `
-appServiceName "<UiPathWebhookService>"

Importante:

Después de una implementación inicial, también debes ejecutar el script MigrateTo-Webhooks.ps1.

Migrar a Webhooks

La tabla siguiente describe todos los parámetros que puedes usar con el script MigrateTo-Webhooks.ps1.

Parámetros	Descripción
-cliPackage	Indica la ruta al archivo UiPath.WebhookService.Migrate.Cli.zip.
-azureDetails	Una tabla hash con los siguientes valores: azureAccountApplicationId: el ID principal del servicio de Azure. azureAccountPassword: la contraseña de token de Azure para el ID principal de servicio. azureSubscriptionId- El ID de suscripción de Azure para el servicio de aplicaciones respectivo. azureAccountTenantId: el ID de tenant de Azure.
-orchDetails	Una tabla hash con los siguientes valores: resourceGroupName - El nombre del grupo de recursos de Azure que contiene el Servicio de aplicaciones de Orchestrator. appServiceName- El nombre del servicio de aplicaciones de Orchestrator. targetSlot - La ranura del servicio de aplicaciones de destino establecida por Azure.
-webhooksDetails	Una tabla hash con los siguientes valores: resourceGroupName - El nombre del grupo de recursos de Azure que contiene Orchestrator App Service. appServiceName - el nombre del servicio de aplicaciones de Webhook. targetSlot - La ranura del servicio de aplicaciones de destino establecida por Azure.
-noAzureAuthentication	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the UseServicePrincipal parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.

Este script MigrateTo-Webhooks.ps1 se utiliza para migrar los datos desde una instancia de Orchestrator existente a un nuevo servicio de aplicaciones de Webhooks y establecer las configuraciones para ambas. El script da por supuesto que Orchestrator y los Webhooks ya han sido publicados.

.\MigrateTo-Webhooks.ps1 `
    -cliPackage "UiPath.WebhookService.Migrator.Cli.zip"`
    -azureDetails @{azureSubscriptionId = "<subscription_id>"; azureAccountTenantId = "<azure_tenant_id>"; azureAccountApplicationId = "<azure_application_id>"; azureAccountPassword = "<azure_account_password>" } `
    -orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>";  targetSlot = "Production" } `
    -webhookDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" }