通知を受け取る

UiPath 製品のインストールとアップグレード

UiPath 製品のインストールとアップグレード ガイド

Webhook のスクリプト

Webhook にパブリッシュする


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

ParameterDescription
-actionIndicate the scenario to be run, the available options are:
Deploy - specifies it is a clean installation;
Update - specifies you are updating your Webhooks Service instance.
-azureAccountApplicationIdThe Azure service principal ID.

Note: The indicated service principal must be assigned the Contributor role to the app service at the subscription scope.
-azureAccountPasswordThe Azure token password for the service principal ID.
-azureSubscriptionIdThe Azure subscription ID for the respective App Service.
-azureAccountTenantIdThe Azure tenant ID.
-appServiceNameThe Webhook Azure App Service name.

Note: This should be different from your Orchestrator App Service name.
-resourceGroupNameThe name of the Azure Resource Group that contains the Webhook App Service.
-packageIndicate the full path or relative path of the UiPath.WebhookService.zip archive.
-stopApplicationBeforePublishWhen present, stops the application prior to beginning the deployment and then restarts it after the deployment is complete.
-noAzureAuthenticationOptional. 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.

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 スクリプトで使用できるすべてのパラメーターについて説明します。

ParametersDescription
-cliPackageIndicate the path to the UiPath.WebhookService.Migrate.Cli.zip archive.
-azureDetailsA hash table with the following values:

azureAccountApplicationId - The Azure service principal ID..
azureAccountPassword - The Azure token password for the service principal ID.
azureSubscriptionId - The Azure subscription ID for the respective App Service.
azureAccountTenantId- The Azure tenant ID.
-orchDetailsA hash table with the following values:

resourceGroupName - The name of the Azure Resource Group that contains the Orchestrator App Service.
appServiceName - The Orchestrator App Service name.
targetSlot - The Target App Service Slot set by Azure.
-webhooksDetailsA hash table with the following values:

resourceGroupName - The name of the Azure Resource Group that contains the Webhook App Service.
appServiceName - The Webhook App Service name.
targetSlot - The Target App Service Slot set by Azure.
-noAzureAuthenticationOptional. 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" }

スクリプト パラメーターの詳細については、こちらをご覧ください。

8 か月前に更新


Webhook のスクリプト


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。