Quickstart: Werkstromen maken en beheren met Azure CLI in Azure Logic Apps

Artikel
01/04/2024

Van toepassing op: Azure Logic Apps (verbruik)

In deze quickstart ziet u hoe u geautomatiseerde werkstromen kunt maken en beheren die worden uitgevoerd in Azure Logic Apps met behulp van de Azure CLI Logic Apps-extensie (az logic). Vanaf de opdrachtregel kunt u een logische verbruiks-app maken in Azure Logic Apps met meerdere tenants met behulp van het JSON-bestand voor een werkstroomdefinitie van een logische app. Vervolgens kunt u uw logische app beheren door bewerkingen zoals list, show (get), update en delete uit te voeren vanaf de opdrachtregel.

Waarschuwing

De Azure CLI Logic Apps-extensie is momenteel experimenteel en niet gedekt door klantenondersteuning. Wees voorzichtig wanneer u deze CLI-extensie gebruikt, vooral als u ervoor kiest de extensie in productieomgevingen te gebruiken.

Deze quickstart is momenteel alleen van toepassing op logische app-werkstromen voor verbruik die worden uitgevoerd in Azure Logic Apps met meerdere tenants. Azure CLI is momenteel niet beschikbaar voor standaardwerkstromen voor logische apps die worden uitgevoerd in Azure Logic Apps met één tenant. Raadpleeg Resourcetype- en hostverschillen in Azure Logic Apps voor meer informatie.

Als u nog geen gebruik hebt gemaakt van Azure Logic Apps, leert u hoe u uw eerste werkstroom voor logische verbruiksapps maakt via de Azure Portal, in Visual Studio en in Visual Studio Code.

Vereisten

Een Azure-account met een actief abonnement. Als u nog geen abonnement op Azure hebt, maak dan een gratis account.
Azure CLI, geïnstalleerd op uw lokale computer.
De AZURE Logic Apps CLI-extensie die op uw computer is geïnstalleerd. Gebruik de volgende opdracht om deze extensie te installeren: az extension add --name logic
Een Azure-resourcegroep om uw logische app in te maken.

Controle op vereiste onderdelen

Voordat u begint, valideert u uw omgeving:

Meld u aan bij de Azure-portal en controleer of uw abonnement actief is door az login uit te voeren.
Controleer uw Azure CLI-versie in een terminal- of opdrachtvenster door az --version uit te voeren. Bekijk de meest recente releaseopmerkingen voor de nieuwste versie.

Als u de nieuwste versie niet hebt, werkt u uw installatie bij door de installatiehandleiding voor uw besturingssysteem of platform te volgen.

Voorbeeld: resourcegroep maken

Als u nog geen resourcegroep voor uw logische app hebt, maakt u de groep met de opdracht az group create. Met de volgende opdracht wordt bijvoorbeeld een resourcegroep met de naam testResourceGroup gemaakt op de locatie westus.

az group create --name testResourceGroup --location westus

De uitvoer toont de provisioningState als Succeeded wanneer uw resourcegroep is gemaakt:

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

Werkstroomdefinitie

Voordat u een nieuwe logische app maakt of een bestaande logische app bijwerkt door Azure CLI te gebruiken, hebt u een werkstroomdefinitie voor uw logische app nodig. In de Azure-portal kunt u de onderliggende werkstroomdefinitie van uw logische app in JSON-indeling bekijken door over te schakelen van de ontwerpfunctieweergave naar de codeweergave.

Wanneer u de opdrachten uitvoert om uw logische app te maken of bij te werken, wordt uw werkstroomdefinitie geüpload als een vereiste parameter (--definition). U moet uw werkstroomdefinitie maken als een JSON-bestand dat het taalschema voor werkstroomdefinities volgt.

Logische apps maken met CLI

Als u een werkstroom voor een logische app wilt maken vanuit de Azure CLI, gebruikt u de opdracht az logic workflow create met een JSON-bestand voor de definitie.

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]

Uw opdracht moet de volgende vereiste parameters bevatten:

Parameter	Waarde	Beschrijving
Werkstroomdefinitie	`--definition`	Een JSON-bestand met de werkstroomdefinitie van uw logische app.
Locatie	`--location -l`	De Azure-regio waarin uw logische app zich bevindt.
Naam	`--name -n`	De naam van uw logische app. De naam mag alleen letters, cijfers, afbreekstreepjes (`-`), onderstrepingstekens (`_`), haakjes (`()`) en punten (`.`) bevatten. De naam moet ook uniek zijn binnen alle regio’s.
Naam van de resourcegroep	`--resource-group -g`	De Azure-resourcegroep waarin u uw logische app wilt maken. Maak een resourcegroep voor uw logische app voordat u begint, als u die nog niet hebt.

U kunt ook aanvullende optionele parameters opnemen om het toegangsbeheer, de eindpunten, het integratieaccount, de integratieserviceomgeving, de status en de resourcetags van uw logische app te configureren.

Voorbeeld: logische app maken

In dit voorbeeld wordt er een werkstroom met de naam testLogicApp gemaakt in de resourcegroep testResourceGroup op de locatie westus. Het JSON-bestand testDefinition.json bevat de werkstroomdefinitie.

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

Wanneer uw werkstroom is gemaakt, toont CLI de JSON-code van uw nieuwe werkstroomdefinitie. Als het maken van uw werkstroom is mislukt, bekijkt u de lijst met mogelijke fouten.

Logische apps bijwerken met CLI

Als u de werkstroom van een logische app wilt bijwerken vanuit de Azure CLI, gebruikt u de opdracht az logic workflow create.

Uw opdracht moet dezelfde vereiste parameters bevatten als wanneer u een logische app maakt. U kunt ook dezelfde optionele parameters toevoegen als wanneer u een logische app maakt.

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]

Voorbeeld- Logische app bijwerken

In dit voorbeeld wordt de voorbeeldwerkstroom die in de vorige sectie is gemaakt, bijgewerkt om een ander JSON-definitiebestand (newTestDefinition.json) te gebruiken en twee resourcetags (testTag1 en testTag2) toe te voegen met beschrijvingswaarden.

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

Wanneer uw werkstroom is bijgewerkt, toont CLI de bijgewerkte werkstroomdefinitie van uw logische app. Als het bijwerken van uw werkstroom is mislukt, bekijkt u de lijst met mogelijke fouten.

Logische apps verwijderen met CLI

Als u de werkstroom van een logische app wilt verwijderen uit de Azure CLI, gebruikt u de opdracht az logic workflow delete.

Uw opdracht moet de volgende vereiste parameters bevatten:

Parameter	Waarde	Beschrijving
Naam	`--name -n`	De naam van uw logische app.
Naam van de resourcegroep	`-resource-group -g`	De resourcegroep waarin uw logische app zich bevindt.

U kunt ook een optionele parameter opnemen om bevestigingsprompts over te slaan, namelijk --yes -y.

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

CLI vraagt u vervolgens de verwijdering van uw logische app te bevestigen. U kunt de bevestigingsprompt overslaan door de optionele parameter --yes -y te gebruiken met uw opdracht.

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

Als u het verwijderen van een logische app wilt bevestigen, vermeldt u uw logische apps in de CLI of bekijkt u uw logische apps in de Azure Portal.

Voorbeeld: logische app verwijderen

In dit voorbeeld wordt de voorbeeldwerkstroom die in een vorige sectie is gemaakt, verwijderd.

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

Nadat u op de bevestigingsprompt hebt gereageerd met y, wordt de logische app verwijderd.

Overwegingen- Logische app verwijderen

Het verwijderen van een logische app heeft op de volgende manieren invloed op werkstroomexemplaren:

Azure Logic Apps doet er alles aan om alle actieve uitvoeringen en uitvoeringen in behandeling te annuleren.

Zelfs met een groot volume of een grote achterstand worden de meeste uitvoeringen geannuleerd voordat ze zijn voltooid of gestart. Het kan echter enige tijd duren voordat het annuleringsproces is voltooid. Ondertussen kunnen sommige uitvoeringen worden opgehaald voor uitvoering terwijl de runtime het annuleringsproces doorloopt.
Azure Logic Apps maakt of voert geen nieuwe werkstroomexemplaren uit.
Als u een werkstroom verwijdert en vervolgens dezelfde werkstroom opnieuw maakt, heeft de opnieuw gemaakte werkstroom niet dezelfde metagegevens als de verwijderde werkstroom. U moet elke werkstroom die de verwijderde werkstroom heeft aangeroepen, opnieuw opslaan. Op die manier krijgt de aanroeper de juiste informatie voor de opnieuw gemaakte werkstroom. Anders mislukken aanroepen naar de opnieuw gemaakte werkstroom met een Unauthorized fout. Dit gedrag is ook van toepassing op werkstromen die gebruikmaken van artefacten in integratieaccounts en werkstromen die Azure-functies aanroepen.

Logische apps weergeven in CLI

Als u een specifieke werkstroom voor een logische app wilt ophalen, gebruikt u de opdracht az logic workflow show.

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

Uw opdracht moet de volgende vereiste parameters bevatten

Parameter	Waarde	Beschrijving
Naam	`--name -n`	De naam van uw logische app.
Naam van de resourcegroep	`--resource-group -g`	De naam van de resourcegroep waarin uw logische app zich bevindt.

Voorbeeld- Logische app ophalen

In dit voorbeeld wordt de logische app testLogicApp in de resourcegroep testResourceGroup geretourneerd met volledige logboeken voor foutopsporing.

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

Logische apps vermelden in CLI

Gebruik de opdracht om uw logische apps per abonnement weer te geven az logic workflow list. Met deze opdracht wordt de JSON-code voor de werkstromen van uw logische app geretourneerd.

U kunt uw resultaten filteren op de volgende optionele parameters:

Parameter	Waarde	Beschrijving
Naam van de resourcegroep	`--resource-group -g`	De naam van de resourcegroep waarop u uw resultaten wilt filteren.
Aantal items	`--top`	Het aantal items dat in uw resultaten is opgenomen.
Filteren	`--filter`	Het type filter dat u op uw lijst gebruikt. U kunt filteren op status (`State`), trigger (`Trigger`) en de id van de resource waarnaar wordt verwezen (`ReferencedResourceId`).

az logic workflow list [--filter]
                       [--resource-group]
                       [--top]

Voorbeeld- Logische apps weergeven

In dit voorbeeld worden alle ingeschakelde werkstromen in de resourcegroep testResourceGroup geretourneerd in een ASCII-tabelindeling.

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

Fouten

De volgende fout geeft aan dat de Azure CLI Logic Apps-extension niet is geïnstalleerd. Volg de stappen in de vereisten om de Logic Apps-extensie op uw computer te installeren.

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

De volgende fout geeft mogelijk aan dat het bestandspad voor het uploaden van uw werkstroomdefinitie onjuist is.

Expecting value: line 1 column 1 (char 0)

Globale parameters

U kunt de volgende optionele globale Azure CLI-parameters gebruiken met uw az logic-opdrachten:

Parameter	Waarde	Beschrijving
Uitvoerindeling	`--output -o`	Wijzig de uitvoerindeling in iets anders dan de standaard JSON-indeling.
Alleen fouten weergeven	`--only-show-errors`	Hiermee worden waarschuwingen onderdrukt en alleen fouten weergegeven.
Uitgebreid	`--verbose`	Hiermee worden uitgebreide logboeken weergegeven.
Fouten opsporen	`--debug`	Hiermee worden alle logboeken voor foutopsporing weergegeven.
Help-bericht	`--help -h`	Hiermee wordt het Help-dialoogvenster weergegeven.
Query’s uitvoeren	`--query`	Hiermee wordt een JMESPath-queryreeks ingesteld voor JSON-uitvoer.

Volgende stappen

Raadpleeg de documentatie van Azure CLI voor meer informatie over de Azure CLI.

U vindt aanvullende AZURE Logic Apps CLI-scriptvoorbeelden in de browser met codevoorbeelden van Microsoft.

Vervolgens kunt u een logische voorbeeld-app maken met de Azure CLI met behulp van een voorbeeldscript en werkstroomdefinitie.

Een logische app maken met behulp van een voorbeeldscript.