Webhook 脚本

用于部署或更新 Webhooks 服务的 Publish-Webhooks.ps1 脚本的参数和用法

发布到 Webhook

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

参数	描述
-action	指明要运行的方案，可用选项包括： Deploy - 指定它为全新安装； Update - 说明您正在更新 Webhooks Service 服务实例。
-azureAccountApplicationId	Azure 服务主体 ID。 注意：必须在订阅范围内将指定的服务主体分配为应用程序服务的参与者角色。
-azureAccountPassword	服务主体 ID 的 Azure 令牌密码。
-azureSubscriptionId	相应应用程序服务的 Azure 订阅 ID。
-azureAccountTenantId	Azure 租户 ID。
-appServiceName	Webhook Azure 应用程序服务名称。 注意：这应该与 Orchestrator 应用程序服务名称不同。
-resourceGroupName	包含 Webhook 应用程序服务的 Azure 资源组的名称。
-package	指示 UiPath.WebhookService.zip 存档的完整路径或相对路径。
-stopApplicationBeforePublish	如果存在，则在开始部署之前停止应用程序，然后在部署完成后重新启动应用程序。
-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	可选。此参数仅用于美国政府部署。

Publish-Webhooks.ps1 脚本用于 Webhook 的初始部署或更新。该脚本假定网页应用程序已配置 DefaultConnection 数据库连接字符串。

.\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 设置的目标应用程序服务槽。
-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.

此 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" }