Rychlý start: Vytváření a správa pracovních postupů pomocí Azure CLI v Azure Logic Apps

Článek
01/04/2024

Platí pro: Azure Logic Apps (Consumption)

Tento rychlý start ukazuje, jak vytvářet a spravovat automatizované pracovní postupy, které běží v Azure Logic Apps pomocí rozšíření Azure CLI Logic Apps (az logic). Z příkazového řádku můžete vytvořit aplikaci logiky Consumption ve víceklientské službě Azure Logic Apps pomocí souboru JSON pro definici pracovního postupu aplikace logiky. Aplikaci logiky pak můžete spravovat spuštěním operací, jako listjsou , show (get), updatea delete z příkazového řádku.

Upozornění

Rozšíření Azure CLI Logic Apps je v současné době experimentální a nevztahuje se na ně zákaznická podpora. Toto rozšíření rozhraní příkazového řádku používejte opatrně, zejména pokud se rozhodnete rozšíření používat v produkčních prostředích.

Tento rychlý start se v současné době vztahuje jenom na pracovní postupy aplikací logiky Consumption, které běží ve víceklientech Azure Logic Apps. Azure CLI je momentálně nedostupné pro pracovní postupy standardní aplikace logiky, které běží v Azure Logic Apps s jedním tenantem. Další informace najdete v tématu Rozdíly typu prostředku a hostitele v Azure Logic Apps.

Pokud s Azure Logic Apps teprve začínáte, přečtěte si, jak vytvořit svůj první pracovní postup aplikace logiky Consumption prostřednictvím Azure Portal, v sadě Visual Studio a v editoru Visual Studio Code.

Požadavky

Účet Azure s aktivním předplatným. Pokud nemáte předplatné Azure, vytvořte si bezplatný účet.
Azure CLI nainstalované na místním počítači.
Rozšíření Rozhraní příkazového řádku Azure Logic Apps nainstalované na vašem počítači. K instalaci tohoto rozšíření použijte tento příkaz: az extension add --name logic
Skupina prostředků Azure, ve které se má vytvořit aplikace logiky.

Kontrola předpokladů

Než začnete, ověřte své prostředí:

Přihlaste se k Azure Portal a spuštěním az loginpříkazu zkontrolujte, jestli je vaše předplatné aktivní.
Zkontrolujte verzi Azure CLI v terminálu nebo příkazovém okně spuštěním příkazu az --version. Nejnovější verzi najdete v poznámkách k nejnovější verzi.

Pokud nemáte nejnovější verzi, aktualizujte instalaci podle průvodce instalací pro váš operační systém nebo platformu.

Příklad – Vytvoření skupiny prostředků

Pokud ještě nemáte skupinu prostředků pro vaši aplikaci logiky, vytvořte skupinu pomocí příkazu az group create. Následující příkaz například vytvoří skupinu prostředků s názvem testResourceGroup v umístění westus.

az group create --name testResourceGroup --location westus

Ve výstupu se provisioningState zobrazí hodnota jako Succeeded při úspěšném vytvoření vaší skupiny prostředků:

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

Definice pracovního postupu

Před vytvořením nové aplikace logiky nebo aktualizací stávající aplikace logiky pomocí Azure CLI potřebujete definici pracovního postupu pro vaši aplikaci logiky. V Azure Portal můžete zobrazit základní definici pracovního postupu aplikace logiky ve formátu JSON přepnutím ze zobrazení Návrháře do zobrazení kódu.

Když spustíte příkazy pro vytvoření nebo aktualizaci aplikace logiky, nahraje se definice pracovního postupu jako požadovaný parametr (--definition). Musíte vytvořit definici pracovního postupu jako soubor JSON, který se řídí schématem jazyka definice pracovního postupu.

Vytváření aplikací logiky z rozhraní příkazového řádku

Pokud chcete vytvořit pracovní postup aplikace logiky z Azure CLI, použijte pro definici příkaz az logic workflow create se souborem JSON.

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]

Příkaz musí obsahovat následující požadované parametry:

Parametr	Hodnota	Popis
Definice pracovního postupu	`--definition`	Soubor JSON s definicí pracovního postupu aplikace logiky
Umístění	`--location -l`	Oblast Azure, ve které se nachází vaše aplikace logiky.
Název	`--name -n`	Název vaší aplikace logiky. Název může obsahovat pouze písmena, číslice, spojovníky (`-`), podtržítka (`_`), závorky (`()`) a tečky (`.`). Název musí být také jedinečný napříč oblastmi.
Název skupiny prostředků	`--resource-group -g`	Skupina prostředků Azure, ve které chcete vytvořit aplikaci logiky. Pokud ještě nemáte skupinu prostředků pro svou aplikaci logiky, vytvořte ji před zahájením.

Můžete také přidat další volitelné parametry pro konfiguraci řízení přístupu k aplikaci logiky, koncových bodů, účtu integrace, prostředí integrační služby, stavu a značek prostředků.

Příklad – Vytvoření aplikace logiky

V tomto příkladu se pracovní postup s názvem testLogicApp vytvoří ve skupině testResourceGroup prostředků v umístění westus. Soubor testDefinition.json JSON obsahuje definici pracovního postupu.

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

Po úspěšném vytvoření pracovního postupu se v rozhraní příkazového řádku zobrazí kód JSON vaší nové definice pracovního postupu. Pokud se vytvoření pracovního postupu nezdaří, projděte si seznam možných chyb.

Aktualizace aplikací logiky z rozhraní příkazového řádku

Pokud chcete aktualizovat pracovní postup aplikace logiky z Azure CLI, použijte příkaz az logic workflow create.

Příkaz musí obsahovat stejné požadované parametry jako při vytváření aplikace logiky. Můžete také přidat stejné volitelné parametry jako při vytváření aplikace logiky.

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]

Příklad – aktualizace aplikace logiky

V tomto příkladu se ukázkový pracovní postup vytvořený v předchozí části aktualizuje tak, aby používal jiný definiční soubor JSON, newTestDefinition.jsona přidal dvě značky testTag1 prostředků s testTag2 hodnotami popisu.

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

Po úspěšné aktualizaci pracovního postupu se v rozhraní příkazového řádku zobrazí aktualizovaná definice pracovního postupu vaší aplikace logiky. Pokud aktualizace selže, projděte si seznam možných chyb.

Odstranění aplikací logiky z rozhraní příkazového řádku

Pokud chcete odstranit pracovní postup aplikace logiky z Azure CLI, použijte příkaz az logic workflow delete.

Příkaz musí obsahovat následující požadované parametry:

Parametr	Hodnota	Popis
Název	`--name -n`	Název vaší aplikace logiky.
Název skupiny prostředků	`-resource-group -g`	Skupina prostředků, ve které se nachází vaše aplikace logiky.

Můžete také přidat volitelný parametr , který přeskočí výzvy k potvrzení: --yes -y.

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

Rozhraní příkazového řádku vás pak vyzve k potvrzení odstranění aplikace logiky. Příkazový řádek s potvrzením můžete přeskočit pomocí volitelného parametru --yes -y .

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

Pokud chcete potvrdit odstranění aplikace logiky, vypište aplikace logiky v rozhraní příkazového řádku nebo zobrazte aplikace logiky v Azure Portal.

Příklad – Odstranění aplikace logiky

V tomto příkladu se odstraní ukázkový pracovní postup vytvořený v předchozí části .

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

Jakmile odpovíte na výzvu k potvrzení pomocí ypříkazu , aplikace logiky se odstraní.

Důležité informace – Odstranění aplikace logiky

Odstranění aplikace logiky ovlivní instance pracovního postupu následujícími způsoby:

Azure Logic Apps se snaží zrušit všechna probíhající a čekající spuštění.

I u velkého objemu nebo backlogu se většina spuštění před dokončením nebo spuštěním zruší. Dokončení procesu zrušení ale může nějakou dobu trvat. Mezitím mohou být některá spuštění vyzvednuta ke spuštění, zatímco modul runtime funguje procesem zrušení.
Azure Logic Apps nevytáčí ani nespouští nové instance pracovního postupu.
Pokud pracovní postup odstraníte a pak znovu vytvoříte stejný pracovní postup, nebude mít znovu vytvořený pracovní postup stejná metadata jako odstraněný pracovní postup. Musíte znovu uložit jakýkoli pracovní postup, který nazval odstraněný pracovní postup. Tímto způsobem volající získá správné informace o znovuvytvořeném pracovním postupu. Jinak volání znovuvytvořeného pracovního postupu selžou s chybou Unauthorized . Toto chování platí také pro pracovní postupy, které používají artefakty v účtech integrace a pracovních postupech, které volají azure functions.

Zobrazení aplikací logiky v rozhraní příkazového řádku

Pokud chcete získat konkrétní pracovní postup aplikace logiky, použijte příkaz az logic workflow show.

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

Příkaz musí obsahovat následující požadované parametry.

Parametr	Hodnota	Popis
Název	`--name -n`	Název vaší aplikace logiky.
Název skupiny prostředků	`--resource-group -g`	Název skupiny prostředků, ve které se nachází vaše aplikace logiky.

Příklad – Získání aplikace logiky

V tomto příkladu se aplikace testLogicApp logiky ve skupině testResourceGroup prostředků vrátí s úplnými protokoly pro ladění.

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

Výpis aplikací logiky v rozhraní příkazového řádku

K zobrazení seznamu aplikací logiky podle předplatného použijte příkaz az logic workflow list. Tento příkaz vrátí kód JSON pro pracovní postupy vaší aplikace logiky.

Výsledky můžete filtrovat podle následujících volitelných parametrů:

Parametr	Hodnota	Popis
Název skupiny prostředků	`--resource-group -g`	Název skupiny prostředků, podle které chcete filtrovat výsledky.
Počet položek	`--top`	Počet položek, které jsou zahrnuté ve výsledcích.
Filtrovat	`--filter`	Typ filtru, který používáte v seznamu. Můžete filtrovat podle stavu (`State`), triggeru (`Trigger`) a identifikátoru odkazovaného prostředku (`ReferencedResourceId`).

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

Příklad – Výpis aplikací logiky

V tomto příkladu jsou všechny povolené pracovní postupy ve skupině testResourceGroup prostředků vráceny ve formátu tabulky ASCII.

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

Chyby

Následující chyba značí, že není nainstalované rozšíření Rozhraní příkazového řádku Azure Logic Apps. Postupujte podle pokynů v požadavcích a nainstalujte do počítače rozšíření Logic Apps .

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

Následující chyba může znamenat, že cesta k souboru pro nahrání definice pracovního postupu je nesprávná.

Expecting value: line 1 column 1 (char 0)

Globální parametry

S příkazy můžete použít následující volitelné globální parametry az logic Azure CLI:

Parametr	Hodnota	Popis
Výstupní formát	`--output -o`	Změňte formát výstupu z výchozího formátu JSON.
Zobrazit jenom chyby	`--only-show-errors`	Potlačí upozornění a zobrazí jenom chyby.
Verbose	`--verbose`	Zobrazit podrobné protokoly.
Ladění	`--debug`	Zobrazí všechny protokoly ladění.
Zpráva nápovědy	`--help -h`	Zobrazit dialogové okno nápovědy
Dotaz	`--query`	Nastavte řetězec dotazu JMESPath pro výstup JSON.

Další kroky

Další informace o Azure CLI najdete v dokumentaci k Azure CLI.

Další ukázky skriptů Rozhraní příkazového řádku pro Azure Logic Apps najdete v prohlížeči ukázek kódu od Microsoftu.

Dále můžete vytvořit ukázkovou logiku aplikace prostřednictvím Azure CLI pomocí ukázkového skriptu a definice pracovního postupu.

Vytvořte aplikaci logiky pomocí ukázkového skriptu.