Webhooks-Skripte

Parameter und Verwendung für das Skript Publish-Webhooks.ps1 zum Bereitstellen oder Aktualisieren des Webhooks-Diensts

In Webhooks veröffentlichen

In der folgenden Tabelle sind alle Parameter beschrieben, die mit dem Skript Publish-Webhooks.ps1 verwendet werden können.

Parameter	Beschreibung
-action	Geben Sie das Szenario an, das ausgeführt werden soll, die verfügbaren Optionen sind: Deploy – Gibt an, dass es sich um eine Neuinstallation handelt; Update – Gibt an, dass Sie Ihre Webhooks-Dienstinstanz aktualisieren.
-azureAccountApplicationId	Die Azure-Dienstprinzipal-ID. Hinweis: Dem angegebenen Dienstprinzipal muss die Rolle Mitwirkender für den App-Service im Abonnementumfang zugewiesen werden.
-azureAccountPassword	Das Azure-Tokenkennwort für die Dienstprinzipal-ID.
-azureSubscriptionId	Die Azure-Abonnement-ID für den jeweiligen App Service.
-azureAccountTenantId	Die Azure-Mandanten-ID.
-appServiceName	Der Webhook-Azure App Service-Name. Hinweis: Dieser muss sich von dem Namen Ihres Orchestrator-App Service unterscheiden.
-resourceGroupName	Der Name der Azure-Ressourcengruppe, die den Webhook-App-Dienst enthält.
-package	Geben Sie den vollständigen Pfad oder relativen Pfad des Archivs UiPath.WebhookService.zip an.
-stopApplicationBeforePublish	Wenn vorhanden, wird die Anwendung vor Beginn der Bereitstellung beendet und dann nach Abschluss der Bereitstellung neu gestartet.
-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	Optional. Dieser Parameter wird nur für Bereitstellungen der US-Regierung verwendet.

Das Skript Publish-Webhooks.ps1 wird für die anfängliche Bereitstellung oder Aktualisierung von Webhooks verwendet. Das Skript geht davon aus, dass die Web-App bereits die Datenbankverbindungszeichenfolge DefaultConnection konfiguriert hat.

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

Wichtig:

Nach einer ersten Bereitstellung müssen Sie auch das MigrateTo-Webhooks.ps1-Skript ausführen.

Migrieren zu Webhooks

In der folgenden Tabelle sind alle Parameter beschrieben, die mit dem Skript MigrateTo-Webhooks.ps1 verwendet werden können.

Parameter	Beschreibung
-cliPackage	Geben Sie den Pfad zum Archiv UiPath.WebhookService.Migrate.Cli.zip an.
-azureDetails	Eine Hashtabelle mit den folgenden Werten: azureAccountApplicationId – Die Azure-Dienstprinzipal-ID. azureAccountPassword – Das Azure-Tokenkennwort für die Dienstprinzipal-ID. azureSubscriptionId – Die Azure-Abonnement-ID für den jeweiligen App-Dienst. azureAccountTenantId – Die Azure-Mandanten-ID.
-orchDetails	Eine Hashtabelle mit den folgenden Werten: resourceGroupName – Der Name der Azure-Ressourcengruppe, die den Orchestrator App-Dienst enthält. appServiceName – Der Name des Orchestrator App-Diensts. targetSlot – Der von Azure festgelegte Ziel-App-Dienst-Slot.
-webhooksDetails	Eine Hashtabelle mit den folgenden Werten: resourceGroupName – Der Name der Azure-Ressourcengruppe, die den Webhook App-Dienst enthält. appServiceName – Der Name des Webhook App-Diensts. targetSlot – Der von Azure festgelegte Ziel-App-Dienst-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.

Dieses MigrateTo-Webhooks.ps1-Skript wird verwendet, um Daten von einer vorhandenen Orchestrator-Instanz zu einem neuen Webhook-App-Dienst zu migrieren und die Konfigurationen für beide festzulegen. Das Skript geht davon aus, dass der Orchestrator und Webhooks bereits veröffentlicht wurden.

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