Modifier le manifeste Microsoft Entra

Teams Toolkit gère désormais Microsoft Entra application avec le fichier manifeste comme source de vérité pendant le cycle de vie du développement de votre application Teams.

Personnaliser Microsoft Entra modèle de manifeste

Vous pouvez personnaliser Microsoft Entra modèle de manifeste pour mettre à jour Microsoft Entra application.

  1. Ouvrez aad.template.json dans votre projet.

    Capture d’écran montrant le modèle.

  2. Mettez à jour le modèle directement ou référencez les valeurs à partir d’un autre fichier. Voici les scénarios de personnalisation :

    Ajouter une autorisation d’application

    Si l’application Teams nécessite davantage d’autorisations pour appeler une API avec des autorisations supplémentaires, vous devez mettre à jour requiredResourceAccess la propriété dans le modèle de manifeste Microsoft Entra. Vous pouvez voir l’exemple suivant pour cette propriété :

            "requiredResourceAccess": [
    {
            "resourceAppId": "Microsoft Graph",
            "resourceAccess": [
                {
                    "id": "User.Read", // For Microsoft Graph API, you can also use uuid for permission id
                    "type": "Scope" // Scope is for delegated permission
                },
                {
                    "id": "User.Export.All",
                    "type": "Role" // Role is for application permission
                }
            ]
        },
        {
            "resourceAppId": "Office 365 SharePoint Online",
            "resourceAccess": [
                {
                        "id": "AllSites.Read",
                "type": "Scope"
                }
            ]
        }
    ]
    
    

    La liste suivante fournit différents ID de propriété et leur utilisation :

    • La resourceAppId propriété est utilisée pour différentes API. Pour Microsoft Graph et Office 365 SharePoint Online, entrez le nom directement au lieu d’UUID, et pour les autres API, utilisez UUID.

    • La resourceAccess.id propriété est utilisée pour différentes autorisations. Pour Microsoft Graph et Office 365 SharePoint Online, entrez le nom d’autorisation directement au lieu de l’UUID, et pour les autres API, utilisez UUID.

    • La resourceAccess.type propriété est utilisée pour l’autorisation déléguée ou l’autorisation d’application. Scope signifie une autorisation déléguée et Role une autorisation d’application.

    Pré-autoriser une application cliente

    Vous pouvez utiliser preAuthorizedApplications la propriété pour autoriser une application cliente à indiquer que l’API approuve l’application. Les utilisateurs ne donnent pas leur consentement lorsque le client appelle l’API exposée. Vous pouvez voir l’exemple suivant pour cette propriété :

    
          "preAuthorizedApplications": [
          {
              "appId": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
              "permissionIds": [
                   "${{AAD_APP_ACCESS_AS_USER_PERMISSION_ID}}"
               ]
          }
          ...
      ]
    

    preAuthorizedApplications.appId la propriété est utilisée pour l’application que vous souhaitez autoriser. Si vous ne connaissez pas l’ID d’application et que vous connaissez uniquement le nom de l’application, procédez comme suit pour rechercher l’ID d’application :

    1. Accédez à Portail Azure et ouvrez Inscriptions d’applications.

    2. Sélectionnez Toutes les applications et recherchez le nom de l’application.

    3. Sélectionnez le nom de l’application et obtenez l’ID d’application dans la page vue d’ensemble.

    Mettre à jour l’URL de redirection pour la réponse d’authentification

    Les URL de redirection sont utilisées lors du retour de réponses d’authentification telles que des jetons après une authentification réussie. Vous pouvez personnaliser les URL de redirection à l’aide de la propriété replyUrlsWithType. Par exemple, pour ajouter https://www.examples.com/auth-end.html en tant qu’URL de redirection, vous pouvez l’ajouter comme exemple suivant :

        "replyUrlsWithType": [
           ...
         {
             "url": "https://www.examples.com/auth-end.html",
             "type": "Spa"
         }
    ]
    
  3. Mettez à jour Microsoft Entra modifications de l’application pour l’environnement local ou distant.

    1. Sélectionnez Preview CodeLens dans aad.template.json.

      Capture d’écran montrant l’aperçu.

    2. Sélectionnez environnement local ou de développement .

      Capture d’écran montrant la liste des environnements.

    3. Sélectionnez Deploy Azure AD Manifest CodeLens dans aad.local.json ou aad.dev.json.

      Capture d’écran montrant l’option de déploiement mise en surbrillance.

    4. Les modifications apportées à Microsoft Entra application utilisée dans l’environnement local ou de développement sont déployées.

    5. En outre, vous pouvez ouvrir la palette de commandes et sélectionner Teams : Mettre à jour Microsoft Entra’application pour mettre à jour Microsoft Entra’application. Capture d’écran montrant l’option Palette de commandes.

espaces réservés de modèle de manifeste Microsoft Entra

Le fichier manifeste Microsoft Entra contient des arguments d’espace réservé avec {{...}} elle est remplacée lors de la génération pour différents environnements. Vous pouvez faire référence à des variables d’environnement avec les arguments d’espace réservé.

Variable d’environnement de référence dans Microsoft Entra modèle de manifeste

Vous n’avez pas besoin d’entrer des valeurs permanentes dans Microsoft Entra modèle de manifeste et Microsoft Entra fichier de modèle manifeste prend en charge les valeurs de variable d’environnement de référence. Vous pouvez utiliser la syntaxe ${{YOUR_ENV_VARIABLE_NAME}} de l’outil comme valeurs de paramètre pour résoudre les valeurs de variables d’environnement actuelles.

Modifier et afficher un aperçu du manifeste Microsoft Entra avec CodeLens

Microsoft Entra fichier de modèle de manifeste contient CodeLens pour examiner et modifier le code.

Microsoft Entra fichier de modèle de manifeste

Il existe un aperçu de CodeLens au début du fichier de modèle de manifeste Microsoft Entra. Sélectionnez CodeLens pour générer un manifeste Microsoft Entra basé sur votre environnement.

Capture d’écran montrant l’aperçu de l’ajout de codelens.

Argument d’espace réservé CodeLens

L’argument d’espace réservé CodeLens vous permet de voir les valeurs du débogage local et de développer votre environnement. Si vous pointez la souris sur l’argument d’espace réservé, la boîte d’info-bulle affiche les valeurs de tous les environnements.

Capture d’écran montrant l’ajout d’arguments.

Accès aux ressources requis CodeLens

Microsoft Entra modèle de manifeste dans teams Toolkit prend également en charge les chaînes lisibles par l’utilisateur pour Microsoft Graph les autorisations et Office 365 SharePoint Online . Le schéma de manifeste de Microsoft Entra officiel, qui est la resourceAppId propriété et resourceAccess dans, prend uniquement en requiredResourceAccess charge l’UUID. Si vous entrez UUID, codeLens affiche les chaînes lisibles par l’utilisateur, sinon il affiche l’UUID.

Capture d’écran montrant l’ajout d’une ressource à l’accès aux ressources requis.

Applications préautorisées CodeLens

CodeLens affiche le nom de l’application pour l’ID d’application préautorisée pour la preAuthorizedApplications propriété.

Afficher Microsoft Entra application sur le Portail Azure

  1. Copiez l’ID client de l’application Microsoft Entra à partir du .env.xxx fichier () dans la AAD_APP_CLIENT_ID propriété .

    Capture d’écran montrant l’ID client.

    Remarque

    xxx dans l’ID client indique le nom de l’environnement dans lequel vous avez déployé l’application Microsoft Entra.

  2. Accédez à Portail Azure et connectez-vous au compte Microsoft 365.

    Remarque

    Vérifiez que les informations d’identification de connexion de l’application Teams et du compte M365 sont identiques.

  3. Ouvrez la page Inscriptions d’applications et recherchez l’application Microsoft Entra à l’aide de l’ID client que vous avez copié précédemment.

    Capture d’écran montrant l’ID client sous l’onglet Toutes les applications.

  4. Sélectionnez Microsoft Entra application dans le résultat de la recherche pour afficher les informations détaillées.

  5. Dans Microsoft Entra page d’informations sur l’application, sélectionnez le menu Manifeste pour afficher le manifeste de cette application. Le schéma du manifeste est identique à celui du aad.template.json fichier. Pour plus d’informations sur le manifeste, consultez Microsoft Entra manifeste d’application.

    Capture d’écran montrant l’écran Manifeste.

  6. Vous pouvez sélectionner Autre menu pour afficher ou configurer Microsoft Entra application via son portail.

Utiliser une application Microsoft Entra existante

Vous pouvez utiliser l’application Microsoft Entra existante pour le projet Teams. Pour plus d’informations, consultez Utiliser une application Microsoft Entra existante pour votre application Teams.

Microsoft Entra application dans le cycle de vie du développement d’applications Teams

Vous devez interagir avec Microsoft Entra application au cours de différentes étapes du cycle de vie du développement d’applications Teams.

  1. Pour créer un projet

    Vous pouvez créer un projet avec Teams Toolkit fourni avec la prise en charge de l’authentification unique (SSO) par défaut, par SSO-enabled tabexemple . Pour plus d’informations sur la création d’une application, consultez Créer une application Teams à l’aide du Kit de ressources Teams. Un fichier manifeste Microsoft Entra est automatiquement créé pour vous dans aad.template.json. Teams Toolkit crée ou met à jour l’application Microsoft Entra pendant le développement local ou lorsque vous déplacez l’application vers le cloud.

  2. Pour ajouter l’authentification unique à votre bot ou onglet

    Après avoir créé une application Teams sans authentification unique intégrée, Teams Toolkit vous aide progressivement à ajouter l’authentification unique pour le projet. Par conséquent, un fichier manifeste Microsoft Entra est automatiquement créé pour vous dans aad.template.json.

    Teams Toolkit crée ou met à jour l’application Microsoft Entra lors de la prochaine session de développement locale ou lorsque vous déplacez l’application vers le cloud.

  3. Pour générer localement

    Teams Toolkit effectue les fonctions suivantes pendant le développement local :

    • Lisez le .env.local fichier pour rechercher une application Microsoft Entra existante. S’il existe déjà une application Microsoft Entra, Teams Toolkit réutilise l’application Microsoft Entra existante. Sinon, vous devez créer une application à l’aide du aad.template.json fichier .

    • Ignore initialement certaines propriétés du fichier manifeste qui nécessitent davantage de contexte, telles que replyUrls la propriété qui nécessite un point de terminaison de développement local lors de la création d’une application Microsoft Entra avec le fichier manifeste.

    • Une fois que l’environnement de développement local démarre correctement, le Microsoft Entra de l’application identifierUris, replyUrlset les autres propriétés qui ne sont pas disponibles pendant la phase de création sont mises à jour en conséquence.

    • Les modifications que vous avez apportées à votre application Microsoft Entra sont chargées lors de la prochaine session de développement locale. Vous pouvez voir Microsoft Entra modifications d’application appliquées manuellement.

  4. Pour provisionner des ressources cloud

    Vous devez provisionner des ressources cloud et déployer votre application tout en déplaçant votre application vers le cloud. À certaines étapes, telles que le débogage local, Teams Toolkit :

    • Lit le .env.{env} fichier pour rechercher une application Microsoft Entra existante. S’il existe déjà une application Microsoft Entra, Teams Toolkit réutilise l’application Microsoft Entra existante. Sinon, vous devez créer une application à l’aide du aad.template.json fichier .

    • Ignore certaines propriétés du fichier manifeste initialement qui nécessitent davantage de contexte, comme replyUrls la propriété . Cette propriété nécessite un point de terminaison frontal ou de bot lors de la création d’une application Microsoft Entra avec le fichier manifeste.

    • Termine l’approvisionnement d’autres ressources, puis Microsoft Entra de l’application identifierUriset replyUrls sont mis à jour en fonction des points de terminaison appropriés.

  5. Pour générer l’application

    • La commande cloud déploie votre application sur les ressources approvisionnées. Il n’inclut pas le déploiement Microsoft Entra modifications d’application que vous avez apportées.

    • Teams Toolkit met à jour l’application Microsoft Entra en fonction du fichier de modèle de manifeste Microsoft Entra.

Limitations

  1. L’extension Teams Toolkit ne prend pas en charge toutes les propriétés répertoriées dans Microsoft Entra schéma de manifeste.

    Le tableau suivant répertorie les propriétés qui ne sont pas prises en charge dans l’extension Teams Toolkit :

    Propriétés non prises en charge Raison
    passwordCredentials Non autorisé dans le manifeste
    createdDateTime En lecture seule et ne peut pas être modifié
    logoUrl En lecture seule et ne peut pas être modifié
    publisherDomain En lecture seule et ne peut pas être modifié
    oauth2RequirePostResponse N’existe pas dans API Graph
    oauth2AllowUrlPathMatching N’existe pas dans API Graph
    samlMetadataUrl N’existe pas dans API Graph
    orgRestrictions N’existe pas dans API Graph
    certification N’existe pas dans API Graph
  2. Actuellement, requiredResourceAccess la propriété est utilisée pour les chaînes de nom d’application de ressource lisible par l’utilisateur ou de nom d’autorisation uniquement pour Microsoft Graph les API et Office 365 SharePoint Online . Vous devez utiliser l’UUID pour d’autres API. Effectuez les étapes suivantes pour récupérer des ID à partir de Portail Azure :

    1. Inscrivez une nouvelle application Microsoft Entra sur Portail Azure.
    2. Sélectionnez API permissions dans la page de l’application Microsoft Entra.
    3. Sélectionnez cette option add a permission pour ajouter l’autorisation dont vous avez besoin.
    4. Sélectionnez Manifest dans la requiredResourceAccess propriété , où vous pouvez trouver les ID d’API et les autorisations.

Voir aussi