Démarrage rapide : Créer une application Durable Functions Python

Article
08/25/2024

Utilisez Durable Functions, une fonctionnalité d’Azure Functions, pour écrire des fonctions avec état dans un environnement serverless. Vous installez Durable Functions en installant l’extension Azure Functions dans Visual Studio Code. L’extension gère l’état, les points de contrôle et les redémarrages dans votre application.

Dans démarrage rapide, vous utilisez l’extension Durable Functions dans Visual Studio Code pour créer et tester localement une application Durable Functions « hello world » dans Azure Functions. L’application Durable Functions orchestre et chaîne les appels à d’autres fonctions. Ensuite, vous publiez le code de la fonction dans Azure. Les outils que vous utilisez sont disponibles via l’extension Visual Studio Code.

Capture d’écran de l’application Durable Functions en cours d’exécution dans Azure.

Prérequis

Pour effectuer ce démarrage rapide, les éléments suivants sont requis :

Visual Studio Code installé.
L’extension Azure Functions de Visual Studio Code installée.
La version la plus récente d’Azure Functions Core Tools installée.
Un outil de test HTTP qui garde vos données en sécurité. Pour plus d’informations, consultez Outils de test HTTP.
Un abonnement Azure. Pour utiliser Durable Functions, vous devez disposer d’un compte de stockage Azure.
Python version 3.7, 3.8, 3.9 ou 3.10 installé.

Si vous n’avez pas d’abonnement Azure, créez un compte gratuit Azure avant de commencer.

Créer votre projet local

Dans cette section, vous utilisez Visual Studio Code pour créer un projet Azure Functions local.

Dans Visual Studio Code, sélectionnez F1 (ou Ctrl/Cmd+Maj+P) pour ouvrir la palette de commandes. À l’invite (>), entrez puis sélectionnez Azure Functions : Créer un projet.
Cliquez sur Parcourir. Dans la boîte de dialogue Sélectionner un dossier, accédez à un dossier à utiliser pour votre projet, puis choisissez Sélectionner.

En suivant les invites, saisissez les informations suivantes :

Prompt	Action	Description
Sélectionner un langage pour votre projet d’application de fonction	Sélectionnez Python.	Crée un projet Functions Python local.
Sélectionner une version	Sélectionnez Azure Functions v4.	Vous voyez cette option seulement quand Core Tools n’est pas déjà installé. Dans ce cas, Core Tools est installé la première fois que vous exécutez l’application.
Version de Python	Sélectionnez Python 3.7, Python 3.8, Python 3.9 ou Python 3.10.	Visual Studio Code crée un environnement virtuel en utilisant la version que vous sélectionnez.
Sélectionner un modèle pour la première fonction de votre projet	Sélectionnez Ignorer pour le moment.
Sélectionner la façon dont vous souhaitez ouvrir votre projet	Sélectionnez Ouvrir dans la fenêtre actuelle.	Ouvre Visual Studio Code dans le dossier que vous avez sélectionné.

En suivant les invites, saisissez les informations suivantes :

Prompt	Valeur	Description
Sélectionner une langue	Sélectionnez Python (Modèle de programmation V2).	Crée un projet Functions Python local en utilisant le modèle de programmation V2.
Sélectionner une version	Sélectionnez Azure Functions v4.	Vous voyez cette option seulement quand Core Tools n’est pas déjà installé. Dans ce cas, Core Tools est installé la première fois que vous exécutez l’application.
Version de Python	Sélectionnez Python 3.7, Python 3.8, Python 3.9 ou Python 3.10.	Visual Studio Code crée un environnement virtuel en utilisant la version que vous sélectionnez.
Sélectionner la façon dont vous souhaitez ouvrir votre projet	Sélectionnez Ouvrir dans la fenêtre actuelle.	Ouvre Visual Studio Code dans le dossier que vous avez sélectionné.

Visual Studio Code installe Azure Functions Core Tools s’il est nécessaire pour créer un projet. Il crée également un projet d’application de fonction dans un dossier. Ce projet contient les fichiers config host.json et local.settings.json.

Un fichier requirements.txt est également créé dans le dossier racine. Il spécifie les packages Python requis pour exécuter votre application de fonction.

Installer azure-functions-durable à partir de PyPI

Quand vous créez le projet, l’extension Azure Functions de Visual Studio Code crée automatiquement un environnement virtuel avec la version de Python que vous avez sélectionnée. Vous devez alors activer l’environnement virtuel dans un terminal et installer certaines dépendances requises par Azure Functions et Durable Functions.

Ouvrez le fichier requirements.txt dans l’éditeur et remplacez son contenu par le code suivant :
```
azure-functions
azure-functions-durable
```
Dans le dossier actif, ouvrez le terminal intégré de l’éditeur (Ctrl+Maj+’).
Dans le terminal intégré, activez l’environnement virtuel dans le dossier actif, selon votre système d’exploitation.
- Linux
- macOS
- Windows
```
source .venv/bin/activate
```
```
source .venv/bin/activate
```
```
.venv\scripts\activate
```

Ensuite, dans le terminal intégré où l’environnement virtuel est activé, utilisez pip pour installer les packages que vous avez définis.

python -m pip install -r requirements.txt

Créer vos fonctions

L’application Durable Functions la plus simple a trois fonctions :

Fonction d’orchestrateur : un workflow qui orchestre d’autres fonctions.
Fonction d’activité : une fonction appelée par la fonction d’orchestrateur ; elle effectue un travail et retourne éventuellement une valeur.
Fonction de client : une fonction normale dans Azure qui démarre une fonction d’orchestrateur. Cet exemple utilise une fonction déclenchée par HTTP.

Fonction d’orchestrateur

Vous utilisez un modèle pour créer le code de l’application Durable Functions dans votre projet.

Dans la palette de commandes, entrez puis sélectionnez Azure Functions : Créer une fonction.

En suivant les invites, saisissez les informations suivantes :

Prompt	Action	Description
Sélectionner un modèle pour votre fonction	Sélectionnez Orchestrateur Durable Functions.	Crée une orchestration d’application Durable Functions.
Fournir un nom de fonction	Sélectionnez HelloOrchestrator.	Un nom pour votre fonction durable.

Vous avez ajouté un orchestrateur pour coordonner les fonctions d’activité. Ouvrez HelloOrchestrator/__init__.py pour voir la fonction d’orchestrateur. Chaque appel à context.call_activity appelle une fonction d’activité nommée Hello.

Ensuite, vous ajoutez la fonction d’activité Hello référencée.

Fonction d’activité

Dans la palette de commandes, entrez puis sélectionnez Azure Functions : Créer une fonction.

En suivant les invites, saisissez les informations suivantes :

Prompt	Action	Description
Sélectionner un modèle pour votre fonction	Sélectionnez Activité Durable Functions.	Crée une fonction d’activité.
Fournir un nom de fonction	Entrez Hello.	Le nom de votre fonction d’activité.

Vous avez ajouté la fonction d’activité Hello qui est appelée par l’orchestrateur. Ouvrez Hello/__init__.py pour voir qu’elle accepte un nom comme entrée et retourne un message d’accueil. Une fonction d’activité vous permet d’effectuer des actions, comme faire un appel de base de données ou exécuter un calcul.

Pour terminer, vous ajoutez une fonction déclenchée par HTTP qui démarre l’orchestration.

Fonction de client (démarrage HTTP)

Dans la palette de commandes, entrez puis sélectionnez Azure Functions : Créer une fonction.

En suivant les invites, saisissez les informations suivantes :

Prompt	Action	Description
Sélectionner un modèle pour votre fonction	Sélectionnez Démarrage HTTP Durable Functions.	Crée une fonction de démarrage HTTP.
Fournir un nom de fonction	Entrez DurableFunctionsHttpStart.	Le nom de votre fonction cliente
Niveau d’autorisation	Sélectionnez Anonyme.	À des fins de démonstration, cette valeur permet à la fonction d’être appelée sans utiliser d’authentification.

Vous avez ajouté une fonction déclenchée par HTTP qui démarre une orchestration. Ouvrez DurableFunctionsHttpStart/__init__.py pour voir qu’elle se sert de client.start_new pour démarrer une nouvelle orchestration. Elle utilise ensuite client.create_check_status_response pour retourner une réponse HTTP contenant des URL qui peuvent être utilisées pour superviser et gérer la nouvelle orchestration.

Vous disposez maintenant d’une application Durable Functions qui peut être exécutée localement, et déployée sur Azure.

Spécifications

La version 2 du modèle de programmation Python nécessite les versions minimales suivantes :

Azure Functions Runtime v4.16+
Azure Functions Core Tools v4.0.5095+ (en cas d’exécution locale)
azure-functions-durable v1.2.4+

Activer le modèle de programmation v2

Le paramètre d’application suivant est requis pour exécuter le modèle de programmation v2 :

Nom : AzureWebJobsFeatureFlags
Valeur : EnableWorkerIndexing

Si vous exécutez localement en utilisant Azure Functions Core Tools, ajoutez ce paramètre à votre fichier local.settings.json. Si vous exécutez dans Azure, effectuez les étapes suivantes en utilisant un outil approprié :

Remplacez <FUNCTION_APP_NAME> et <RESOURCE_GROUP_NAME> par le nom de votre application de fonction et du groupe de ressources, respectivement.

az functionapp config appsettings set --name <FUNCTION_APP_NAME> --resource-group <RESOURCE_GROUP_NAME> --settings AzureWebJobsFeatureFlags=EnableWorkerIndexing

Remplacez <FUNCTION_APP_NAME> et <RESOURCE_GROUP_NAME> par le nom de votre application de fonction et du groupe de ressources, respectivement.

Update-AzFunctionAppSetting -Name <FUNCTION_APP_NAME> -ResourceGroupName <RESOURCE_GROUP_NAME> -AppSetting @{"AzureWebJobsFeatureFlags" = "EnableWorkerIndexing"}

Vérifiez que l’extension Azure Functions pour Visual Studio Code est installée.
Sélectionnez F1 pour ouvrir la palette de commandes. À l’invite (>), entrez puis sélectionnez Azure Functions : Ajouter un nouveau paramètre.
Sélectionnez votre abonnement et votre application de fonction quand vous y êtes invité.
Pour le nom, entrez AzureWebJobsFeatureFlags, puis sélectionnez Entrée.
Pour la valeur, entrez EnableWorkerIndexing, puis sélectionnez Entrée.

Pour créer une application Durable Functions de base en utilisant ces trois types de fonctions, remplacez le contenu de function_app.py par le code Python suivant :

import azure.functions as func
import azure.durable_functions as df

myApp = df.DFApp(http_auth_level=func.AuthLevel.ANONYMOUS)

# An HTTP-triggered function with a Durable Functions client binding
@myApp.route(route="orchestrators/{functionName}")
@myApp.durable_client_input(client_name="client")
async def http_start(req: func.HttpRequest, client):
    function_name = req.route_params.get('functionName')
    instance_id = await client.start_new(function_name)
    response = client.create_check_status_response(req, instance_id)
    return response

# Orchestrator
@myApp.orchestration_trigger(context_name="context")
def hello_orchestrator(context):
    result1 = yield context.call_activity("hello", "Seattle")
    result2 = yield context.call_activity("hello", "Tokyo")
    result3 = yield context.call_activity("hello", "London")

    return [result1, result2, result3]

# Activity
@myApp.activity_trigger(input_name="city")
def hello(city: str):
    return f"Hello {city}"

Consultez le tableau suivant pour obtenir une explication de chaque fonction et de son objectif dans l’exemple :

Méthode	Description
`hello_orchestrator`	Fonction d’orchestrateur, qui décrit le flux de travail. Dans ce cas, l’orchestration démarre, appelle trois fonctions dans une séquence, puis retourne les résultats des 3 fonctions triés dans une liste.
`hello`	La fonction d’activité, qui effectue le travail orchestré. La fonction retourne un message d’accueil simple à la ville passée en tant qu’argument.
`http_start`	Une fonction déclenchée par HTTP qui démarre une instance de l’orchestration et retourne une réponse `check status`.

Remarque

Durable Functions prend également en charge les blueprints Python v2. Pour utiliser des blueprints, inscrivez vos fonctions blueprint en utilisant la Blueprintclasse azure-functions-durable. Vous pouvez inscrire le blueprint résultant comme d’habitude. Vous pouvez utiliser notre exemple.

Tester la fonction en local

Azure Functions Core Tools vous permet d’exécuter un projet Azure Functions sur votre ordinateur de développement local. S’ils ne sont pas installés, vous êtes invité à installer ces outils la première fois que vous démarrez une fonction dans Visual Studio Code.

Pour tester votre fonction, définissez un point d’arrêt dans le code de la fonction d’activité Hello (dans Hello/__init__.py). Sélectionnez F5 ou Déboguer : Démarrer le débogage dans la palette de commandes pour démarrer le projet d’application de fonction. La sortie de Core Tools s’affiche dans le panneau Terminal.

Remarque

Pour plus d’informations sur le débogage, consultez Diagnostics Durable Functions.

Pour tester votre fonction, définissez un point d’arrêt dans le hello code de la fonction d’activité. Sélectionnez F5 ou Déboguer : Démarrer le débogage dans la palette de commandes pour démarrer le projet d’application de fonction. La sortie de Core Tools s’affiche dans le panneau Terminal.

Remarque

Pour plus d’informations sur le débogage, consultez Diagnostics Durable Functions.

L’exécution de Durable Functions nécessite un compte de stockage Azure. Lorsque Visual Studio Code vous invite à sélectionner un compte de stockage, choisissez Sélectionner un compte de stockage.

Aux invites, fournissez les informations suivantes pour créer un compte de stockage dans Azure.

Prompt	Action	Description
Sélectionner un abonnement	Sélectionnez le nom de votre abonnement.	Votre abonnement Azure.
Sélectionner un compte de stockage	sélectionnez Créer un compte de stockage.
Entrer le nom du nouveau compte de stockage	Entrez un nom unique.	Nom du compte de stockage à créer.
Sélectionner un groupe de ressources	Entrez un nom unique.	Nom du groupe de ressources à créer.
Sélectionner un emplacement	Sélectionnez une région Azure dans le champ Region (Région).	Sélectionnez une région proche de vous.

Dans le panneau Terminal, copiez le point de terminaison d’URL de votre fonction déclenchée par HTTP.

Utilisez votre navigateur ou un outil de test HTTP pour envoyer une requête HTTP POST au point de terminaison d’URL.

Remplacez le dernier segment par le nom de la fonction d’orchestrateur (HelloOrchestrator). L’URL doit ressembler à http://localhost:7071/api/orchestrators/HelloOrchestrator.

La réponse est le résultat initial de la fonction HTTP. Elle vous permet de savoir que l’orchestration durable a démarré correctement. Elle n’affiche pas encore le résultat final de l’orchestration. La réponse contient plusieurs URL utiles. Pour le moment, interrogez l’état de l’orchestration.
Copiez la valeur de l’URL pour statusQueryGetUri, collez-la dans la barre d’adresse de votre navigateur, puis exécutez la requête. Vous pouvez également continuer à utiliser votre outil de test HTTP pour émettre la requête GET.

La requête interroge l’instance d’orchestration pour obtenir l’état. Vous devez voir que l’instance s’est terminée, et qu’elle inclut les sorties ou les résultats de la fonction durable. Elle se présente de façon similaire à cet exemple :
```
{
    "name": "HelloOrchestrator",
    "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a",
    "runtimeStatus": "Completed",
    "input": null,
    "customStatus": null,
    "output": [
        "Hello Tokyo!",
        "Hello Seattle!",
        "Hello London!"
    ],
    "createdTime": "2020-03-18T21:54:49Z",
    "lastUpdatedTime": "2020-03-18T21:54:54Z"
}
```

Utilisez votre navigateur ou un outil de test HTTP pour envoyer une requête HTTP POST au point de terminaison d’URL.

Remplacez le dernier segment par le nom de la fonction d’orchestrateur (HelloOrchestrator). L’URL doit ressembler à http://localhost:7071/api/orchestrators/HelloOrchestrator.

La réponse est le résultat initial de la fonction HTTP. Elle vous permet de savoir que l’orchestration durable a démarré correctement. Elle n’affiche pas encore le résultat final de l’orchestration. La réponse contient plusieurs URL utiles. Pour le moment, interrogez l’état de l’orchestration.
Copiez la valeur de l’URL pour statusQueryGetUri, collez-la dans la barre d’adresse de votre navigateur, puis exécutez la requête. Vous pouvez également continuer à utiliser votre outil de test HTTP pour émettre la requête GET.

La requête interroge l’instance d’orchestration pour obtenir l’état. Vous devez voir que l’instance s’est terminée, et qu’elle inclut les sorties ou les résultats de la fonction durable. Elle se présente de façon similaire à cet exemple :
```
{
    "name": "hello_orchestrator",
    "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a",
    "runtimeStatus": "Completed",
    "input": null,
    "customStatus": null,
    "output": [
        "Hello Tokyo!",
        "Hello Seattle!",
        "Hello London!"
    ],
    "createdTime": "2020-03-18T21:54:49Z",
    "lastUpdatedTime": "2020-03-18T21:54:54Z"
}
```

Pour arrêter le débogage, dans Visual Studio Code, sélectionnez Maj+F5.

Après avoir vérifié que la fonction s’exécute correctement sur votre ordinateur local, vous pouvez publier le projet sur Azure.

Avant de pouvoir créer des ressources Azure ou de publier votre application, vous devez vous connecter à Azure.

Si vous n’êtes pas encore connecté, dans la Barre d’activité, sélectionnez l’icône Azure. Ensuite, sous Ressources, sélectionnez Se connecter à Azure.

Si vous êtes déjà connecté et que vous pouvez voir vos abonnements existants, accédez à la section suivante. Si vous n’avez pas encore de compte Azure, Créez un compte Azure. Les étudiants peuvent sélectionner Créer un compte Azure for Students.
Quand vous y êtes invité dans le navigateur, sélectionnez votre compte Azure et connectez-vous avec vos informations d’identification de compte Azure. Si vous créez un compte, vous pouvez vous connecter une fois votre compte créé.
Une fois la connexion réussie, vous pouvez fermer la nouvelle fenêtre de navigateur. Les abonnements qui appartiennent à votre compte Azure sont affichés dans la barre latérale.

Créer l’application de fonction dans Azure

Dans cette section, vous créez une application de fonction et les ressources associées dans votre abonnement Azure. La plupart des décisions de création de ressources sont prises pour vous en fonction des comportements par défaut. Pour plus de contrôle sur les ressources créées, vous devez plutôt créer votre application de fonction avec des options avancées.

Dans Visual Studio Code, sélectionnez F1 pour ouvrir la palette de commandes. À l’invite (>), entrez puis sélectionnez Azure Functions : Créer une application de fonction dans Azure.

En suivant les invites, saisissez les informations suivantes :

Prompt	Action
Sélectionner un abonnement	Sélectionnez l’abonnement Azure à utiliser. L’invite n’apparaît pas quand vous n’avez qu’un seul abonnement visible sous Ressources.
Entrer un nom global unique pour l’application de fonction	Entrez un nom qui est valide dans un chemin d’URL. Le système vérifie que le nom que vous entrez est unique dans Azure Functions.
Sélectionner une pile d’exécution	Sélectionnez la version du langage que vous exécutez localement actuellement.
Sélectionnez un emplacement pour les nouvelles ressources	Sélectionnez une région Azure dans le champ Region (Région). Pour de meilleures performances, sélectionnez une région proche de vous.

Dans le panneau Azure : Journal d’activité, l’extension Azure affiche l’état des ressources individuelles à mesure qu’elles sont créées dans Azure.

Capture d’écran du journal de la création de ressources Azure.

Quand l’application de fonction est créée, les ressources associées suivantes sont créées dans votre abonnement Azure. Les ressources sont nommées en fonction du nom que vous avez entré pour votre application de fonction.
- Un groupe de ressources, qui est un conteneur logique pour les ressources associées.
- Un compte Stockage Azure standard, qui conserve l’état et d’autres informations spécifiques à vos projets.
- Une application de fonction, qui fournit l’environnement d’exécution de votre code de fonction. Une application de fonction vous permet de regrouper des fonctions en une unité logique pour faciliter la gestion, le déploiement et le partage des ressources au sein du même plan d’hébergement.
- Un plan Azure App Service, qui définit l’hôte sous-jacent pour votre application de fonction.
- Une instance Application Insights connectée à l’application de fonction et qui fait le suivi de l’utilisation de vos fonctions dans l’application.
Une notification s’affiche après que votre application de fonction a été créée et que le package de déploiement a été appliqué.

Conseil

Par défaut, les ressources Azure nécessaires pour votre application de fonction sont créées selon le nom que vous avez saisi pour votre application de fonction. Par défaut, les ressources sont créées avec l’application de fonction dans le même nouveau groupe de ressources. Si vous voulez personnaliser les noms des ressources associées ou réutiliser des ressources existantes, publiez le projet en utilisant les options de création avancées.

Déployer le projet dans Azure

Important

Le déploiement vers une application de fonction existante remplace toujours le contenu de cette application dans Azure.

Dans la palette de commandes, entrez puis sélectionnez Azure Functions : Déployer sur une application de fonction.
Sélectionnez l’application de fonction que vous venez de créer. Quand vous êtes invité à remplacer les déploiements précédents, sélectionnez Déployer pour déployer le code de votre fonction sur la nouvelle ressource de l’application de fonction.
Une fois le déploiement terminé, sélectionnez Afficher la sortie pour voir les résultats de la création et du déploiement, y compris les ressources Azure que vous avez créées. Si vous manquez la notification, sélectionnez l’icône de cloche dans le coin inférieur droit pour la voir à nouveau.

Tester votre fonction dans Azure

Copiez l’URL du déclencheur HTTP à partir du panneau de sortie. L’URL qui appelle la fonction déclenchée par HTTP doit avoir le format suivant :

https://<functionappname>.azurewebsites.net/api/orchestrators/HelloOrchestrator

Copiez l’URL du déclencheur HTTP à partir du panneau de sortie. L’URL qui appelle la fonction déclenchée par HTTP doit avoir le format suivant :

https://<functionappname>.azurewebsites.net/api/orchestrators/hello_orchestrator

Collez la nouvelle URL pour la requête HTTP dans la barre d’adresse de votre navigateur. Quand vous utilisez l’application publiée, vous pouvez vous attendre à obtenir la même réponse d’état que celle que vous avez obtenue quand vous l’avez testée localement.

L’application Durable Functions Python que vous avez créée et publiée en utilisant Visual Studio Code est prête à être utilisée.

Nettoyer les ressources

Si vous n’avez plus besoin des ressources que vous avez créées pour suivre le démarrage rapide, pour éviter les coûts associés dans votre abonnement Azure, supprimez le groupe de ressources et toutes les ressources associées.

Découvrez les modèles d’application Durable Functions courants.

Partage via

Démarrage rapide : Créer une application Durable Functions Python

Prérequis

Créer votre projet local

Installer azure-functions-durable à partir de PyPI

Créer vos fonctions

Fonction d’orchestrateur

Fonction d’activité

Fonction de client (démarrage HTTP)

Spécifications

Activer le modèle de programmation v2

Tester la fonction en local

Créer l’application de fonction dans Azure

Déployer le projet dans Azure

Tester votre fonction dans Azure

Nettoyer les ressources

Commentaires

Ressources supplémentaires

Partage via

Démarrage rapide : Créer une application Durable Functions Python

Prérequis

Créer votre projet local

Installer azure-functions-durable à partir de PyPI

Créer vos fonctions

Fonction d’orchestrateur

Fonction d’activité

Fonction de client (démarrage HTTP)

Spécifications

Activer le modèle de programmation v2

Tester la fonction en local

Connexion à Azure

Créer l’application de fonction dans Azure

Déployer le projet dans Azure

Tester votre fonction dans Azure

Nettoyer les ressources

Contenu connexe

Commentaires

Ressources supplémentaires