Scripts de webhooks

Parâmetros e uso do script Publish-Webhooks.ps1 para implantar ou atualizar Webhooks no Orchestrator.

Publicar no Webhooks

A tabela a seguir descreve todos os parâmetros que você pode usar com o script Publish-Webhooks.ps1.

Parâmetro	Description
-action	Indique o cenário a ser executado, as opções disponíveis são: Deploy - especifica que é uma instalação limpa; Update - especifica que você está atualizando sua instância de Serviço do Webhooks.
-azureAccountApplicationId	A ID principal do serviço do Azure. Observação: a entidade de serviço indicada deve ser atribuída à função de Colaborador para o serviço do aplicativo no escopo de assinatura.
-azureAccountPassword	O token de acesso do Azure para o ID principal do serviço.
-azureSubscriptionId	A ID de assinatura do Azure para o respectivo Serviço de Aplicativo.
-azureAccountTenantId	O ID de tenant do Azure.
-appServiceName	O nome do Serviço de Aplicativo do Azure do Webhook. Observação: esse nome deve ser diferente do seu nome de Serviço de Aplicativo do Orchestrator.
-resourceGroupName	O nome do Grupo de Recursos do Azure que contém o Serviço de Aplicativo do Webhook.
-package	Indique o caminho completo ou o caminho relativo do arquivamento UiPath.WebhookService.zip.
-stopApplicationBeforePublish	Quando presente, interrompe o aplicativo antes de iniciar a implantação e depois o reinicia após a conclusão da implantação.
-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 é usado apenas para implantações do Governo dos EUA.

O script Publish-Webhooks.ps1 é usado para a implantação inicial ou atualização do Webhooks. O script pressupõe que o aplicativo da Web já tenha a string de conexão do banco de dados DefaultConnection configurada.

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

Importante:

Após uma implantação inicial, você também deve executar o script do MigrateTo-Webhooks.ps1.

Migrar para o Webhooks

A tabela a seguir descreve todos os parâmetros que você pode usar com o script MigrateTo-Webhooks.ps1.

Parâmetros	Description
-cliPackage	Indique o caminho para o arquivo UiPath.WebhookService.Migrate.Cli.zip.
-azureDetails	Uma tabela de hash com os seguintes valores: azureAccountApplicationId - A ID da entidade de serviço do Azure. azureAccountPassword - A senha do token do Azure para a ID da entidade de serviço. azureSubscriptionId - A ID de assinatura do Azure para o respectivo Serviço de Aplicativo. azureAccountTenantId- A ID do tenant do Azure.
-orchDetails	Uma tabela de hash com os seguintes valores: resourceGroupName - O nome do Grupo de Recursos do Azure que contém o Serviço de Aplicativo do Orchestrator. appServiceName - O nome do Serviço de Aplicativo do Orchestrator. targetSlot - Slot de Serviço de Aplicativo de Destino definida pelo Azure.
-webhooksDetails	Uma tabela de hash com os seguintes valores: resourceGroupName - O nome do Grupo de Recursos do Azure que contém o Serviço de Aplicativo do Webhook. appServiceName - O nome do Serviço de Aplicativo do Webhook. targetSlot - Slot de Serviço de Aplicativo de Destino definida pelo 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 é usado para migrar dados de uma instância existente do Orchestrator para um novo Serviço de Aplicativo do Webhook e definir as configurações para ambos. O script supõe que o Orchestrator e os Webhooks já foram 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" }