Snabbstart: Skapa och hantera arbetsflöden med Azure CLI i Azure Logic Apps

Artikel
01/04/2024

Gäller för: Azure Logic Apps (förbrukning)

Den här snabbstarten visar hur du skapar och hanterar automatiserade arbetsflöden som körs i Azure Logic Apps med hjälp av Azure CLI Logic Apps-tillägget (az logic). Från kommandoraden kan du skapa en logikapp för förbrukning i Azure Logic Apps för flera klientorganisationer med hjälp av JSON-filen för en arbetsflödesdefinition för logikappen. Du kan sedan hantera logikappen genom att köra åtgärder som list, show (get), updateoch delete från kommandoraden.

Varning

Azure CLI Logic Apps-tillägget är för närvarande experimentellt och omfattas inte av kundsupport. Använd det här CLI-tillägget med försiktighet, särskilt om du väljer att använda tillägget i produktionsmiljöer.

Den här snabbstarten gäller för närvarande endast för arbetsflöden för förbrukningslogikappar som körs i Azure Logic Apps med flera klientorganisationer. Azure CLI är för närvarande inte tillgängligt för standardlogikapparbetsflöden som körs i Azure Logic Apps med en enda klientorganisation. Mer information finns i Resurstyp och värdskillnader i Azure Logic Apps.

Om du inte har använt Azure Logic Apps tidigare kan du lära dig hur du skapar ditt första arbetsflöde för förbrukningslogikappen via Azure Portal, i Visual Studio och i Visual Studio Code.

Förutsättningar

Ett Azure-konto med en aktiv prenumeration. Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt konto.
Azure CLI installerat på din lokala dator.
Azure Logic Apps CLI-tillägget installerat på datorn. Om du vill installera det här tillägget använder du det här kommandot: az extension add --name logic
En Azure-resursgrupp där du kan skapa logikappen.

Kravkontroll

Innan du börjar verifierar du din miljö:

Logga in på Azure Portal och kontrollera att din prenumeration är aktiv genom att köra az login.
Kontrollera din version av Azure CLI i en terminal eller ett kommandofönster genom att köra az --version. Den senaste versionen finns i de senaste viktig information.

Om du inte har den senaste versionen uppdaterar du installationen genom att följa installationsguiden för ditt operativsystem eller din plattform.

Exempel – Skapa resursgrupp

Om du inte redan har en resursgrupp för logikappen skapar du gruppen med kommandot az group create. Följande kommando skapar till exempel en resursgrupp med namnet testResourceGroup på platsen westus.

az group create --name testResourceGroup --location westus

Utdata visar provisioningState som Succeeded när resursgruppen har skapats:

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

Arbetsflödesdefinition

Innan du skapar en ny logikapp eller uppdaterar en befintlig logikapp med hjälp av Azure CLI behöver du en arbetsflödesdefinition för logikappen. I Azure Portal kan du visa logikappens underliggande arbetsflödesdefinition i JSON-format genom att växla från designervyn till kodvyn.

När du kör kommandona för att skapa eller uppdatera logikappen laddas arbetsflödesdefinitionen upp som en obligatorisk parameter (--definition). Du måste skapa arbetsflödesdefinitionen som en JSON-fil som följer schemat Arbetsflödesdefinitionsspråk.

Skapa logikappar från CLI

Om du vill skapa ett logikapparbetsflöde från Azure CLI använder du kommandot az logic workflow create med en JSON-fil för definitionen.

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]

Kommandot måste innehålla följande obligatoriska parametrar:

Parameter	Värde	Beskrivning
Arbetsflödesdefinition	`--definition`	En JSON-fil med logikappens arbetsflödesdefinition.
Location	`--location -l`	Den Azure-region där logikappen finns.
Namn	`--name -n`	Namnet på logikappen. Namnet får endast innehålla bokstäver, siffror, bindestreck (`-`), understreck (`_`), parenteser (`()`) och punkter (`.`). Namnet måste också vara unikt mellan regioner.
Namn på resursgrupp	`--resource-group -g`	Den Azure-resursgrupp där du vill skapa logikappen. Skapa en resursgrupp innan du börjar om du inte redan har en för logikappen.

Du kan också inkludera ytterligare valfria parametrar för att konfigurera logikappens åtkomstkontroller, slutpunkter, integrationskonto, integrationstjänstmiljö, tillstånd och resurstaggar.

Exempel – Skapa logikapp

I det här exemplet skapas ett arbetsflöde med namnet testLogicApp i resursgruppen testResourceGroup på platsen westus. JSON-filen testDefinition.json innehåller arbetsflödesdefinitionen.

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

När arbetsflödet har skapats visar CLI din nya arbetsflödesdefinitions JSON-kod. Om det inte går att skapa arbetsflödet kan du se listan över möjliga fel.

Uppdatera logikappar från CLI

Om du vill uppdatera en logikapps arbetsflöde från Azure CLI använder du kommandot az logic workflow create.

Kommandot måste innehålla samma obligatoriska parametrar som när du skapar en logikapp. Du kan också lägga till samma valfria parametrar som när du skapar en logikapp.

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]

Exempel – Uppdatera logikapp

I det här exemplet uppdateras exempelarbetsflödet som skapades i föregående avsnitt för att använda en annan JSON-definitionsfil, newTestDefinition.jsonoch lägger till två resurstaggar testTag1 och testTag2 med beskrivningsvärden.

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

När arbetsflödet har uppdaterats visar CLI logikappens uppdaterade arbetsflödesdefinition. Om uppdateringen misslyckas kan du se listan över möjliga fel.

Ta bort logikappar från CLI

Om du vill ta bort en logikapps arbetsflöde från Azure CLI använder du kommandot az logic workflow delete.

Kommandot måste innehålla följande obligatoriska parametrar:

Parameter	Värde	Beskrivning
Namn	`--name -n`	Namnet på logikappen.
Namn på resursgrupp	`-resource-group -g`	Den resursgrupp där logikappen finns.

Du kan också inkludera en valfri parameter för att hoppa över bekräftelseprompter, --yes -y.

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

CLI uppmanar dig sedan att bekräfta borttagningen av logikappen. Du kan hoppa över bekräftelseprompten med hjälp av den valfria parametern --yes -y med kommandot .

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

Om du vill bekräfta borttagningen av en logikapp anger du dina logikappar i CLI eller visar dina logikappar i Azure Portal.

Exempel – Ta bort logikapp

I det här exemplet tas exempelarbetsflödet som skapades i ett tidigare avsnitt bort.

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

När du har svarat på bekräftelseprompten med ytas logikappen bort.

Överväganden – Ta bort logikapp

Om du tar bort en logikapp påverkas arbetsflödesinstanser på följande sätt:

Azure Logic Apps gör sitt bästa för att avbryta pågående och väntande körningar.

Även med en stor volym eller kvarvarande uppgifter avbryts de flesta körningar innan de slutförs eller startas. Det kan dock ta tid att slutföra annulleringen. Under tiden kan vissa körningar hämtas för körning medan körningen fungerar genom annulleringsprocessen.
Azure Logic Apps skapar eller kör inte nya arbetsflödesinstanser.
Om du tar bort ett arbetsflöde och sedan återskapar samma arbetsflöde har det återskapade arbetsflödet inte samma metadata som det borttagna arbetsflödet. Du måste spara om alla arbetsflöden som kallas för det borttagna arbetsflödet. På så sätt får anroparen rätt information för det återskapade arbetsflödet. Annars misslyckas anrop till det återskapade arbetsflödet med ett Unauthorized fel. Det här beteendet gäller även för arbetsflöden som använder artefakter i integrationskonton och arbetsflöden som anropar Azure-funktioner.

Visa logikappar i CLI

Om du vill hämta ett specifikt logikapparbetsflöde använder du kommandot az logic workflow show.

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

Kommandot måste innehålla följande obligatoriska parametrar

Parameter	Värde	Beskrivning
Namn	`--name -n`	Namnet på logikappen.
Namn på resursgrupp	`--resource-group -g`	Namnet på resursgruppen där logikappen finns.

Exempel – Hämta logikapp

I det här exemplet returneras logikappen testLogicApp i resursgruppen testResourceGroup med fullständiga loggar för felsökning.

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

Lista logikappar i CLI

Om du vill visa en lista över dina logikappar efter prenumeration använder du kommandot az logic workflow list. Det här kommandot returnerar JSON-koden för logikappens arbetsflöden.

Du kan filtrera resultatet efter följande valfria parametrar:

Parameter	Värde	Beskrivning
Namn på resursgrupp	`--resource-group -g`	Namnet på den resursgrupp som du vill filtrera resultatet efter.
Antal objekt	`--top`	Antalet objekt som ingår i dina resultat.
Filtrera	`--filter`	Den typ av filter som du använder i listan. Du kan filtrera efter tillstånd (`State`), utlösare (`Trigger`) och identifieraren för den refererade resursen (`ReferencedResourceId`).

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

Exempel – Lista logikappar

I det här exemplet returneras alla aktiverade arbetsflöden i resursgruppen testResourceGroup i ascii-tabellformat.

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

Fel

Följande fel anger att Azure Logic Apps CLI-tillägget inte är installerat. Följ stegen i kraven för att installera Logic Apps-tillägget på datorn.

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

Följande fel kan tyda på att filsökvägen för att ladda upp arbetsflödesdefinitionen är felaktig.

Expecting value: line 1 column 1 (char 0)

Globala parametrar

Du kan använda följande valfria globala Azure CLI-parametrar med dina az logic kommandon:

Parameter	Värde	Beskrivning
Utdataformat	`--output -o`	Ändra utdataformatet från JSON-standardformatet.
Visa endast fel	`--only-show-errors`	Ignorera varningar och visa endast fel.
Verbose	`--verbose`	Visa utförliga loggar.
Felsöka	`--debug`	Visar alla felsökningsloggar.
Hjälpmeddelande	`--help -h`	Visa hjälpdialogrutan.
Söka i data	`--query`	Ange en JMESPath-frågesträng för JSON-utdata.

Nästa steg

Mer information om Azure CLI finns i Azure CLI-dokumentationen.

Du hittar ytterligare Azure Logic Apps CLI-skriptexempel i Microsofts kodexempelwebbläsare.

Sedan kan du skapa en exempelapplogik via Azure CLI med hjälp av ett exempelskript och en arbetsflödesdefinition.

Skapa logikapp med hjälp av exempelskript.