- Getting Started
- Requirements
- Best Practices
- Installation
- Updating
- Identity Server
- Troubleshooting startup errors
Webhooks Scripts
Publish-Webhooks.ps1
script.
Parameter |
Description |
---|---|
|
Indicate the scenario to be run, the available options are:
|
|
The Azure service principal ID. Note: The indicated service principal must be assigned the Contributor role to the app service at the subscription scope.
|
|
The Azure token password for the service principal ID. |
|
The Azure subscription ID for the respective App Service. |
|
The Azure tenant ID. |
|
The Webhook Azure App Service name. Note: This should be different from your Orchestrator App Service name.
|
|
The name of the Azure Resource Group that contains the Webhook App Service. |
|
Indicate the full path or relative path of the
UiPath.WebhookService.zip archive.
|
|
When present, stops the application prior to beginning the deployment and then restarts it after the deployment is complete. |
|
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 | Optional. This parameter is only used for US Government deployments. |
Publish-Webhooks.ps1
script is used for the initial deployment or update of Webhooks. The script assumes that the web app already has the DefaultConnection
database connection string configured.
.\Publish-Webhooks.ps1 `
-action deploy `
-package ".\UiPath.WebhookService.Web.zip" `
-azureAccountApplicationId "<AzureApplicationID>" `
-azureAccountPassword "<AzureAccountPassword>" `
-azureSubscriptionId "<SubscriptionID>" `
-azureAccountTenantId "<TenantID>" `
-resourceGroupName "<AzureResourceGroupYouPickedInStep1>" `
-appServiceName "<UiPathWebhookService>"
.\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
script.
MigrateTo-Webhooks.ps1
script.
Parameters |
Description |
---|---|
|
Indicate the path to the
UiPath.WebhookService.Migrate.Cli.zip archive.
|
|
A hash table with the following values:
|
|
A hash table with the following values:
|
|
A hash table with the following values:
|
|
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
script is used to migrate data from an existing Orchestrator instance to a new Webhook App Service and set the configurations
for both. The script assumes that Orchestrator and Webhooks are already published.
.\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" }
.\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" }