Démarrage rapide : Créer et gérer des workflows avec Azure CLI dans Azure Logic Apps

Article
01/04/2024

S’applique à : Azure Logic Apps (Consommation)

Ce guide de démarrage rapide montre comment créer et gérer des workflows automatisés qui s’exécutent dans Azure Logic Apps en utilisant l’extension Logic Apps d’Azure CLI (az logic). À partir de la ligne de commande, vous pouvez créer une application logique Consommation dans une application Azure Logic Apps multilocataire en utilisant le fichier JSON pour une définition de workflow d’application logique. Vous pouvez ensuite gérer votre application logique en exécutant des commandes telles que list, show (get), update et delete à partir de la ligne de commande.

Avertissement

L’extension Logic Apps d’Azure CLI, actuellement expérimentale, ne bénéficie pas d’un support technique. Utilisez-la CLI avec précaution, en particulier si vous choisissez de l’utiliser dans des environnements de production.

Ce guide de démarrage rapide s’applique actuellement seulement aux workflows d’application logique Consommation qui s’exécutent dans des applications Azure Logic Apps multilocataires. Azure CLI n’est actuellement pas disponible pour les workflows d’application logique Standard qui s’exécutent dans une application Azure Logic Apps monolocataire. Pour plus d’informations, consultez Différences de type de ressource et d’hôte dans Azure Logic Apps.

Si vous débutez avec Azure Logic Apps, découvrez comment créer votre premier workflow d’application logique Consommation via le portail Azure, dans Visual Studio et dans Visual Studio Code.

Prérequis

Compte Azure avec un abonnement actif. Si vous n’avez pas d’abonnement Azure, créez un compte gratuit.
Azure CLI installé sur votre ordinateur local.
L’extension CLI d’Azure Logic Apps installée sur votre ordinateur. Pour installer cette extension, utilisez la commande suivante : az extension add --name logic
Groupe de ressources Azure dans lequel créer votre application logique.

Vérification de la configuration requise

Avant de commencer, vérifiez votre environnement :

Connectez-vous au portail Azure et vérifiez que votre abonnement est actif en exécutant la commande az login.
Vérifiez votre version d’Azure CLI dans un terminal ou une fenêtre de commande en exécutant az --version. Pour obtenir la version la plus récente, consultez les notes de publication les plus récentes.

Si vous ne disposez pas de la dernière version, mettez à jour votre installation en suivant le guide d’installation pour votre système d’exploitation ou votre plateforme.

Exemple - Créer un groupe de ressources

Si ne disposez pas encore d’un groupe de ressources pour votre application logique, créez-en un avec la commande az group create. Par exemple, la commande suivante crée un groupe de ressources nommé testResourceGroup à l’emplacement westus.

az group create --name testResourceGroup --location westus

Une fois votre groupe de ressources créé, la sortie affiche l’état provisioningStateSucceeded :

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

Définition de flux de travail

Avant de créer une application logique ou de mettre à jour une application logique existante à l’aide d’Azure CLI, vous avez besoin d’une définition de flux de travail pour votre application logique. Dans le portail Azure, vous pouvez afficher la définition de flux de travail sous-jacente de votre application logique au format JSON en basculant du Mode Création en Mode Code.

Lorsque vous exécutez les commandes pour créer ou mettre à jour votre application logique, votre définition de flux de travail est chargée en tant que paramètre obligatoire (--definition). Vous devez créer votre définition de flux de travail sous la forme d’un fichier JSON qui suit le schéma de langage de définition de flux de travail.

Créer des applications logiques à partir de CLI

Pour créer un workflow d’application logique à partir d’Azure CLI, utilisez la commande az logic workflow create avec un fichier JSON pour la définition.

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]

Votre commande doit inclure les paramètres requis suivants :

Paramètre	Valeur	Description
Définition de flux de travail	`--definition`	Fichier JSON avec la définition de flux de travail de votre application logique.
Emplacement	`--location -l`	Région Azure dans laquelle se trouve votre application logique.
Nom	`--name -n`	Nom de votre application logique. Le nom peut contenir uniquement des lettres, des chiffres, des traits d’union (`-`), des traits de soulignement (`_`), des parenthèses (`()`), et des points (`.`). Le nom doit également être unique dans les régions.
Nom de groupe ressources	`--resource-group -g`	Groupe de ressources Azure dans lequel vous souhaitez créer votre application logique. Créez un groupe de ressources avant de commencer si vous n’en avez pas déjà un pour votre application logique.

Vous pouvez également inclure des paramètres facultatifs supplémentaires pour configurer les contrôles d’accès, les points de terminaison, le compte d’intégration, l’environnement du service d’intégration, l’état et les balises de ressource de votre application logique.

Exemple - Créer une application logique

Dans cet exemple, un flux de travail nommé testLogicApp est créé dans le groupe de ressources testResourceGroup à l’emplacement westus. Le fichier JSON testDefinition.json contient la définition de flux de travail.

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

Une fois votre flux de travail correctement créé, l’interface CLI affiche le code JSON de votre nouvelle définition de flux de travail. Si la création de votre flux de travail échoue, consultez la liste des erreurs possibles.

Mettre à jour des applications logiques à partir de l’interface CLI

Pour mettre à jour le workflow d’une application logique à partir d’Azure CLI, utilisez la commande az logic workflow create.

Votre commande doit inclure les mêmes les paramètres requis que lorsque vous créez une application logique. Vous pouvez également ajouter les mêmes paramètres facultatifs que lors de la création d’une application logique.

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]

Exemple - Mettre à jour une application logique

Dans cet exemple, l’exemple de flux de travail créé dans la section précédente est mis à jour pour utiliser un autre fichier de définition JSON, newTestDefinition.json, et ajouter deux balises de ressource, testTag1 et testTag2, avec des valeurs de description.

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

Une fois votre flux de travail mis à jour, l’interface CLI affiche la définition de flux de travail mise à jour de votre application logique. Si votre mise à jour échoue, consultez la liste des erreurs possibles.

Supprimer des applications logiques de l’interface CLI

Pour supprimer le workflow d’une application logique à partir d’Azure CLI, utilisez la commande az logic workflow delete.

Votre commande doit inclure les paramètres requis suivants :

Paramètre	Valeur	Description
Nom	`--name -n`	Nom de votre application logique.
Nom de groupe ressources	`-resource-group -g`	Groupe de ressources dans lequel se trouve votre application logique.

Vous pouvez également inclure un paramètre facultatif, --yes -y, pour ignorer les invites de confirmation.

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

L’interface CLI vous invite ensuite à confirmer la suppression de votre application logique. Vous pouvez ignorer l’invite de confirmation en utilisant le paramètre facultatif --yes -y avec votre commande.

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

Pour vérifier la suppression d’une application logique, listez vos applications logiques dans l’interface CLI ou visualisez vos applications logiques dans le portail Azure.

Exemple - Supprimer une application logique

Dans cet exemple, l’exemple de flux de travail créé dans une section précédente est supprimé.

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

Une fois que vous avez répondu à l’invite de confirmation en tapant y, l’application logique est supprimée.

Considérations liées à la suppression d’une application logique

Voici de quelles manières la suppression d’une application logique affecte les instances de workflow :

Azure Logic Apps met tout en œuvre pour annuler les exécutions en cours et en attente.

Même avec un gros volume ou un backlog important, la plupart des exécutions sont annulées avant qu’elles ne finissent ou ne démarrent. Toutefois, le processus d’annulation peut prendre du temps. Il peut arriver que certaines exécutions soient lancées dans l’intervalle.
Le service Azure Logic Apps ne crée ni n’exécute pas de nouvelles instances de flux de travail.
Si, après avoir supprimé un workflow, vous recréez le même, les métadonnées de ce dernier sont différentes de celles du workflow supprimé. Vous devez enregistrer de nouveau les workflows qui ont appelé le workflow supprimé. L’appelant obtient ainsi les bonnes informations sur le workflow recréé. Dans le cas contraire, les appels au workflow recréé échouent avec une erreur Unauthorized. Ce comportement s’applique aussi aux workflows qui utilisent des artefacts dans les comptes d’intégration et les workflows qui appellent des fonctions Azure.

Afficher des applications logiques dans l’interface CLI

Pour obtenir un workflow d’application logique spécifique, utilisez la commande az logic workflow show.

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

Votre commande doit inclure les paramètres obligatoires suivants.

Paramètre	Valeur	Description
Nom	`--name -n`	Nom de votre application logique.
Nom de groupe ressources	`--resource-group -g`	Nom du groupe de ressources dans lequel se trouve votre application logique.

Exemple - Obtenir une application logique

Dans cet exemple, l’application logique testLogicApp dans le groupe de ressources testResourceGroup est retournée avec des journaux complets pour le débogage.

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

Répertorier les applications logiques dans l’interface CLI

Pour lister vos applications logiques par abonnement, utilisez la commande az logic workflow list. Cette commande retourne le code JSON pour les workflows de votre application logique.

Vous pouvez filtrer vos résultats à l’aide des paramètres facultatifs suivants :

Paramètre	Valeur	Description
Nom de groupe ressources	`--resource-group -g`	Nom du groupe de ressources sur lequel vous souhaitez filtrer les résultats.
Nombre d’éléments	`--top`	Nombre d’éléments inclus dans vos résultats.
Filtrer	`--filter`	Type de filtre que vous utilisez dans votre liste. Vous pouvez filtrer par état (`State`), déclencheur (`Trigger`) et identificateur de la ressource référencée (`ReferencedResourceId`).

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

Exemple - Lister les applications logiques

Dans cet exemple, tous les flux de travail activés dans le groupe de ressources testResourceGroup sont retournés sous la forme d’une table ASCII.

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

Erreurs

L’erreur suivante indique que l’extension CLI d’Azure Logic Apps n’est pas installée. Suivez les étapes des prérequis pour installer l’extension Logic Apps sur votre ordinateur.

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

L’erreur suivante peut indiquer que le chemin d’accès du fichier pour le chargement de la définition de votre flux de travail est incorrect.

Expecting value: line 1 column 1 (char 0)

Paramètres globaux

Vous pouvez utiliser les paramètres Azure CLI globaux facultatifs suivants avec vos commandes az logic :

Paramètre	Valeur	Description
Format de sortie	`--output -o`	Modifiez le format de sortie à partir du JSON par défaut.
Afficher uniquement les erreurs	`--only-show-errors`	Supprimer les avertissements et n’afficher que les erreurs.
Commentaires	`--verbose`	Afficher des journaux d’activité détaillés.
Débogage	`--debug`	Afficher tous les journaux de débogage.
Message d’aide	`--help -h`	Afficher la boîte de dialogue d’aide.
Requête	`--query`	Définir une chaîne de requête JMESPath pour la sortie JSON.

Étapes suivantes

Pour plus d’informations sur l’interface Azure CLI, consultez la documentation relative à l’interface Azure CLI.

Vous trouverez des exemples supplémentaires de scripts CLI Azure Logic Apps dans le navigateur d’exemples de code de Microsoft.

Ensuite, vous pouvez créer un exemple d’application logique à l’aide d’Azure CLI en utilisant un exemple de script et de définition de workflow.

Créer une application logique à l’aide d’un exemple de script.