Webhooks-Skripte

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.
-orchestratorUrl	Obligatorisch. Die URL der Orchestrator-Instanz.
-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.
-azureUSGovernmentLogin	Optional. Dieser Parameter wird nur für Bereitstellungen der US-Regierung verwendet.

Für die Azure App Service-Installation von Orchestrator müssen Sie auch die folgenden Schritte ausführen, um den Webhooks-Dienst zu installieren:

1. Erstellen Sie in Ihrem Azure Portal eine neue Webanwendung mit einem benutzerdefinierten Namen, z. B.: UiPathWebhookService.
2. Wählen Sie im Feld Veröffentlichen die Option Code aus.
3. Wählen Sie bei Laufzeitstapel die Option .NET Core 3.1 aus.
4. Öffnen Sie Ihre neue Web-App, und navigieren Sie zu Einstellungen > Konfiguration.
5. Wählen Sie auf der Registerkarte Allgemeine Einstellungen die Option 64-Bit als Plattform aus.

6. Wählen Sie Speichern.

   Wichtig: Wenn Sie zuvor noch keine Azure AD-Anwendung und keinen Dienstprinzipal über die Orchestrator-Installation in Azure erstellt haben, erstellen Sie sie jetzt. Sie müssen diese konfigurieren, um auf UiPathWebhookService und die Ressourcengruppe zugreifen zu können.
7. Öffnen Sie ein Powershell-Fenster und führen Sie das Publish-Webhooks.ps1-Skript aus. Beispiel:

   .\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 Skript MigrateTo-Webhooks.ps1 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.

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