Webhook のスクリプト

Webhook のデプロイと更新に使用される Publish-Webhooks.ps1 スクリプトのパラメーターのリファレンスです。

Webhook にパブリッシュする

次の表で、Publish-Webhooks.ps1 スクリプトで使用できるすべてのパラメーターについて説明します。

パラメーター	説明
-action	実行するシナリオを指定します。使用可能なオプションは次のとおりです。 Deploy - クリーン インストールとして指定します。 Update - Webhook サービス インスタンスを更新中であることを指定します。
-azureAccountApplicationId	Azure のサービス プリンシパル ID。 注: 指定したサービス プリンシパルには、サブスクリプション範囲で App Service に対する コントリビューター ロールが割り当てられている必要があります。
-azureAccountPassword	サービス プリンシパル ID の Azure トークン パスワード。
-azureSubscriptionId	それぞれの App Service に対する Azure のサブスクリプション ID です。
-azureAccountTenantId	Azure テナント ID。
-appServiceName	Webhook の Azure App Service 名です。 注: これは Orchestrator の App Service 名とは異なる名前にする必要があります。
-resourceGroupName	Webhook の App Service を含む 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 の更新に使用されます。このスクリプトは、Web アプリで既にデータベースの接続文字列 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 - それぞれの App Service に対する Azure のサブスクリプション ID。 azureAccountTenantId - Azure のテナント ID。
-orchDetails	次の値を持つハッシュ テーブルです。 resourceGroupName - Orchestrator App Service を含む、Azure リソース グループの名前です。 appServiceName - Orchestrator の Azure App Service の名前。 targetSlot - Azure により設定された、対象の App Service Slot。
-webhooksDetails	次の値を持つハッシュ テーブルです。 resourceGroupName - Webhook App Service を含む、Azure リソース グループの名前です。 appServiceName - Webhook App Service の名前。 targetSlot - Azure により設定された、対象の App Service Slot。
-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 App Service にデータを移行し、両方の設定をするために使用します。このスクリプトは 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" }