Freigeben über

Schnellstart: Erstellen und Verwalten von Workflows mit der Azure CLI in Azure Logic Apps

  • Artikel

Gilt für: Azure Logic Apps (Verbrauch)

In diesem Schnellstart wird gezeigt, wie sie automatisierte Workflows erstellen und verwalten, die in Azure Logic Apps ausgeführt werden, indem Sie die Logic Apps-Erweiterung für die Azure CLI (az logic) verwenden. Über die Befehlszeile können Sie eine Verbrauchs-Logik-App in einer mehrmandantenfähigen Azure Logic Apps-Instanz erstellen und dabei die JSON-Datei für die Definition eines Logik-App-Workflows verwenden. Anschließend können Sie Ihre Logik-App durch Ausführen von Vorgängen wie list, show (get), update und delete über die Befehlszeile verwalten.

Warnung

Die Logic Apps-Erweiterung für die Azure-Befehlszeilenschnittstelle ist derzeit eine experimentelle Erweiterung, für die kein Kundensupport bereitgestellt wird. Verwenden Sie diese CLI-Erweiterung mit Bedacht – insbesondere in Produktionsumgebungen.

Dieser Schnellstart gilt derzeit nur für Verbrauchs-Logic-App-Workflows, die in mehrmandantenfähigen Azure Logic Apps-Instanzen ausgeführt werden. Die Azure CLI ist derzeit für Standard-Logik-App-Workflows nicht verfügbar, die in einzelinstanzfähigen Azure Logic Apps-Instanzen ausgeführt werden. Weitere Informationen finden Sie unter Ressourcentyp und Unterschiede im Host der Azure Logic-Apps.

Wenn Sie noch nicht mit Azure Logic Apps vertraut sind, können Sie sich auch darüber informieren, wie Sie Ihren ersten Logik-App-Verbrauchsworkflow im Azure-Portal oder in Visual Studio Code erstellen.

Voraussetzungen

Prüfung der erforderlichen Komponenten

Überprüfen Sie Ihre Umgebung, bevor Sie beginnen:

  • Melden Sie sich beim Azure-Portal an, und führen Sie az login aus, um sich zu vergewissern, dass Ihr Abonnement aktiv ist.

  • Überprüfen Sie Ihre Version der Azure-Befehlszeilenschnittstelle, indem Sie in einem Terminal oder Befehlsfenster az --versionausführen. Die neueste Version finden Sie unter Versionshinweise für die Azure CLI.

    Sollten Sie nicht über die neueste Version verfügen, aktualisieren Sie Ihre Installation wie unter Installieren der Azure CLI beschrieben.

Beispiel - Erstellen einer Ressourcengruppe

Sollten Sie noch nicht über eine Ressourcengruppe für Ihre Logik-App verfügen, erstellen Sie die Gruppe mithilfe des Befehls az group create. Mit dem folgenden Befehl wird beispielsweise eine Ressourcengruppe namens testResourceGroup am Standort westus erstellt:

az group create --name testResourceGroup --location westus

In der Ausgabe wird provisioningState als Succeeded angezeigt, wenn Ihre Ressourcengruppe erfolgreich erstellt wurde:

<...>
  "name": "testResourceGroup",
  "properties": {
    "provisioningState": "Succeeded"
  },
<...>

Workflowdefinition

Zum Erstellen einer neuen Logik-App oder Aktualisieren einer vorhandenen Logik-App über die Azure-Befehlszeilenschnittstelle benötigen Sie eine Workflowdefinition für Ihre Logik-App. Im Azure-Portal können Sie die zugrunde liegende Workflowdefinition Ihrer Logik-App im JSON-Format anzeigen, indem Sie von der Ansicht Designeransicht zur Codeansicht wechseln.

Beim Ausführen der Befehle zum Erstellen oder Aktualisieren Ihrer Logik-App wird Ihre Workflowdefinition als erforderlicher Parameter (--definition) hochgeladen. Die Workflowdefinition muss als JSON-Datei erstellt werden, die den Angaben im Schemareferenzleitfaden für die Workflowdefinitionssprache in Azure Logic Apps entspricht.

Erstellen von Logik-Apps über die Befehlszeilenschnittstelle

Verwenden Sie für die Erstellung eines Logik-App-Workflows über die Azure CLI den Befehl az logic workflow create mit einer JSON-Datei für die Definition.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Der Befehl muss die folgenden erforderlichen Parameter enthalten:

Parameter Wert BESCHREIBUNG
Workflowdefinition --definition Eine JSON-Datei mit der Workflowdefinition Ihrer Logik-App.
Standort --location -l Die Azure-Region, in der sich Ihre Logik-App befindet.
Name --name -n Der Name Ihrer Logik-App. Der Name darf nur Buchstaben, Ziffern, Bindestriche (-), Unterstriche (_), Klammern (()) und Punkte (.) enthalten. Außerdem muss der Name regionsübergreifend eindeutig sein.
Ressourcengruppenname --resource-group -g Die Azure-Ressourcengruppe, in der Sie Ihre Logik-App erstellen möchten. Sollte noch keine Ressourcengruppe für Ihre Logik-App vorhanden sein, erstellen Sie eine Ressourcengruppe, bevor Sie beginnen.

Sie können auch zusätzliche optionale Parameter hinzufügen, um die Zugriffssteuerung, die Endpunkte, das Integrationskonto, den Zustand und die Ressourcentags Ihrer Logik-App zu konfigurieren.

Beispiel - Erstellen einer Logik-App

In diesem Beispiel wird ein Workflow namens testLogicApp in der Ressourcengruppe testResourceGroup am Standort westus erstellt. Die JSON-Datei testDefinition.json enthält die Workflowdefinition.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "testDefinition.json"

Wenn Ihr Workflow erfolgreich erstellt wurde, wird von der Befehlszeilenschnittstelle der JSON-Code Ihrer neuen Workflowdefinition angezeigt. War die Workflowerstellung nicht erfolgreich, finden Sie weitere Informationen in der Liste möglicher Fehler.

Aktualisieren von Logik-Apps über die Befehlszeilenschnittstelle

Verwenden Sie zum Aktualisieren eines Logik-App-Workflows über die Azure CLI den Befehl az logic workflow create.

Der Befehl muss die gleichen erforderlichen Parameter enthalten wie beim Erstellen von Logik-Apps über die Befehlszeilenschnittstelle. Darüber hinaus können Sie die gleichen optionalen Parameter hinzufügen wie beim Erstellen einer Logik-App.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--integration-service-environment]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Beispiel - Aktualisieren einer Logik-App

In diesem Beispiel wird der im vorherigen Abschnitt erstellte Beispielworkflow mit einer anderen JSON-Definitionsdatei (newTestDefinition.json) aktualisiert. Außerdem werden zwei Ressourcentags (testTag1 und testTag2) mit Beschreibungswerten hinzugefügt.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "newTestDefinition.json" --tags "testTag1=testTagValue1" "testTag2=testTagValue"

Wenn Ihr Workflow erfolgreich aktualisiert wurde, wird von der Befehlszeilenschnittstelle die aktualisierte Workflowdefinition Ihrer Logik-App angezeigt. War die Aktualisierung nicht erfolgreich, finden Sie weitere Informationen in der Liste möglicher Fehler.

Löschen von Logik-Apps über die Befehlszeilenschnittstelle

Verwenden Sie zum Löschen eines Logik-App-Workflows über die Azure CLI den Befehl az logic workflow delete.

Der Befehl muss die folgenden erforderlichen Parameter enthalten:

Parameter Wert Beschreibung
Name --name -n Der Name Ihrer Logik-App.
Ressourcengruppenname -resource-group -g Die Ressourcengruppe, in der sich Ihre Logik-App befindet.

Sie können auch den optionalen Parameter--yes -y einschließen, um Bestätigungsaufforderungen zu überspringen.

az logic workflow delete --name
                         --resource-group
                         [--yes]

Anschließend werden Sie von der Befehlszeilenschnittstelle aufgefordert, das Löschen Ihrer Logik-App zu bestätigen. Wenn Sie die Bestätigungsaufforderung überspringen möchten, können Sie dem Befehl den optionalen Parameter --yes -y hinzufügen.

Are you sure you want to perform this operation? (y/n):

Zur Bestätigung der Löschung einer Logik-App können Sie Ihre Logik-Apps über die Befehlszeilenschnittstelle auflisten oder Ihre Logik-Apps im Azure-Portal anzeigen.

Beispiel - Löschen einer Logik-App

In diesem Beispiel wird der in einem vorherigen Abschnitt erstellte Beispielworkflow gelöscht.

az logic workflow delete --resource-group "testResourceGroup" --name "testLogicApp"

Nachdem Sie auf die Bestätigungsaufforderung mit y reagiert haben, wird die Logik-App gelöscht.

Überlegungen - Löschen einer Logik-App

Das Löschen einer Logik-App wirkt sich wie folgt auf Workflow-Instanzen aus:

  • Azure Logic Apps unterbricht alle aktiven und ausstehenden Ausführungen so gut wie möglich.

    Selbst bei einer großen Menge oder einem umfangreichen Backlog werden die meisten Ausführungen abgebrochen, bevor sie abgeschlossen oder gestartet werden. Es kann jedoch einige Zeit dauern, bis der Abbruchvorgang abgeschlossen ist. In der Zwischenzeit werden möglicherweise einige Ausführungen gestartet, während die Runtime den Abbruchprozess durchläuft.

  • Azure Logic Apps erstellt keine neuen Workflowinstanzen und führt keine neuen Workflowinstanzen aus.

  • Wenn Sie einen Workflow löschen und dann denselben Workflow neu erstellen, hat der neu erstellte Workflow nicht die gleichen Metadaten wie der gelöschte Workflow. Sie müssen jeden Workflow, der den gelöschten Workflow aufgerufen hat, neu speichern. Auf diese Weise ruft der Aufrufer die richtigen Informationen für den neu erstellten Workflow ab. Andernfalls schlagen Aufrufe des neu erstellten Workflows mit einem Unauthorized-Fehler fehl. Dieses Verhalten gilt auch für Workflows, die Artefakte in Integrationskonten verwenden, sowie Workflows, die Azure-Funktionen aufrufen.

Anzeigen von Logik-Apps über die Befehlszeilenschnittstelle

Ein bestimmter Logik-App-Workflow kann mithilfe des Befehls az logic workflow show abgerufen werden.

az logic workflow show --name
                       --resource-group

Der Befehl muss die folgenden erforderlichen Parameter enthalten:

Parameter Wert Beschreibung
Name --name -n Der Name Ihrer Logik-App.
Ressourcengruppenname --resource-group -g Der Name der Ressourcengruppe, in der sich Ihre Logik-App befindet.

Beispiel - Abrufen einer Logik-App

In diesem Beispiel wird die Logik-App testLogicApp in der Ressourcengruppe testResourceGroup mit vollständigen Protokollen für das Debuggen zurückgegeben.

az logic workflow show --resource-group "testResourceGroup" --name "testLogicApp" --debug

Auflisten von Logik-Apps über die Befehlszeilenschnittstelle

Verwenden Sie zum Auflisten Ihrer Logik-Apps nach Abonnement den Befehl az logic workflow list. Durch diesen Befehl wird der JSON-Code für die Workflows Ihrer Logik-Apps zurückgegeben.

Die Ergebnisse können nach folgenden optionalen Parametern gefiltert werden:

Parameter Wert BESCHREIBUNG
Ressourcengruppenname --resource-group -g Der Name der Ressourcengruppe, nach der Sie Ihre Ergebnisse filtern möchten.
Anzahl von Elementen --top Die Anzahl von Elementen in Ihren Ergebnissen.
Filtern --filter Die Art von Filter, den Sie für Ihre Liste verwenden möchten. Sie können nach Zustand (State), nach Trigger (Trigger) und nach dem Bezeichner der referenzierten Ressource (ReferencedResourceId) filtern. 
az logic workflow list [--filter]
                       [--resource-group]
                       [--top]

Beispiel: Auflisten von Logik-Apps

In diesem Beispiel werden alle aktivierten Workflows in der Ressourcengruppe testResourceGroup in einem ASCII-Tabellenformat zurückgegeben.

az logic workflow list --resource-group "testResourceGroup" --filter "(State eq 'Enabled')" --output "table"

Errors

Der folgende Fehler gibt an, dass die Logic Apps-Erweiterung für die Azure-Befehlszeilenschnittstelle nicht installiert ist. Installieren Sie die Logic Apps-Erweiterung auf Ihrem Computer, wie in den Voraussetzungen beschrieben.

az: 'logic' is not in the 'az' command group. See 'az --help'. If the command is from an extension, please make sure the corresponding extension is installed. To learn more about extensions, please visit https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview

Der folgende Fehler deutet ggf. darauf hin, dass der Dateipfad zum Hochladen Ihrer Workflowdefinition nicht korrekt ist:

Expecting value: line 1 column 1 (char 0)

Globale Parameter

Befehle vom Typ az logic können mit folgenden optionalen globalen Parametern für die Azure-Befehlszeilenschnittstelle verwendet werden:

Parameter Wert BESCHREIBUNG
Ausgabeformat --output -o Ermöglicht das Ändern des Ausgabeformats (Standardformat: JSON).
Nur Fehler anzeigen --only-show-errors Ermöglicht das Unterdrücken von Warnungen, sodass nur Fehler angezeigt werden.
Ausführlich --verbose Dient zum Anzeigen ausführlicher Protokolle.
Debuggen --debug Dient zum Anzeigen aller Debugprotokolle.
Hilfemeldung --help -h Dient zum Anzeigen des Hilfedialogfelds.
Abfrage --query Dient zum Festlegen einer JMESPath-Abfragezeichenfolge für eine JSON-Ausgabe.

Nächste Schritte

Weitere Informationen zur Azure-Befehlszeilenschnittstelle finden Sie in der Azure CLI-Dokumentation.

Weitere Azure Logic Apps-CLI-Skriptbeispiele finden Sie im Browser für Codebeispiele von Microsoft.

Als Nächstes können Sie mithilfe eines Beispielskripts und einer Workflowdefinition eine Beispiel-Logik-App über die Azure CLI erstellen.

Azure CLI-Skriptbeispiel – Erstellen einer Logik-App