Webhook 脚本

发布到 Webhook

下表介绍了可与 Publish-Webhooks.ps1 脚本一起使用的所有参数。

参数	描述
-action	指明要运行的方案，可用选项包括： Deploy - 指定它为全新安装； Update - 说明您正在更新 Webhooks Service 服务实例。
-azureAccountApplicationId	Azure 服务主体 ID。 The indicated service principal must be assigned the Contributor role to the app service at the subscription scope.
-azureAccountPassword	服务主体 ID 的 Azure 令牌密码。
-azureSubscriptionId	相应应用程序服务的 Azure 订阅 ID。
-azureAccountTenantId	Azure 租户 ID。
-appServiceName	Webhook Azure 应用程序服务名称。 This should be different from your Orchestrator App Service name.
-orchestratorUrl	必需。Orchestrator 实例的 URL。
-resourceGroupName	包含 Webhook 应用程序服务的 Azure 资源组的名称。
-package	指示 UiPath.WebhookService.zip 存档的完整路径或相对路径。
-stopApplicationBeforePublish	如果存在，则在开始部署之前停止应用程序，然后在部署完成后重新启动应用程序。
-azureUSGovernmentLogin	可选。此参数仅用于美国政府部署。

要安装 Orchestrator 的 Azure 应用程序服务，还必须执行以下步骤以安装 Webhook 服务：

1. 从 Azure 门户中，创建一个包含自定义名称的新网页应用程序，例如：UiPathWebhookService.

2. 在“发布”字段中，选择“代码”。

3. 对于运行时堆栈，请选择 .NET Core 3.1。

4. 打开新的网页应用程序并导航到“设置”>“配置”。

5. 在“常规设置”选项卡中，为平台选择“64 位”。

6. 选择“保存”。

   重要提示：

   如果您以前没有通过 Azure 上的 Orchestrator 安装创建 Azure AD 应用程序和服务主体，请立即创建它们。您必须配置它们才能访问您的 UiPathWebhookService 和资源组。

7. 打开 Powershell 窗口并执行 Publish-Webhooks.ps1 脚本。例如：

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

   重要提示：

   在初始部署之后，还必须执行 MigrateTo-Webhooks.ps1 脚本。

迁移到 Webhook

下表介绍了可与 MigrateTo-Webhooks.ps1 脚本一起使用的所有参数。

参数	描述
-cliPackage	指示到存档 UiPath.WebhookService.Migrate.Cli.zip 的路径。
-azureDetails	具有以下值的哈希表： azureAccountApplicationId - Azure 服务主体 ID。 azureAccountPassword - 服务主体 ID 的 Azure 令牌密码。 azureSubscriptionId - 相应应用程序服务的 Azure 订阅 ID。 azureAccountTenantId - Azure 租户 ID。
-orchDetails	具有以下值的哈希表： resourceGroupName - 包含 Orchestrator 应用程序服务的 Azure 资源组的名称。 appServiceName - Orchestrator 应用程序服务名称。 targetSlot - Azure 设置的目标应用程序服务槽。
-webhooksDetails	具有以下值的哈希表： resourceGroupName - 包含 Webhook 应用程序服务的 Azure 资源组的名称。 appServiceName - Webhook 应用程序服务的名称。 targetSlot - Azure 设置的目标应用程序服务槽。

此 MigrateTo-Webhooks.ps1 脚本用于将现有 Orchestrator 实例中的数据迁移到新的 Webhook 应用程序服务，并为两者进行配置。此脚本假定 Orchestrator 和 Webhook 已发布。

.\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" }