Démarrage rapide : déployer une application API RESTful sur Azure Spring Apps

Remarque

Les plans Essentiel, Standard et Entreprise seront déconseillés à compter de la mi-mars 2025, avec une période de mise hors service de 3 ans. Nous vous recommandons de passer à Azure Container Apps. Pour plus d’informations, consultez l’annonce de mise hors service d’Azure Spring Apps.

Le plan de consommation standard et dédiée sera déconseillé à compter du 30 septembre 2024, avec un arrêt complet après six mois. Nous vous recommandons de passer à Azure Container Apps. Pour plus d’informations, consultez Migrer le plan de consommation standard et dédiée Azure Spring Apps vers Azure Container Apps.

Cet article décrit comment déployer une application API RESTful protégée par Microsoft Entra ID sur Azure Spring Apps. L’exemple de projet est une version simplifiée basée sur l’application web Simple Todo, qui fournit uniquement le service backend et utilise Microsoft Entra ID pour protéger les API RESTful.

Ces API RESTful sont protégées grâce à l’application du contrôle d’accès en fonction du rôle (RBAC). Les utilisateurs anonymes ne peuvent pas accéder à des données et ne sont pas autorisés à contrôler l’accès pour différents utilisateurs. Les utilisateurs anonymes disposent uniquement des trois autorisations suivantes :

• Lecture : avec cette autorisation, un utilisateur peut lire les données ToDo.
• Écriture : avec cette autorisation, un utilisateur peut ajouter ou mettre à jour les données ToDo.
• Suppression : avec cette autorisation, un utilisateur peut supprimer les données ToDo.

Une fois le déploiement réussi, vous pouvez afficher et tester les API via l’interface utilisateur Swagger.

Le diagramme suivant présente l’architecture du système :

Cet article décrit les options suivantes pour créer des ressources et les déployer sur Azure Spring Apps :

• L’option Portail Azure + plug-in Maven fournit un moyen plus conventionnel de créer des ressources et de déployer des applications pas à pas. Cette option convient aux développeurs Spring qui utilisent les services cloud Azure pour la première fois.
• L’option Azure Developer CLI est un moyen plus efficace de créer automatiquement des ressources et de déployer des applications par le biais de commandes simples. Azure Developer CLI utilise un modèle pour provisionner les ressources Azure nécessaires et déployer le code de l’application. Cette option convient aux développeurs Spring qui sont familiarisés avec les services cloud Azure.

Cet article décrit les options suivantes pour créer des ressources et les déployer sur Azure Spring Apps :

• L’option Portail Azure + plug-in Maven fournit un moyen plus conventionnel de créer des ressources et de déployer des applications pas à pas. Cette option convient aux développeurs Spring qui utilisent les services cloud Azure pour la première fois.
• L'option Azure CLI utilise un puissant outil de ligne de commande pour gérer les ressources Azure. Cette option convient aux développeurs Spring qui sont familiarisés avec les services cloud Azure.

1. Prérequis

Portail Azure + plug-in Maven

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

• Un des rôles suivants :

  • Administrateur général ou Administrateur de rôle privilégié, pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API.
  • Administrateur d’application cloud ou Administrateur d’application pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API, à l’exception des rôles d’application Microsoft Graph (autorisations d’application).
  • Rôle d’annuaire personnalisé qui comprend l’autorisation d’accorder des autorisations aux applications, pour les autorisations requises par l’application.

  Pour plus d’informations, consultez Accorder le consentement administrateur au niveau locataire à une application.

• Si vous déployez une instance du plan Entreprise Azure Spring Apps pour la première fois dans l’abonnement cible, consultez la section Exigences du Plan Entreprise dans la Place de marché Azure.

• Git.

• Kit de développement Java (JDK), version 17.

• Un locataire Microsoft Entra. Pour obtenir des instructions sur la création d’un locataire, consultez Démarrage rapide : créer un locataire dans Microsoft Entra ID.

Azure CLI

• Un abonnement Azure : si vous n’en avez pas, créez un compte Azure gratuit avant de commencer.

• Un des rôles suivants :

  • Administrateur général ou Administrateur de rôle privilégié, pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API.
  • Administrateur d’application cloud ou Administrateur d’application pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API, à l’exception des rôles d’application Microsoft Graph (autorisations d’application).
  • Rôle d’annuaire personnalisé qui comprend l’autorisation d’accorder des autorisations aux applications, pour les autorisations requises par l’application.

  Pour plus d’informations, consultez Accorder le consentement administrateur au niveau locataire à une application.

• Si vous déployez une instance du plan Entreprise Azure Spring Apps pour la première fois dans l’abonnement cible, consultez la section Exigences du Plan Entreprise dans la Place de marché Azure.

• Git.

• Kit de développement Java (JDK), version 17.

• Un locataire Microsoft Entra. Pour obtenir des instructions sur la création d’un locataire, consultez Démarrage rapide : créer un locataire dans Microsoft Entra ID.

• Azure CLI version 2.53.1 ou ultérieure.

Portail Azure + plug-in Maven

• Un abonnement Azure : si vous n’en avez pas, créez un compte Azure gratuit avant de commencer.

• Un des rôles suivants :

  • Administrateur général ou Administrateur de rôle privilégié, pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API.
  • Administrateur d’application cloud ou Administrateur d’application pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API, à l’exception des rôles d’application Microsoft Graph (autorisations d’application).
  • Rôle d’annuaire personnalisé qui comprend l’autorisation d’accorder des autorisations aux applications, pour les autorisations requises par l’application.

  Pour plus d’informations, consultez Accorder le consentement administrateur au niveau locataire à une application.

• Git.

• Kit de développement Java (JDK), version 17.

• Un locataire Microsoft Entra. Pour obtenir des instructions sur la création d’un locataire, consultez Démarrage rapide : créer un locataire dans Microsoft Entra ID.

Azure Developer CLI

• Un abonnement Azure : si vous n’en avez pas, créez un compte Azure gratuit avant de commencer.

• Un des rôles suivants :

  • Administrateur général ou Administrateur de rôle privilégié, pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API.
  • Administrateur d’application cloud ou Administrateur d’application pour l’octroi de consentement pour les applications qui demandent une autorisation pour toute API, à l’exception des rôles d’application Microsoft Graph (autorisations d’application).
  • Rôle d’annuaire personnalisé qui comprend l’autorisation d’accorder des autorisations aux applications, pour les autorisations requises par l’application.

  Pour plus d’informations, consultez Accorder le consentement administrateur.

• Git.

• Kit de développement Java (JDK), version 17.

• Un locataire Microsoft Entra. Pour obtenir des instructions sur la création d’un locataire, consultez Démarrage rapide : créer un locataire dans Microsoft Entra ID.

• Azure Developer CLI (AZD),, version 1.0.2 ou ultérieure.

2. Préparer le projet Spring

Pour déployer l’application API RESTful, la première étape consiste à préparer le projet Spring afin de l’exécuter localement.

Procédez comme suit pour cloner et exécuter l’application localement :

1. Utilisez la commande suivante pour cloner l’exemple de projet à partir de GitHub :

   git clone https://github.com/Azure-Samples/ASA-Samples-Restful-Application.git
   

2. Si vous souhaitez exécuter l’application localement, commencez par suivre les étapes décrites dans les sections Exposer les API RESTful et Mettre à jour la configuration de l’application, puis utilisez la commande suivante pour exécuter l’exemple d’application avec Maven :

   cd ASA-Samples-Restful-Application
   ./mvnw spring-boot:run
   

3. Préparer l’environnement cloud

Pour exécuter cet exemple d’application, les principales ressources requises sont une instance Azure Spring Apps et une instance Azure Database pour PostgreSQL. Dans les sections suivantes, découvrez comment créer ces ressources.

Portail Azure + plug-in Maven

3.1. Connectez-vous au portail Azure.

Accédez au Portail Microsoft Azure et entrez vos informations d’identification pour vous connecter au portail. Il s’ouvre par défaut sur le tableau de bord des services.

3.2. Créer une instance Azure Spring Apps

Utilisez les étapes suivante pour créer une instance de service Azure Spring Apps :

1. Sélectionnez Créer une ressource dans le coin du portail Azure.

2. Sélectionnez Calcul>Azure Spring Apps.

3. Remplissez le formulaire Informations de base avec les informations suivantes :

   Paramètre	Valeur suggérée	Description
   Abonnement	Nom de votre abonnement.	Abonnement Azure que vous souhaitez utiliser pour votre serveur. Si vous disposez de plusieurs abonnements, choisissez celui dans lequel vous souhaitez que la ressource soit facturée.
   Groupe de ressources	myresourcegroup	Un nouveau nom de groupe de ressources ou un nom de groupe existant dans votre abonnement.
   Nom	myasa	Nom unique qui identifie votre instance Azure Spring Apps. Le nom doit comporter entre 4 et 32 caractères, et contenir uniquement des lettres minuscules, des chiffres et des traits d’union. Le premier caractère du nom du service doit être une lettre, et le dernier doit être une lettre ou un chiffre.
   Planifier	Entreprise	Plan tarifaire qui détermine la ressource et le coût associés à votre instance.
   Région	La région la plus proche de vos utilisateurs.	L’emplacement géographique le plus proche de vos utilisateurs.
   Redondant interzone	Non sélectionné	Option permettant de créer votre service Azure Spring Apps dans une zone de disponibilité Azure. Cette fonctionnalité n’est actuellement pas prise en charge dans toutes les régions.
   Plan IP logiciel	Paiement à l’utilisation	Plan tarifaire qui vous permet de payer au fur et à mesure à l’aide d’Azure Spring Apps.
   Terms	Volumes sélectionnés	Case à cocher du contrat associée à l’offre de la Place de marché. Vous devez cocher cette case.
   Déployer l’exemple de projet	Non sélectionné	Option permettant d’utiliser l’exemple d’application intégré.

4. Sélectionnez Vérifier et créer pour passer en revue vos sélections. Ensuite, sélectionnez Créer pour approvisionner l’instance Azure Spring Apps.

5. Dans la barre d’outils, sélectionnez l’icône Notifications (en forme de cloche) pour surveiller le processus de déploiement. Une fois le déploiement terminé, vous pouvez sélectionner Épingler au tableau de bord, ce qui crée une vignette pour ce service dans votre tableau de bord du Portail Microsoft Azure, en tant que raccourci vers la page Vue d’ensemble du service.

   

6. Sélectionnez Accéder à la ressource pour accéder à la page Vue d’ensemble d’Azure Spring Apps.

3.3. Préparer l’instance PostgreSQL

Suivez la procédure ci-dessous pour créer un serveur Azure Database pour PostgreSQL :

1. Accédez au Portail Azure et sélectionnez Créer une ressource.

2. Sélectionnez Bases de données>Azure Database pour PostgreSQL.

3. Sélectionnez l’option de déploiement Serveur flexible.

   

4. Renseignez l’onglet Informations de base avec les informations suivantes :

   • Nom du serveur : my-demo-pgsql
   • Région : USA Est
   • Version PostgreSQL : 14
   • Type de charge de travail : Développement
   • Activer la haute disponibilité : désélectionné
   • Méthode d’authentification : Authentification PostgreSQL uniquement
   • Nom d’utilisateur administrateur : myadmin
   • Mot de passe et Confirmer le mot de passe : entrez un mot de passe.

5. Utilisez les informations suivantes pour configurer l’onglet Mise en réseau :

   • Méthode de connectivité : Accès public (adresses IP autorisées)
   • Autoriser l’accès public à partir d’un service Azure dans Azure sur ce serveur : sélectionné

6. Sélectionnez Examiner et créer pour passer en revue vos sélections, puis sélectionnez Créer pour approvisionner le serveur. Cette opération peut prendre quelques minutes.

7. Accédez à votre serveur PostgreSQL dans le portail Azure. Dans la page Vue d’ensemble, recherchez la valeur Nom du serveur, puis enregistrez-la pour une utilisation ultérieure. Vous devez configurer les variables d’environnement de l’application dans Azure Spring Apps.

8. Sélectionnez Bases de données dans le menu de navigation pour créer une base de données, par exemple ; todo.

   

3.4. Connecter une instance d’application à une instance PostgreSQL

Suivez la procédure ci-dessous pour connecter vos instances de service :

1. Accédez à votre instance Azure Spring Apps dans le portail Azure.

2. Dans le menu de navigation, ouvrez Applications, puis sélectionnez Créer une application.

3. Dans la page Créer une application, renseignez le nom de l’application simple-todo-api, puis sélectionnez Artefacts Java comme type de déploiement.

4. Sélectionnez Créer pour terminer la création de l’application, puis sélectionnez l’application pour en afficher les détails.

5. Accédez à l’application que vous avez créée dans le Portail Azure. Dans la page Vue d’ensemble, sélectionnez Attribuer un point de terminaison pour exposer le point de terminaison public pour l’application. Enregistrez l’URL pour accéder à l’application après le déploiement.

6. Sélectionnez Connecteur de service dans le volet de navigation, puis sélectionnez Créer pour créer une nouvelle connexion de service.

   

7. Renseignez l’onglet Informations de base avec les informations suivantes :

   • Type de service : Serveur flexible DB pour PostgreSQL
   • Nom de connexion : un nom généré automatiquement est rempli et peut également être modifié.
   • Abonnement : sélectionnez votre abonnement.
   • Serveur flexible PostgreSQL : my-demo-pgsql
   • Base de données PostgreSQL : sélectionnez la base de données que vous avez créée.
   • Type de client : SpringBoot

   

8. Configurez l’onglet Suivant : Authentification avec les informations suivantes :

   • Sélectionnez le type d’authentification que vous souhaitez utiliser entre votre service de calcul et le service cible. : sélectionnez Chaîne de connexion.
   • Continuer avec... : sélectionnez Informations d’identification de la base de données
   • Nom d’utilisateur : myadmin
   • Mot de passe : entrez votre mot de passe.

   

9. Sélectionnez Suivant : Réseau. Utilisez l’option par défaut Configurer des règles de pare-feu pour activer l’accès au service cible.

10. Sélectionnez Vérifier + créer pour passer en revue vos sélections, puis sélectionnez Créer pour créer la connexion.

3.5. Exposer les API RESTful

Pour exposer vos API RESTful dans Microsoft Entra ID, procédez comme suit :

1. Connectez-vous au portail Azure.

2. Si vous avez accès à plusieurs locataires, utilisez le filtre Répertoire + abonnement () pour sélectionner le locataire dans lequel vous voulez inscrire une application.

3. Recherchez et sélectionnez Microsoft Entra ID.

4. Sous Gérer, sélectionnez Inscriptions d’applications>Nouvelle inscription.

5. Entrez un nom pour votre application dans le champ Nom, par exemple, Todo. Les utilisateurs de votre application peuvent voir ce nom, et vous pouvez le changer ultérieurement.

6. Pour Types de comptes pris en charge, sélectionnez Comptes de tout répertoire d’organisation (tout répertoire Microsoft Entra : multilocataire) et comptes Microsoft personnels.

7. Sélectionnez Inscrire pour créer l’application.

8. Dans la page Vue d’ensemble de l’application, recherchez la valeur ID d’application (client) , puis notez-la pour une utilisation ultérieure. Vous en avez besoin pour configurer le fichier de configuration YAML pour ce projet.

9. Sous Gérer, sélectionnez Exposer une API, trouvez l’URI de l’ID d’application au début de la page, puis sélectionnez Ajouter.

10. Dans la page Modifier l’URI de l’ID d’application, acceptez l’URI proposé de l’ID d’application (api://{client ID}) ou utilisez un nom utile au lieu de l’ID client, comme api://simple-todo, puis sélectionnez Enregistrer.

11. Sous Gérer, sélectionnez Exposer une API>Ajouter une étendue, puis entrez les informations suivantes :

    • Pour Nom de l’étendue, entrez ToDo.Read.
    • Pour Qui peut donner son consentement ?, sélectionnez Administrateurs et utilisateurs.
    • Pour Nom d’affichage du consentement administrateur, entrez Lire les données ToDo.
    • Pour Description du consentement administrateur, entrez Autoriser les utilisateurs authentifiés à lire les données ToDo.
    • Pour État, maintenez l’état Activé.
    • Sélectionnez Ajouter une étendue.

12. Répétez les étapes précédentes pour ajouter les deux autres étendus : ToDo.Write et ToDo.Delete.

    

3.6. Mettre à jour la configuration de l’application

Procédez comme suit pour mettre à jour le fichier YAML afin d’utiliser les informations de votre application inscrite Microsoft Entra pour établir une relation avec l’application API RESTful :

1. Recherchez le fichier src/main/resources/application.yml pour l’application simple-todo-api. Mettez à jour la configuration dans la section spring.cloud.azure.active-directory pour qu’elle corresponde à l’exemple suivant. Veillez à remplacer les espaces réservés par les valeurs que vous avez créées précédemment.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Remarque

   Dans les jetons v1.0, la configuration nécessite l’ID client de l’API, tandis que dans les jetons v2.0, vous pouvez utiliser l’ID client ou l’URI d’ID d’application dans la requête. Vous pouvez configurer les deux types de jetons pour effectuer correctement la validation de l’audience.

   Les valeurs autorisées pour tenant-id sont : common, organizations, consumersou l’ID de locataire. Pour plus d’informations sur ces valeurs, consultez la section Utilisation d’un point de terminaison incorrect (comptes personnels et d’organisation) de l’article Erreur AADSTS50020 : Le compte d’utilisateur du fournisseur d’identité n’existe pas dans le locataire. Pour plus d’informations sur la conversion de votre application monolocataire, consultez Convertir une application monolocataire en application multilocataire sur Microsoft Entra ID.

2. Utilisez la commande suivante pour régénérer l’échantillon de projet :

   ./mvnw clean package
   

Azure CLI

3.1. Donner des noms à chaque ressource

Créez des variables destinées à contenir les noms de ressources à l’aide des commandes suivantes. Veillez à remplacer les espaces réservés par vos valeurs.

export RESOURCE_GROUP=myresourcegroup
export LOCATION=<location>
export POSTGRESQL_SERVER=my-demo-pgsql
export POSTGRESQL_DB=Todo
export POSTGRESQL_ADMIN_USERNAME=<admin-username>
export POSTGRESQL_ADMIN_PASSWORD=<admin-password>
export AZURE_SPRING_APPS_NAME=myasa
export APP_NAME=simple-todo-api
export TODO_APP_NAME=Todo
export TODO_APP_URL=api://simple-todo
export TODOWEB_APP_NAME=TodoWeb
export TODOWEB_APP_URL=api://simple-todoweb
export NEW_MEMBER_USERNAME=<new-member-username>
export NEW_MEMBER_PASSWORD=<new-member-password>
export USER_PRINCIPAL_NAME=<user-principal-name>

3.2. Création d’un groupe de ressources

Procédez comme suit pour créer un groupe de ressources :

1. Utilisez la commande suivante pour vous connecter à Azure CLI :

   az login
   

2. Utilisez la commande suivante pour définir la localisation par défaut :

   az configure --defaults location=${LOCATION}
   

3. Utilisez la commande suivante pour répertorier tous les abonnements disponibles, puis déterminez l’ID d’abonnement à utiliser :

   az account list --output table
   

4. Utilisez la commande suivante pour définir votre abonnement par défaut :

   az account set --subscription <subscription-ID>
   

5. Utilisez la commande suivante pour créer un groupe de ressources :

   az group create --resource-group ${RESOURCE_GROUP}
   

6. Utilisez la commande suivante pour définir le groupe de ressources nouvellement créé comme groupe de ressources par défaut :

   az configure --defaults group=${RESOURCE_GROUP}
   

3.3. Installer l’extension et inscrire l’espace de noms

Utilisez les commandes suivantes pour installer l’extension Azure Spring Apps pour Azure CLI et inscrire l’espace de noms Microsoft.SaaS :

az extension add --name spring --upgrade
az provider register --namespace Microsoft.SaaS

3.4. Créer une instance Azure Spring Apps

Procédez comme suit pour créer une instance de service et une application dans l’instance :

1. Utilisez la commande suivante pour accepter les conditions d’utilisation et la déclaration de confidentialité du plan Entreprise :

   Remarque

   Cette étape est nécessaire uniquement si votre abonnement n’a jamais été utilisé pour créer une instance de niveau Entreprise d’Azure Spring Apps.

   az term accept \
       --publisher vmware-inc \
       --product azure-spring-cloud-vmware-tanzu-2 \
       --plan asa-ent-hr-mtr
   

2. Utilisez la commande suivante pour créer une instance de service Azure Spring Apps :

   az spring create --name ${AZURE_SPRING_APPS_NAME} --sku enterprise
   

3. Utilisez la commande suivante pour créer une application dans l’instance Azure Spring Apps :

   az spring app create \
       --service ${AZURE_SPRING_APPS_NAME} \
       --name ${APP_NAME} \
       --assign-endpoint true
   

3.5. Préparer l’instance PostgreSQL

L’application web Spring utilise H2 pour la base de données dans localhost et Azure Database pour PostgreSQL pour la base de données dans Azure.

Utilisez la commande suivante pour créer une instance PostgreSQL :

az postgres flexible-server create \
    --name ${POSTGRESQL_SERVER} \
    --database-name ${POSTGRESQL_DB} \
    --admin-user ${POSTGRESQL_ADMIN_USERNAME} \
    --admin-password ${POSTGRESQL_ADMIN_PASSWORD} \
    --public-access 0.0.0.0

La spécification de 0.0.0.0 permet l’accès public à votre serveur à partir de toutes les ressources déployées dans Azure.

3.6. Connecter une instance d’application à une instance PostgreSQL

Après avoir créé l’instance d’application et l’instance PostgreSQL, l’instance d’application ne peut pas accéder directement à l’instance PostgreSQL. Effectuez les étapes suivantes pour permettre à l’application de se connecter à l’instance PostgreSQL :

1. Utilisez la commande suivante pour obtenir le nom de domaine complet de l’instance PostgreSQL :

   export PSQL_FQDN=$(az postgres flexible-server show \
       --name ${POSTGRESQL_SERVER} \
       --query fullyQualifiedDomainName \
       --output tsv)
   

2. Utilisez la commande suivante pour fournir les propriétés spring.datasource. à l’application via des variables d’environnement :

   az spring app update \
       --service ${AZURE_SPRING_APPS_NAME} \
       --name ${APP_NAME} \
       --env SPRING_DATASOURCE_URL="jdbc:postgresql://${PSQL_FQDN}:5432/${POSTGRESQL_DB}?sslmode=require" \
             SPRING_DATASOURCE_USERNAME="${POSTGRESQL_ADMIN_USERNAME}" \
             SPRING_DATASOURCE_PASSWORD="${POSTGRESQL_ADMIN_PASSWORD}"
   

3.7. Exposer les API RESTful

Pour exposer les API RESTful, procédez comme suit :

1. Utilisez la commande suivante pour créer une application Microsoft Entra ID :

   az ad app create \
       --display-name ${TODO_APP_NAME} \
       --sign-in-audience AzureADandPersonalMicrosoftAccount \
       --identifier-uris ${TODO_APP_URL}
   

2. Utilisez la commande suivante pour créer un principal de service pour l’application :

   az ad sp create --id ${TODO_APP_URL}
   

3. Utilisez la commande suivante pour générer des ID d’autorisation :

   permissionid1=$(uuidgen);permissionid2=$(uuidgen);permissionid3=$(uuidgen)
   

4. Ajoutez les étendues suivantes au format JSON :

   api=$(echo '{
    "oauth2PermissionScopes": [
        {
            "adminConsentDescription": "Allows authenticated users to delete the ToDo data",
            "adminConsentDisplayName": "Delete the ToDo data",
            "id": "'$permissionid1'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Delete"
        },
   
        {
            "adminConsentDescription": "Allows authenticated users to write the ToDo data",
            "adminConsentDisplayName": "Write the ToDo data",
            "id": "'$permissionid2'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Write"
        },
        {
            "adminConsentDescription": "Allows authenticated users to read the ToDo data",
            "adminConsentDisplayName": "Read the ToDo data",
            "id": "'$permissionid3'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Read"
        }
    ]}')
   

5. Utilisez la commande suivante pour ajouter des étendues :

   az ad app update \
       --id ${TODO_APP_URL} \
       --set api="$api"
   

6. Utilisez la commande suivante pour obtenir l’ID de locataire à utiliser dans l’étape suivante :

   az account show --query "tenantId" --output tsv
   

7. Utilisez la commande suivante pour obtenir l’ID d’application à utiliser dans les étapes suivantes :

   appid=$(az ad app show \
       --id ${TODO_APP_URL} \
       --query appId \
       --output tsv);
   echo $appid
   

3.8. Mettre à jour la configuration de l’application

Procédez comme suit pour mettre à jour le fichier YAML afin d’utiliser les informations de votre application inscrite Microsoft Entra pour établir une relation avec l’application API RESTful :

1. Recherchez le fichier src/main/resources/application.yml pour l’application simple-todo-api. Mettez à jour la configuration dans la section spring.cloud.azure.active-directory pour qu’elle corresponde à l’exemple suivant. Veillez à remplacer les espaces réservés par les valeurs que vous avez créées précédemment.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Remarque

   Dans les jetons v1.0, la configuration nécessite l’ID client de l’API, tandis que dans les jetons v2.0, vous pouvez utiliser l’ID client ou l’URI d’ID d’application dans la requête. Vous pouvez configurer les deux types de jetons pour effectuer correctement la validation de l’audience.

   Les valeurs autorisées pour tenant-id sont : common, organizations, consumersou l’ID de locataire. Pour plus d’informations sur ces valeurs, consultez la section Utilisation d’un point de terminaison incorrect (comptes personnels et d’organisation) de l’article Erreur AADSTS50020 : Le compte d’utilisateur du fournisseur d’identité n’existe pas dans le locataire. Pour plus d’informations sur la conversion de votre application monolocataire, consultez Convertir une application monolocataire en application multilocataire sur Microsoft Entra ID.

2. Utilisez la commande suivante pour régénérer l’échantillon de projet :

   ./mvnw clean package
   

4. Déployer l’application sur Azure Spring Apps

Portail Azure + plug-in Maven

Vous pouvez maintenant déployer l’application sur Azure Spring Apps.

Utilisez la procédure suivante pour le déploiement en utilisant le plug-in Maven pour Azure Spring Apps :

1. Accédez au répertoire complete, puis exécutez la commande suivante pour configurer l’application dans Azure Spring Apps :

   ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
   

   La liste suivante décrit les interactions de commande :

   • Connexion OAuth2 : vous devez autoriser la connexion à Azure en fonction du protocole OAuth2.
   • Sélectionnez un abonnement : sélectionnez le numéro de liste d’abonnements de l’instance Azure Spring Apps créée, qui correspond par défaut au premier abonnement de la liste. Si vous utilisez le nombre par défaut, appuyez directement sur Entrée.
   • Utiliser Azure Spring Apps dans Azure : appuyez sur y (oui) pour utiliser l’instance Azure Spring Apps existante.
   • Sélectionner Azure Spring Apps pour le déploiement : sélectionnez le numéro de l’instance Azure Spring Apps que vous avez créée. Si vous utilisez le nombre par défaut, appuyez directement sur Entrée.
   • Utiliser l’application existante dans Azure Spring Apps <your-instance-name> : appuyez sur y (oui) pour utiliser l’application créée.
   • Confirmez pour enregistrer toutes les configurations ci-dessus : appuyez sur y (oui). Si vous entrez N, la configuration n’est pas enregistrée dans les fichiers POM.

2. Utilisez la commande suivante pour déployer l’application :

   ./mvnw azure-spring-apps:deploy
   

   La liste suivante décrit l’interaction de commande :

   • Connexion OAuth2 : vous devez autoriser la connexion à Azure en fonction du protocole OAuth2.

   Une fois la commande exécutée, les messages de journal suivants indiquent que le déploiement a réussi :

[INFO] Deployment Status: Running
[INFO]   InstanceName:simple-todo-api-default-15-xxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:N/A       
[INFO] Getting public url of app(simple-todo-api)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-simple-todo-api.azuremicroservices.io

Azure CLI

Utilisez la commande suivante pour déployer l’application en fonction du code source :

az spring app deploy \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${APP_NAME} \
    --build-env BP_JVM_VERSION=17 \
    --source-path .

5. Valider l’application

Portail Azure + plug-in Maven

Vous pouvez désormais accéder à l’API RESTful pour voir si cela fonctionne.

5.1. Demander un jeton d’accès

Les API RESTful agissent en tant que serveur de ressources, qui est protégé par Microsoft Entra ID. Avant d’acquérir un jeton d’accès, vous devez inscrire une autre application dans Microsoft Entra ID et accorder des autorisations à l’application cliente, nommée ToDoWeb.

Inscrire l’application cliente

Procédez comme suit pour inscrire une application dans Microsoft Entra ID, qui est utilisé pour ajouter les autorisations pour l’application ToDo :

1. Connectez-vous au portail Azure.

2. Si vous avez accès à plusieurs locataires, utilisez le filtre Répertoire + abonnement () pour sélectionner le locataire dans lequel vous voulez inscrire une application.

3. Recherchez et sélectionnez Microsoft Entra ID.

4. Sous Gérer, sélectionnez Inscriptions d’applications>Nouvelle inscription.

5. Entrez un nom pour votre application dans le champ Nom, par exemple, ToDoWeb. Les utilisateurs de votre application peuvent voir ce nom, et vous pouvez le changer ultérieurement.

6. Pour Types de comptes pris en charge, utilisez la valeur par défaut Comptes dans ce répertoire d’organisation uniquement.

7. Sélectionnez Inscrire pour créer l’application.

8. Dans la page Vue d’ensemble de l’application, recherchez la valeur ID d’application (client) , puis notez-la pour une utilisation ultérieure. Vous en avez besoin pour obtenir un jeton d'accès.

9. Sélectionnez Autorisations des API>Ajouter une autorisation>Mes API. Sélectionnez l’application ToDo que vous avez inscrite précédemment, puis sélectionnez les autorisations ToDo.Read, ToDo.Write et ToDo.Delete. Sélectionnez Ajouter des autorisations.

10. Sélectionnez Accorder le consentement de l’administrateur pour <votre-nom-de-locataire> afin d’accorder le consentement administrateur aux autorisations que vous avez ajoutées.

    

Ajouter un utilisateur pour accéder aux API RESTful

Procédez comme suit pour créer un utilisateur membre dans votre locataire Microsoft Entra. Ensuite, l’utilisateur peut gérer les données de l’application ToDo via des API RESTful.

1. Sous Gérer, sélectionnez Utilisateurs>Nouvel utilisateur>Créer un utilisateur.

2. Dans la page Créer un utilisateur, indiquez les informations suivantes :

   • Nom d’utilisateur principal : entrez un nom pour l’utilisateur.
   • Nom d’affichage : entrez un nom d’affichage pour l’utilisateur.
   • Mot de passe : copiez le mot de passe généré automatiquement fourni dans le champ Mot de passe.

   Remarque

   Les nouveaux utilisateurs doivent effectuer la première authentification de connexion et mettre à jour leurs mots de passe, sinon une erreur AADSTS50055: The password is expired s’affiche lorsqu’ils obtiennent le jeton d’accès.

   Lorsqu’un nouvel utilisateur se connecte, il reçoit une invite Action requise. Il peut choisir Demander ultérieurement pour ignorer la validation.

3. Sélectionnez Vérifier + créer pour passer en revue vos sélections. Sélectionnez Créer pour créer l’utilisateur.

Mettre à jour la configuration OAuth2 pour l’autorisation de l’interface utilisateur Swagger

Procédez comme suit pour mettre à jour la configuration OAuth2 pour l’autorisation de l’interface utilisateur Swagger. Vous pouvez ensuite autoriser les utilisateurs à acquérir des jetons d’accès via l’application ToDoWeb.

1. Ouvrez votre locataire Microsoft Entra ID dans le Portail Azure et accédez à l’application inscrite ToDoWeb.

2. Sous Gérer, sélectionnez Authentification, Ajouter une plateforme, puis Application monopage.

3. Utilisez le format <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html comme URL de redirection OAuth2 dans le champ URI de redirection, puis sélectionnez Configurer.

   

Azure CLI

Vous pouvez désormais accéder à l’API RESTful pour voir si cela fonctionne.

5.1. Demander un jeton d’accès

Les API RESTful agissent en tant que serveur de ressources, qui est protégé par Microsoft Entra ID. Avant d’acquérir un jeton d’accès, vous devez inscrire une autre application dans Microsoft Entra ID et accorder des autorisations à l’application cliente, nommée ToDoWeb.

Inscrire l’application cliente

Pour inscrire l’application cliente, procédez comme suit :

1. Utilisez la commande suivante pour créer une application Microsoft Entra ID, utilisée pour ajouter les autorisations pour l’application ToDo :

   az ad app create \
       --display-name ${TODOWEB_APP_NAME} \
       --sign-in-audience AzureADMyOrg \
       --identifier-uris ${TODOWEB_APP_URL}
   

2. Utilisez la commande suivante pour ajouter des autorisations :

   az ad app permission add \
       --id api://simple-todowebtest2 \
       --api $appid \
       --api-permissions $permissionid1=Scope $permissionid2=Scope $permissionid3=Scope
   

3. Utilisez la commande suivante pour accorder le consentement administrateur aux autorisations que vous avez ajoutées :

   az ad app permission admin-consent --id ${TODOWEB_APP_URL}
   

4. Utilisez la commande suivante pour obtenir l’ID client de l’application ToDoWeb utilisée dans l’étape Obtenir le jeton d’accès :

   az ad app show \
       --id ${TODOWEB_APP_URL} \
       --query appId \
       --output tsv
   

Ajouter un utilisateur pour accéder aux API RESTful

Utilisez la commande suivante pour créer un utilisateur membre dans votre locataire Microsoft Entra. Ensuite, l’utilisateur peut gérer les données de l’application ToDo via des API RESTful :

az ad user create \
    --display-name ${NEW_MEMBER_USERNAME} \
    --password ${NEW_MEMBER_PASSWORD} \
    --user-principal-name ${USER_PRINCIPAL_NAME}

Mettre à jour la configuration OAuth2 pour l’autorisation de l’interface utilisateur Swagger

Procédez comme suit pour mettre à jour la configuration OAuth2 :

1. Utilisez la commande suivante pour obtenir l’ID d’objet de l’application ToDoWeb :

   az ad app show --id ${TODOWEB_APP_URL} --query id
   

2. Utilisez la commande suivante pour obtenir l’URL de votre application simple-todo-api :

   az spring app show \
       --name ${APP_NAME} \
       --service ${AZURE_SPRING_APPS_NAME} \
       --query properties.url
   

3. Utilisez la commande suivante pour mettre à jour la configuration OAuth2 pour l’autorisation de l’interface utilisateur Swagger, en remplaçant les espaces réservés <object-id> et <URL> par les valeurs de paramètre que vous avez obtenues. Vous pouvez ensuite autoriser les utilisateurs à acquérir des jetons d’accès via l’application ToDoWeb.

   az rest \
       --method PATCH \
       --uri "https://graph.microsoft.com/v1.0/applications/<object-id>" \
       --headers 'Content-Type=application/json' \
       --body '{"spa":{"redirectUris":["<URL>/swagger-ui/oauth2-redirect.html"]}}'
   

2. Préparer le projet Spring

Pour déployer l’application API RESTful, la première étape consiste à préparer le projet Spring afin de l’exécuter localement.

Portail Azure + plug-in Maven

Procédez comme suit pour cloner et exécuter l’application localement :

1. Utilisez la commande suivante pour cloner l’exemple de projet à partir de GitHub :

   git clone https://github.com/Azure-Samples/ASA-Samples-Restful-Application.git
   

2. Si vous souhaitez exécuter l’application localement, commencez par suivre les étapes décrites dans les sections Exposer les API RESTful et Mettre à jour la configuration de l’application, puis utilisez la commande suivante pour exécuter l’exemple d’application avec Maven :

   cd ASA-Samples-Restful-Application
   ./mvnw spring-boot:run
   

Azure Developer CLI

Procédez comme suit pour initialiser l’application web à partir des modèles Azure Developer CLI :

1. Ouvrez un terminal, créez un dossier vide, puis changez le répertoire pour le nouveau dossier.

2. Exécutez la commande ci-dessous pour initialiser le projet :

   azd init --template Azure-Samples/ASA-Samples-Restful-Application
   

   La liste suivante décrit les interactions de commande :

   • Connexion OAuth2 : vous devez autoriser la connexion à Azure en fonction du protocole OAuth2.
   • Veuillez entrer un nouveau nom d’environnement : fournissez un nom d’environnement. Ce nom est utilisé comme suffixe pour le groupe de ressources créé pour contenir toutes les ressources Azure. Ce nom doit être unique dans votre abonnement Azure.

   La console génère des messages similaires à l’exemple suivant :

   Initializing a new project (azd init)
   
   Downloading template code to: <your-local-path>
   (✓) Done: Initialized git repository
   
   Enter a new environment name: <your-env-name>
   
   SUCCESS: New project initialized!
   You can view the template code in your directory: <your-local-path>
   Learn more about running 3rd party code on our DevHub: https://aka.ms/azd-third-party-code-notice
   

3. Préparer l’environnement cloud

Pour exécuter cet exemple d’application, les principales ressources requises sont une instance Azure Spring Apps et une instance Azure Database pour PostgreSQL. Dans les sections suivantes, découvrez comment créer ces ressources.

Portail Azure + plug-in Maven

3.1. Connectez-vous au portail Azure.

Accédez au Portail Microsoft Azure et entrez vos informations d’identification pour vous connecter au portail. Il s’ouvre par défaut sur le tableau de bord des services.

3.2. Créer une instance Azure Spring Apps

Utilisez la procédure suivante pour créer une instance de service :

1. Sélectionnez Créer une ressource dans le coin du portail.

2. Sélectionnez Calcul>Azure Spring Apps.

3. Remplissez le formulaire Informations de base. Utilisez le tableau suivant comme guide afin de remplir le formulaire. La valeur de Plan recommandée est la Consommation standard et dédiée (préversion).

   Paramètre	Valeur suggérée	Description
   Abonnement	Nom de votre abonnement.	Abonnement Azure que vous souhaitez utiliser pour votre serveur. Si vous disposez de plusieurs abonnements, choisissez celui dans lequel vous souhaitez que la ressource soit facturée.
   Groupe de ressources	myresourcegroup	Un nouveau nom de groupe de ressources ou un nom de groupe existant dans votre abonnement.
   Nom	myasa	Nom unique qui identifie votre instance Azure Spring Apps. Le nom doit comporter entre 4 et 32 caractères, et contenir uniquement des lettres minuscules, des chiffres et des traits d’union. Le premier caractère du nom du service doit être une lettre, et le dernier doit être une lettre ou un chiffre.
   Planification	Consommation standard et dédiée (préversion)	Le plan tarifaire détermine les ressources et le coût associés à votre instance.
   Région	La région la plus proche de vos utilisateurs.	L’emplacement géographique le plus proche de vos utilisateurs.
   Environnement Container Apps	myenvironment	Option permettant de sélectionner l’instance d’environnement Container Apps pour partager le même réseau virtuel avec d’autres services et ressources.

   Utilisez le tableau suivant comme guide pour créer l’environnement Container Apps :

   Paramètre	Valeur suggérée	Description
   Nom de l’environnement	myenvironment	Un nom unique pour identifier votre service d’environnement Azure Container Apps.
   Planifier	Consommation	Le plan tarifaire détermine les ressources et le coût associés à votre instance.
   Redondant interzone	Désactivé	Option permettant de créer votre service d’environnement Container Apps dans une zone de disponibilité Azure.

4. Sélectionnez Vérifier et créer pour passer en revue vos sélections. Ensuite, sélectionnez Créer pour approvisionner l’instance Azure Spring Apps.

5. Dans la barre d’outils, sélectionnez l’icône Notifications (en forme de cloche) pour surveiller le processus de déploiement. Une fois le déploiement terminé, vous pouvez sélectionner Épingler au tableau de bord, ce qui crée une vignette pour ce service dans votre tableau de bord du Portail Microsoft Azure, en tant que raccourci vers la page Vue d’ensemble du service.

6. Sélectionnez Accéder à la ressource pour ouvrir la page Vue d’ensemble du service.

   

Important

Le profil de charge de travail Consommation a un modèle de facturation de paiement à l’utilisation, sans coût de départ. Vous êtes facturé pour le profil de charge de travail dédié en fonction des ressources approvisionnées. Pour plus d’informations, consultez Profils de charges de travail dans Azure Container Apps et Tarification d’Azure Spring Apps.

3.3. Préparer l’instance PostgreSQL

Suivez la procédure ci-dessous pour créer un serveur Azure Database pour PostgreSQL :

1. Accédez au Portail Azure et sélectionnez Créer une ressource.

2. Sélectionnez Bases de données>Azure Database pour PostgreSQL.

3. Sélectionnez l’option de déploiement Serveur flexible.

   

4. Renseignez l’onglet Informations de base avec les informations suivantes :

   • Nom du serveur : my-demo-pgsql
   • Région : USA Est
   • Version PostgreSQL : 14
   • Type de charge de travail : Développement
   • Activer la haute disponibilité : désélectionné
   • Méthode d’authentification : Authentification PostgreSQL uniquement
   • Nom d’utilisateur administrateur : myadmin
   • Mot de passe et Confirmer le mot de passe : entrez un mot de passe.

5. Utilisez les informations suivantes pour configurer l’onglet Mise en réseau :

   • Méthode de connectivité : Accès public (adresses IP autorisées)
   • Autoriser l’accès public à partir d’un service Azure dans Azure sur ce serveur : sélectionné

6. Sélectionnez Examiner et créer pour passer en revue vos sélections, puis sélectionnez Créer pour approvisionner le serveur. Cette opération peut prendre quelques minutes.

7. Accédez à votre serveur PostgreSQL dans le portail Azure. Dans la page Vue d’ensemble, recherchez la valeur Nom du serveur, puis enregistrez-la pour une utilisation ultérieure. Vous devez configurer les variables d’environnement de l’application dans Azure Spring Apps.

8. Sélectionnez Bases de données dans le menu de navigation pour créer une base de données, par exemple ; todo.

   

3.4. Connecter une instance d’application à une instance PostgreSQL

Suivez la procédure ci-dessous pour connecter vos instances de service :

1. Accédez à votre instance Azure Spring Apps dans le portail Azure.

2. Dans le menu de navigation, ouvrez Applications, puis sélectionnez Créer une application.

3. Dans la page Créer une application, renseignez le nom de l’application simple-todo-api, puis sélectionnez Artefacts Java comme type de déploiement.

4. Sélectionnez Créer pour terminer la création de l’application, puis sélectionnez l’application pour en afficher les détails.

5. Accédez à l’application que vous avez créée dans le Portail Azure. Dans la page Vue d’ensemble, sélectionnez Attribuer un point de terminaison pour exposer le point de terminaison public pour l’application. Enregistrez l’URL pour accéder à l’application après le déploiement.

6. Accédez à l’application que vous avez créée, développez Paramètres et sélectionnez Configuration dans le menu de navigation, puis sélectionnez Variables d’environnement pour définir les variables d’environnement.

7. Ajoutez les variables d’environnement suivantes pour la connexion PostgreSQL, puis sélectionnez Enregistrer pour terminer la mise à jour de configuration de l’application. Veillez à remplacer les espaces réservés par vos propres valeurs que vous avez créées précédemment.

   Variable d'environnement	Valeur
   SPRING_DATASOURCE_URL	jdbc:postgresql://<your-PostgreSQL-server-name>:5432/<your-PostgreSQL-database-name>
   SPRING_DATASOURCE_USERNAME	<your-PostgreSQL-admin-user>
   SPRING_DATASOURCE_PASSWORD	<your-PostgreSQL-admin-password>

   

3.5. Exposer les API RESTful

Pour exposer vos API RESTful dans Microsoft Entra ID, procédez comme suit :

1. Connectez-vous au portail Azure.

2. Si vous avez accès à plusieurs locataires, utilisez le filtre Répertoire + abonnement () pour sélectionner le locataire dans lequel vous voulez inscrire une application.

3. Recherchez et sélectionnez Microsoft Entra ID.

4. Sous Gérer, sélectionnez Inscriptions d’applications>Nouvelle inscription.

5. Entrez un nom pour votre application dans le champ Nom, par exemple, Todo. Les utilisateurs de votre application peuvent voir ce nom, et vous pouvez le changer ultérieurement.

6. Pour Types de comptes pris en charge, sélectionnez Comptes de tout répertoire d’organisation (tout répertoire Microsoft Entra : multilocataire) et comptes Microsoft personnels.

7. Sélectionnez Inscrire pour créer l’application.

8. Dans la page Vue d’ensemble de l’application, recherchez la valeur ID d’application (client) , puis notez-la pour une utilisation ultérieure. Vous en avez besoin pour configurer le fichier de configuration YAML pour ce projet.

9. Sous Gérer, sélectionnez Exposer une API, trouvez l’URI de l’ID d’application au début de la page, puis sélectionnez Ajouter.

10. Dans la page Modifier l’URI de l’ID d’application, acceptez l’URI proposé de l’ID d’application (api://{client ID}) ou utilisez un nom utile au lieu de l’ID client, comme api://simple-todo, puis sélectionnez Enregistrer.

11. Sous Gérer, sélectionnez Exposer une API>Ajouter une étendue, puis entrez les informations suivantes :

    • Pour Nom de l’étendue, entrez ToDo.Read.
    • Pour Qui peut donner son consentement ?, sélectionnez Administrateurs et utilisateurs.
    • Pour Nom d’affichage du consentement administrateur, entrez Lire les données ToDo.
    • Pour Description du consentement administrateur, entrez Autoriser les utilisateurs authentifiés à lire les données ToDo.
    • Pour État, maintenez l’état Activé.
    • Sélectionnez Ajouter une étendue.

12. Répétez les étapes précédentes pour ajouter les deux autres étendus : ToDo.Write et ToDo.Delete.

    

3.6. Mettre à jour la configuration de l’application

Procédez comme suit pour mettre à jour le fichier YAML afin d’utiliser les informations de votre application inscrite Microsoft Entra pour établir une relation avec l’application API RESTful :

1. Recherchez le fichier src/main/resources/application.yml pour l’application simple-todo-api. Mettez à jour la configuration dans la section spring.cloud.azure.active-directory pour qu’elle corresponde à l’exemple suivant. Veillez à remplacer les espaces réservés par les valeurs que vous avez créées précédemment.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Remarque

   Dans les jetons v1.0, la configuration nécessite l’ID client de l’API, tandis que dans les jetons v2.0, vous pouvez utiliser l’ID client ou l’URI d’ID d’application dans la requête. Vous pouvez configurer les deux types de jetons pour effectuer correctement la validation de l’audience.

   Les valeurs autorisées pour tenant-id sont : common, organizations, consumersou l’ID de locataire. Pour plus d’informations sur ces valeurs, consultez la section Utilisation d’un point de terminaison incorrect (comptes personnels et d’organisation) de l’article Erreur AADSTS50020 : Le compte d’utilisateur du fournisseur d’identité n’existe pas dans le locataire. Pour plus d’informations sur la conversion de votre application monolocataire, consultez Convertir une application monolocataire en application multilocataire sur Microsoft Entra ID.

2. Utilisez la commande suivante pour régénérer l’échantillon de projet :

   ./mvnw clean package
   

Azure Developer CLI

3.1. Préparez les ressources Azure

Pour approvisionner les ressources Azure nécessaires, procédez comme suit :

1. Exécutez la commande suivante pour vous connecter à Azure avec OAuth2. Ignorez cette étape si vous êtes déjà connecté.

   azd auth login
   

2. Exécutez la commande suivante pour activer la fonctionnalité Azure Spring Apps :

   azd config set alpha.springapp on
   

3. Exécutez la commande suivante pour empaqueter une copie déployable de votre application, approvisionner l’infrastructure du modèle sur Azure et déployer le code de l’application sur les nouvelles ressources approvisionnées :

   azd provision
   

   La liste suivante décrit les interactions de commande :

   • Sélectionnez un abonnement Azure à utiliser : utilisez les flèches pour vous déplacer, tapez du texte pour filtrer, puis appuyez sur Entrée.
   • Sélectionnez un emplacement Azure à utiliser : utilisez les flèches pour vous déplacer, tapez du texte pour filtrer, puis appuyez sur Entrée.

   La console génère des messages similaires à l’exemple suivant :

   SUCCESS: Your application was provisioned in Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name>> in Azure Portal:
   https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>/overview
   

   Remarque

   L’exécution de cette commande peut prendre un certain temps. Un indicateur de progression s’affiche au fur et à mesure de l’approvisionnement des ressources Azure.

3.2. Exposer les API RESTful

Pour exposer vos API RESTful dans Microsoft Entra ID, procédez comme suit :

1. Connectez-vous au portail Azure.

2. Si vous avez accès à plusieurs locataires, utilisez le filtre Répertoire + abonnement () pour sélectionner le locataire dans lequel vous voulez inscrire une application.

3. Recherchez et sélectionnez Microsoft Entra ID.

4. Sous Gérer, sélectionnez Inscriptions d’applications>Nouvelle inscription.

5. Entrez un nom pour votre application dans le champ Nom, par exemple, Todo. Les utilisateurs de votre application peuvent voir ce nom, et vous pouvez le changer ultérieurement.

6. Pour Types de comptes pris en charge, sélectionnez Comptes de tout répertoire d’organisation (tout répertoire Microsoft Entra : multilocataire) et comptes Microsoft personnels.

7. Sélectionnez Inscrire pour créer l’application.

8. Dans la page Vue d’ensemble de l’application, recherchez la valeur ID d’application (client) , puis notez-la pour une utilisation ultérieure. Vous en avez besoin pour configurer le fichier de configuration YAML pour ce projet.

9. Sous Gérer, sélectionnez Exposer une API, trouvez l’URI de l’ID d’application au début de la page, puis sélectionnez Ajouter.

10. Dans la page Modifier l’URI de l’ID d’application, acceptez l’URI proposé de l’ID d’application (api://{client ID}) ou utilisez un nom utile au lieu de l’ID client, comme api://simple-todo, puis sélectionnez Enregistrer.

11. Sous Gérer, sélectionnez Exposer une API>Ajouter une étendue, puis entrez les informations suivantes :

    • Pour Nom de l’étendue, entrez ToDo.Read.
    • Pour Qui peut donner son consentement ?, sélectionnez Administrateurs et utilisateurs.
    • Pour Nom d’affichage du consentement administrateur, entrez Lire les données ToDo.
    • Pour Description du consentement administrateur, entrez Autoriser les utilisateurs authentifiés à lire les données ToDo.
    • Pour État, maintenez l’état Activé.
    • Sélectionnez Ajouter une étendue.

12. Répétez les étapes précédentes pour ajouter les deux autres étendus : ToDo.Write et ToDo.Delete.

    

3.3. Mettre à jour la configuration de l’application

Procédez comme suit pour mettre à jour le fichier YAML afin d’utiliser les informations de votre application inscrite Microsoft Entra pour établir une relation avec l’application API RESTful :

1. Recherchez le fichier src/main/resources/application.yml pour l’application simple-todo-api. Mettez à jour la configuration dans la section spring.cloud.azure.active-directory pour qu’elle corresponde à l’exemple suivant. Veillez à remplacer les espaces réservés par les valeurs que vous avez créées précédemment.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Remarque

   Dans les jetons v1.0, la configuration nécessite l’ID client de l’API, tandis que dans les jetons v2.0, vous pouvez utiliser l’ID client ou l’URI d’ID d’application dans la requête. Vous pouvez configurer les deux types de jetons pour effectuer correctement la validation de l’audience.

   Les valeurs autorisées pour tenant-id sont : common, organizations, consumersou l’ID de locataire. Pour plus d’informations sur ces valeurs, consultez la section Utilisation d’un point de terminaison incorrect (comptes personnels et d’organisation) de l’article Erreur AADSTS50020 : Le compte d’utilisateur du fournisseur d’identité n’existe pas dans le locataire. Pour plus d’informations sur la conversion de votre application monolocataire, consultez Convertir une application monolocataire en application multilocataire sur Microsoft Entra ID.

2. Utilisez la commande suivante pour régénérer l’échantillon de projet :

   ./mvnw clean package
   

4. Déployer l’application sur Azure Spring Apps

Vous pouvez maintenant déployer l’application sur Azure Spring Apps.

Portail Azure + plug-in Maven

Utilisez la procédure suivante pour le déploiement en utilisant le plug-in Maven pour Azure Spring Apps :

1. Accédez au répertoire complete, puis exécutez la commande suivante pour configurer l’application dans Azure Spring Apps :

   ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
   

   La liste suivante décrit les interactions de commande :

   • Connexion OAuth2 : vous devez autoriser la connexion à Azure en fonction du protocole OAuth2.
   • Sélectionnez un abonnement : sélectionnez le numéro de liste d’abonnements de l’instance Azure Spring Apps créée, qui correspond par défaut au premier abonnement de la liste. Si vous utilisez le nombre par défaut, appuyez directement sur Entrée.
   • Utiliser Azure Spring Apps dans Azure : appuyez sur y (oui) pour utiliser l’instance Azure Spring Apps existante.
   • Sélectionner Azure Spring Apps pour le déploiement : sélectionnez le numéro de l’instance Azure Spring Apps que vous avez créée. Si vous utilisez le nombre par défaut, appuyez directement sur Entrée.
   • Utiliser l’application existante dans Azure Spring Apps <your-instance-name> : appuyez sur y (oui) pour utiliser l’application créée.
   • Confirmez pour enregistrer toutes les configurations ci-dessus : appuyez sur y (oui). Si vous entrez N, la configuration n’est pas enregistrée dans les fichiers POM.

2. Utilisez la commande suivante pour déployer l’application :

   ./mvnw azure-spring-apps:deploy
   

   La liste suivante décrit l’interaction de commande :

   • Connexion OAuth2 : vous devez autoriser la connexion à Azure en fonction du protocole OAuth2.

   Une fois la commande exécutée, les messages de journal suivants indiquent que le déploiement a réussi :

[INFO] Deployment(default) is successfully created
[INFO] Starting Spring App after deploying artifacts...
[INFO] Deployment Status: Running
[INFO]   InstanceName:demo--default-xxxxxxx-xxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:NONE
[INFO] Getting public url of app(demo)...
[INFO] Application url: https://demo.<unique-identifier>.<region-name>.azurecontainerapps.io

Azure Developer CLI

Utilisez la procédure ci-dessous pour empaqueter l’application, approvisionner les ressources Azure requises par l’application web, puis la déployer sur Azure Spring Apps.

1. Exécutez la commande suivante pour empaqueter une copie déployable de votre application :

   azd package
   

2. Exécutez la commande suivante pour déployer le code d’application sur les ressources nouvellement approvisionnées :

   azd deploy
   

   La console génère des messages similaires à l’exemple suivant :

   Deploying services (azd deploy)
   
   WARNING: Feature 'springapp' is in alpha stage.
   To learn more about alpha features and their support, visit https://aka.ms/azd-feature-stages.
   
   ...
   
   Deploying service simple-todo-api (Fetching endpoints for spring app service)
   - Endpoint: https://simple-todo-api.xxxxxxxx-xxxxxxxx.xxxxxx.azurecontainerapps.io
   
   
   SUCCESS: Your application was deployed to Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name> in Azure Portal:
   https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
   

   Le point de terminaison de sortie est le point de terminaison de base pour accéder à l’application d’API ToDo.

Remarque

Vous pouvez également utiliser azd up pour combiner les trois commandes précédentes : azd provision (approvisionne les ressources Azure), azd package (empaquette une copie déployable de votre application) et azd deploy (déploie le code de l’application). Pour plus d’informations, consultez Azure-Samples/ASA-Samples-Restful-Application.

5. Valider l’application

Vous pouvez désormais accéder à l’API RESTful pour voir si cela fonctionne.

5.1. Demander un jeton d’accès

Les API RESTful agissent en tant que serveur de ressources, qui est protégé par Microsoft Entra ID. Avant d’acquérir un jeton d’accès, vous devez inscrire une autre application dans Microsoft Entra ID et accorder des autorisations à l’application cliente, nommée ToDoWeb.

Inscrire l’application cliente

Procédez comme suit pour inscrire une application dans Microsoft Entra ID, qui est utilisé pour ajouter les autorisations pour l’application ToDo :

1. Connectez-vous au portail Azure.

2. Si vous avez accès à plusieurs locataires, utilisez le filtre Répertoire + abonnement () pour sélectionner le locataire dans lequel vous voulez inscrire une application.

3. Recherchez et sélectionnez Microsoft Entra ID.

4. Sous Gérer, sélectionnez Inscriptions d’applications>Nouvelle inscription.

5. Entrez un nom pour votre application dans le champ Nom, par exemple, ToDoWeb. Les utilisateurs de votre application peuvent voir ce nom, et vous pouvez le changer ultérieurement.

6. Pour Types de comptes pris en charge, utilisez la valeur par défaut Comptes dans ce répertoire d’organisation uniquement.

7. Sélectionnez Inscrire pour créer l’application.

8. Dans la page Vue d’ensemble de l’application, recherchez la valeur ID d’application (client) , puis notez-la pour une utilisation ultérieure. Vous en avez besoin pour obtenir un jeton d'accès.

9. Sélectionnez Autorisations des API>Ajouter une autorisation>Mes API. Sélectionnez l’application ToDo que vous avez inscrite précédemment, puis sélectionnez les autorisations ToDo.Read, ToDo.Write et ToDo.Delete. Sélectionnez Ajouter des autorisations.

10. Sélectionnez Accorder le consentement de l’administrateur pour <votre-nom-de-locataire> afin d’accorder le consentement administrateur aux autorisations que vous avez ajoutées.

    

Ajouter un utilisateur pour accéder aux API RESTful

Procédez comme suit pour créer un utilisateur membre dans votre locataire Microsoft Entra. Ensuite, l’utilisateur peut gérer les données de l’application ToDo via des API RESTful.

1. Sous Gérer, sélectionnez Utilisateurs>Nouvel utilisateur>Créer un utilisateur.

2. Dans la page Créer un utilisateur, indiquez les informations suivantes :

   • Nom d’utilisateur principal : entrez un nom pour l’utilisateur.
   • Nom d’affichage : entrez un nom d’affichage pour l’utilisateur.
   • Mot de passe : copiez le mot de passe généré automatiquement fourni dans le champ Mot de passe.

   Remarque

   Les nouveaux utilisateurs doivent effectuer la première authentification de connexion et mettre à jour leurs mots de passe, sinon une erreur AADSTS50055: The password is expired s’affiche lorsqu’ils obtiennent le jeton d’accès.

   Lorsqu’un nouvel utilisateur se connecte, il reçoit une invite Action requise. Il peut choisir Demander ultérieurement pour ignorer la validation.

3. Sélectionnez Vérifier + créer pour passer en revue vos sélections. Sélectionnez Créer pour créer l’utilisateur.

Mettre à jour la configuration OAuth2 pour l’autorisation de l’interface utilisateur Swagger

Procédez comme suit pour mettre à jour la configuration OAuth2 pour l’autorisation de l’interface utilisateur Swagger. Vous pouvez ensuite autoriser les utilisateurs à acquérir des jetons d’accès via l’application ToDoWeb.

1. Ouvrez votre locataire Microsoft Entra ID dans le Portail Azure et accédez à l’application inscrite ToDoWeb.

2. Sous Gérer, sélectionnez Authentification, Ajouter une plateforme, puis Application monopage.

3. Utilisez le format <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html comme URL de redirection OAuth2 dans le champ URI de redirection, puis sélectionnez Configurer.

   

Obtenir le jeton d’accès

Procédez comme suit pour utiliser la méthode de flux de code d’autorisation OAuth 2.0 afin d’obtenir un jeton d’accès avec Microsoft Entra ID, puis accédez aux API RESTful de l’applicationToDo :

1. Ouvrez l’URL exposée par l’application, puis sélectionnez Autoriser pour préparer l’authentification OAuth2.

2. Dans la fenêtre Autorisations disponibles, entrez l’ID client de l’application ToDoWeb dans le champ client_id, sélectionnez toutes les étendues du champ Étendues. Ignorez le champ client_secret, puis sélectionnez Autoriser pour la redirection vers la page de connexion Microsoft Entra.

Une fois la connexion terminée avec l’utilisateur précédent, vous êtes renvoyé à la fenêtre Autorisations disponibles.

5.2. Accéder aux API RESTful

Pour accéder aux API RESTful de l’application ToDo dans l’interface utilisateur Swagger, procédez comme suit :

1. Sélectionnez l’API POST /api/simple-todo/lists, puis sélectionnez Essayer. Entrez le corps de la demande suivant, puis sélectionnez Exécuter pour créer une liste ToDo.

   {
     "name": "My List"
   }
   

   Une fois l’exécution terminée, vous voyez le corps de réponse suivant :

   {
     "id": "<ID-of-the-ToDo-list>",
     "name": "My List",
     "description": null
   }
   

2. Sélectionnez l’API POST /api/simple-todo/lists/{listId}/items, puis Essayer. Pour listId, entrez l’ID de liste ToDo que vous avez créé précédemment, entrez le corps de la demande suivant, puis sélectionnez Exécuter pour créer un élément ToDo.

   {
     "name": "My first ToDo item", 
     "listId": "<ID-of-the-ToDo-list>",
     "state": "todo"
   }
   

   Cette action retourne l’élément ToDo suivant :

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": null,
     "state": "todo",
     "dueDate": "2023-07-11T13:59:24.9033069+08:00",
     "completedDate": null
   }
   

3. Sélectionnez l’API GET /api/simple-todo/lists, puis sélectionnez Exécuter pour interroger les listes ToDo. Cette action retourne les listes ToDo suivantes :

   [
     {
       "id": "<ID-of-the-ToDo-list>",
       "name": "My List",
       "description": null
     }
   ]
   

4. Sélectionnez l’API GET /api/simple-todo/lists/{listId}/items, puis Essayer. Pour listId, entrez l’ID de liste ToDo que vous avez créé précédemment, puis sélectionnez Exécuter pour créer un élément ToDo. Cette action retourne l’élément ToDo suivant :

   [
     {
       "id": "<ID-of-the-ToDo-item>",
       "listId": "<ID-of-the-ToDo-list>",
       "name": "My first ToDo item",
       "description": null,
       "state": "todo",
       "dueDate": "2023-07-11T13:59:24.903307+08:00",
       "completedDate": null
     }
   ]
   

5. Sélectionnez l’API PUT /api/simple-todo/lists/{listId}/items/{itemId}, puis Essayer. Pour listId, entrez l’ID de liste ToDo. Pour itemId, entrez l’ID d’élément ToDo, entrez le corps de la demande suivant, puis sélectionnez Exécuter pour mettre à jour l’élément ToDo.

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": "Updated description.",
     "dueDate": "2023-07-11T13:59:24.903307+08:00",
     "state": "inprogress"
   }
   

   Cette action retourne l’élément ToDo mis à jour suivant :

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": "Updated description.",
     "state": "inprogress",
     "dueDate": "2023-07-11T05:59:24.903307Z",
     "completedDate": null
   }
   

6. Sélectionnez l’API DELETE /api/simple-todo/lists/{listId}/items/{itemId}, puis Essayer. Pour listId, entrez l’ID de liste ToDo. Pour itemId, entrez l’ID d’élément ToDo, puis sélectionnez Exécuter pour supprimer l’élément ToDo. Le code de réponse du serveur devrait être 204.

6. Nettoyer les ressources

Vous pouvez supprimer le groupe de ressources Azure qui inclut toutes les ressources du groupe de ressources.

Portail Azure + plug-in Maven

Pour supprimer l’intégralité du groupe de ressources, y compris le serveur que vous venez de créer, utilisez les étapes suivantes :

1. Localisez votre groupe de ressources dans le portail Azure.

2. Dans le menu de navigation, sélectionnez Groupes de ressources. Sélectionnez ensuite le nom de votre groupe de ressources (par exemple, myresourcegroup).

3. Dans la page de votre groupe de ressources, sélectionnez Supprimer. Pour confirmer la suppression, entrez le nom de votre groupe de ressources dans la zone de texte, par exemple, myresourcegroup. Ensuite, sélectionnez Supprimer.

Azure CLI

Pour supprimer l’intégralité du groupe de ressources, y compris le serveur que vous venez de créer, utilisez la commande suivante :

az group delete --name ${RESOURCE_GROUP}

Portail Azure + plug-in Maven

Pour supprimer l’intégralité du groupe de ressources, y compris le serveur que vous venez de créer, utilisez les étapes suivantes :

1. Localisez votre groupe de ressources dans le portail Azure.

2. Dans le menu de navigation, sélectionnez Groupes de ressources. Sélectionnez ensuite le nom de votre groupe de ressources (par exemple, myresourcegroup).

3. Dans la page de votre groupe de ressources, sélectionnez Supprimer. Pour confirmer la suppression, entrez le nom de votre groupe de ressources dans la zone de texte, par exemple, myresourcegroup. Ensuite, sélectionnez Supprimer.

Azure Developer CLI

Utilisez la commande suivante pour supprimer toutes les ressources Azure utilisées dans cet exemple d’application :

azd down

La liste suivante décrit l’interaction de commande :

• Total des ressources à supprimer : [your-resources-total], voulez-vous vraiment continuer ? : appuyez sur y.

La console génère des messages similaires à l’exemple suivant :

SUCCESS: Your application was removed from Azure in xx minutes xx seconds.

7. Étapes suivantes

Démarrage rapide : déployer une application basée sur les événements sur Azure Spring Apps

Démarrage rapide : déployer des applications de microservices sur Azure Spring Apps

Journal des applications structuré pour Azure Spring Apps

Mapper un domaine personnalisé existant à Azure Spring Apps

Utiliser CI/CD Azure Spring Apps avec GitHub Actions

Automatiser les déploiements d’applications dans Azure Spring Apps

Pour plus d’informations, consultez les articles suivants :

• Exemples Azure Spring Apps.
• Spring sur Azure
• Spring Cloud Azure