Utilisez Azure Pipelines pour construire et déployer une application web Python sur Azure App Service.

• Un abonnement Azure. Si vous n’en avez pas, créez un compte gratuit.
• Un compte GitHub. Si vous n’en avez pas, créez-en une gratuitement.
• Une organisation Azure DevOps Services. Créez-en un gratuitement.

• Un abonnement Azure. Si vous n’en avez pas, créez un compte gratuit.
• Un compte GitHub. Si vous n’en avez pas, créez-en une gratuitement.
• Un serveur Azure DevOps.
• Un agent auto-hébergé. Si vous devez créer un agent auto-hébergé, veuillez consulter la section Agents auto-hébergés.

1. Dans un navigateur, rendez-vous sur dev.azure.com et connectez-vous.
2. Sélectionnez votre organisation.
3. Créez un nouveau projet en sélectionnant Nouveau projet ou Créer un projet si c’est le premier projet dans l’organisation.
4. Entrez un Nom de projet.
5. Choisissez la Visibilité de votre projet.
6. Sélectionnez Créer.

1. Dans un navigateur, rendez-vous sur votre serveur Azure DevOps.
2. Sélectionnez votre collection.
3. Créez un nouveau projet en sélectionnant Nouveau projet ou Créer un projet si c’est le premier projet dans la collection.
4. Entrez un Nom de projet.
5. Choisissez la Visibilité de votre projet.
6. Sélectionnez Créer.

Créer un principal du service

Un principal de service est une identité créée pour une utilisation avec des applications, des services hébergés et des outils automatisés pour accéder aux ressources Azure. Cet accès est restreint aux rôles attribués au principal de service, ce qui vous donne le contrôle sur les ressources auxquelles vous pouvez accéder et à quel niveau.

Pour créer un principal de service, accédez à l’interpréteur de commandes Cloud (bash) et exécutez la commande suivante. Remplacez <service-principal-name> par un nom pour votre principal de service, <your-subscription-id> par votre ID d’abonnement, et <your-resource-group> par le groupe de ressources de l’application web.

az ad sp create-for-rbac --display-name <service-principal-name> --role contributor --scopes /subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>

La commande renvoie un objet JSON similaire à l’exemple suivant :

{
  "clientId": "<client GUID>",
  "clientSecret": "<string-value>",
  "subscriptionId": "<subscription GUID>",
  "tenantId": "<tenant GUID>",
  ...
}

Notez les valeurs clientId, clientSecret, subscriptionId et tenantId. Vous avez besoin de ces valeurs pour créer une connexion de service dans la section suivante.

1. Sur la page du projet, sélectionnez Paramètres du projet.

   

2. Sélectionnez Connexions de service dans la section Pipelines du menu.

3. Sélectionnez Créer une connexion de service.

4. Sélectionnez Gestionnaire de ressources Azure et sélectionnez Suivant.

   

5. Sélectionnez votre méthode d’authentification et sélectionnez Suivant.

6. Dans la boîte de dialogue Nouvelle connexion de service Azure, saisissez les informations spécifiques à la méthode d’authentification sélectionnée. Pour plus d’informations sur les méthodes d’authentification, veuillez consulter la section Se connecter à Azure en utilisant une connexion de service Gestionnaire de ressources Azure.

   Par exemple, si vous utilisez une méthode d’authentification Fédération de l’identité de la charge de travail (automatique) ou Principal de service (automatique), saisissez les informations requises.

   

   Champ	Description
   Niveau de portée	Sélectionnez Abonnement.
   Abonnement	Le nom de votre abonnement Azure.
   Groupe de ressources	Le nom du groupe de ressources contenant votre application web.
   Nom de la connexion de service	Un nom descriptif pour la connexion.
   Accorder des autorisations d’accès à tous les pipelines	Sélectionnez cette option pour accorder l’accès à tous les pipelines.

7. Cliquez sur Enregistrer.

La nouvelle connexion apparaît dans la liste Connexions de service, et est prête à être utilisée dans votre Pipeline Azure.

1. Sur la page du projet, sélectionnez Paramètres du projet.

   

2. Sélectionnez Connexions de service dans la section Pipelines du menu.

3. Sélectionnez Créer une connexion de service.

4. Sélectionnez Gestionnaire de ressources Azure et sélectionnez Suivant.

   

5. Sur Nouvelle connexion de service Azure, sélectionnez Principal de service (manuel) et sélectionnez Suivant

6. Sur la boîte de dialogue suivante, remplissez les informations requises.

   

   Champ	Description
   Environment	Sélectionnez Azure Cloud.
   Niveau de portée	Sélectionnez Abonnement.
   ID d’abonnement	Votre ID d’abonnement.
   Nom d’abonnement	Le nom de votre abonnement Azure.
   ID de principal de service	La valeur appId de l’objet JSON retourné par la commande az ad sp create-for-rbac.
   Clé du principal de service	La valeur password de l’objet JSON retourné par la commande az ad sp create-for-rbac.
   Identifiant du locataire	La valeur tenant de l’objet JSON retourné par la commande az ad sp create-for-rbac.

7. Sélectionnez Vérifier pour vérifier la connexion.

8. Saisissez un nom de connexion de service.

9. Vérifiez que l’option Accorder des autorisations d’accès à tous les pipelines est sélectionnée.

10. Sélectionnez Vérifier et enregistrer.

La nouvelle connexion apparaît dans la liste Connexions de service et est prête pour l’utilisation d’Azure Pipelines à partir du projet.

Configurez un agent auto-hébergé

Si vous utilisez votre propre agent auto-hébergé, vous devez configurer l’agent pour exécuter Python. Le téléchargement de versions Python n’est pas pris en charge sur les agents auto-hébergés. Vous devez préinstaller la version Python. Utilisez l’installateur complet pour obtenir une version de Python compatible avec pip.

Pour éviter les problèmes d’incompatibilité, vous devriez faire correspondre la version Python avec la version d’exécution sur votre application web Azure App Services. La version d’exécution est indiquée dans la sortie JSON de la commande az webapp up.

La version Python souhaitée doit être ajoutée au cache d’outils sur l’agent auto-hébergé afin que la tâche puisse l’utiliser. Normalement, le cache d’outils se trouve sous le répertoire _work/_tool de l’agent; alternativement, le chemin peut être remplacé par la variable d’environnement AGENT_TOOLSDIRECTORY. Sous le répertoire des outils, créez la structure de répertoires suivante en fonction de votre version Python :

$AGENT_TOOLSDIRECTORY/
    Python/
        {version number}/
            {platform}/
                {tool files}
            {platform}.complete

Le numéro de version doit suivre le format 1.2.3. La plate-forme doit être soit x86 ou x64. Les fichiers d’outils doivent être les fichiers de version de Python dézippés. Le {platform}.complete doit être un fichier de 0 octet qui ressemble à x86.complete ou x64.complete et signifie simplement que l’outil est correctement installé dans le cache.

Par exemple, si vous utilisez Python 3.11 sur une machine Windows 64 bits, la structure du répertoire ressemblerait à ceci :

$AGENT_TOOLSDIRECTORY/
    Python/
        3.11.4/
            x64/
                {python files}
            x64.complete

Si vous avez déjà la version Python que vous voulez utiliser sur la machine hébergeant votre agent, vous pouvez copier les fichiers dans le cache d’outils. Si vous n’avez pas la version Python, vous pouvez la télécharger depuis le site web Python.

1. Sur le menu de navigation de gauche, sélectionnez Pipelines.

   

2. Sélectionnez Créer un pipeline.

   

3. Dans la boîte de dialogue Où se trouve votre code, sélectionnez GitHub. Vous pourriez être invité à vous connecter à GitHub.

   

4. Sur l’écran Sélectionner un référentiel, sélectionnez le référentiel d’exemple dupliqué (fork).

   

5. Vous serez peut-être invité à entrer à nouveau votre mot de passe GitHub en guise de confirmation.

6. Si l’extension Azure Pipelines n’est pas installée sur GitHub, GitHub vous invite à installer l’extension Azure Pipelines.

   

   Sur cette page, faites défiler jusqu’à la section Accès au référentiel, choisissez d’installer l’extension sur tous les référentiels ou uniquement sur certains, puis sélectionnez Approuver et installer.

   

7. Dans la boîte de dialogue Configurer votre pipeline, sélectionnez Python vers l’application Web Linux sur Azure.

8. Sélectionnez votre abonnement Azure et sélectionnez Continuer.

9. Si vous utilisez votre nom d’utilisateur et votre mot de passe pour vous authentifier, un navigateur s’ouvre pour vous permettre de vous connecter à votre compte Microsoft.

10. Sélectionnez le nom de votre application web dans la liste déroulante et sélectionnez Valider et configurer.

Azure Pipelines crée un fichier azure-pipelines.yml et l’affiche dans l’éditeur de pipelines YAML. Le fichier de pipeline définit votre pipeline CI/CD comme une série de stades, de Jobs et d’étapes, où chaque étape contient les détails de différentes tâches et scripts. Examinez le pipeline pour voir à quoi il sert. Assurez-vous que toutes les entrées par défaut sont adaptées à votre code.

1. Dans le menu de navigation, sélectionnez Pipelines.

   

2. Sélectionnez Créer un pipeline.

   

3. Dans la boîte de dialogue Où se trouve votre code, sélectionnez GitHub Enterprise Server. Vous pourriez être invité à vous connecter à GitHub.

   

4. Sur l’onglet Sélectionner un référentiel, sélectionnez le référentiel d’exemple dupliqué (fork).

   

5. Vous serez peut-être invité à entrer à nouveau votre mot de passe GitHub en guise de confirmation.

6. Si l’extension Azure Pipelines n’est pas installée sur GitHub, GitHub vous invite à installer l’extension Azure Pipelines.

   

   Sur cette page, faites défiler jusqu’à la section Accès au référentiel, choisissez d’installer l’extension sur tous les référentiels ou uniquement sur certains, puis sélectionnez Approuver et installer.

   

7. Dans la boîte de dialogue Configurer votre pipeline, sélectionnez Pipeline de départ.

8. Remplacez le contenu du fichier azure-pipelines.yml par le code suivant.

   trigger:
   - main
   
   variables:
     # Azure Resource Manager connection created during pipeline creation
     azureServiceConnectionId: '<your-service-connection-name>'
   
     # Web app name
     webAppName: '<your-web-app-name>'
   
     # Environment name
     environmentName: '<your-web-app-name>'
   
     # Project root folder. 
     projectRoot: $(System.DefaultWorkingDirectory)
   
     # Python version: 
     pythonVersion: '<your-python-version>'
   
   stages:
   - stage: Build
     displayName: Build stage
     jobs:
     - job: BuildJob
       pool:
         name: '<your-pool-name>'
         demands: python
       steps:
       - task: UsePythonVersion@0
         inputs:
           versionSpec: '$(pythonVersion)'
         displayName: 'Use Python $(pythonVersion)'
   
       - script: |
           python -m venv antenv
           source antenv/bin/activate
           python -m pip install --upgrade pip
           pip install -r requirements.txt
         workingDirectory: $(projectRoot)
         displayName: "Install requirements"
   
       - task: ArchiveFiles@2
         displayName: 'Archive files'
         inputs:
           rootFolderOrFile: '$(projectRoot)'
           includeRootFolder: false
           archiveType: zip
           archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
           replaceExistingArchive: true
   
       - task: PublishBuildArtifacts@1
         inputs:
           PathtoPublish: '$(Build.ArtifactStagingDirectory)'
           ArtifactName: 'drop'
           publishLocation: 'Container'
   
   - stage: Deploy
     displayName: 'Deploy Web App'
     dependsOn: Build
     condition: succeeded()
     jobs:
     - deployment: DeploymentJob
       pool:
         name: '<your-pool-name'
       environment: $(environmentName)
       strategy:
         runOnce:
           deploy:
             steps:
   
             - task: UsePythonVersion@0
               inputs:
                 versionSpec: '$(pythonVersion)'
               displayName: 'Use Python version'
   
             - task: AzureWebApp@1
               displayName: 'Deploy Azure Web App : <your-web-app-name>'
               inputs:
                 azureSubscription: $(azureServiceConnectionId)
                 appName: $(webAppName)
                 package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
                 startUpCommand: 'startup.txt'
   
   

9. Remplacez les espaces réservés suivants par vos propres valeurs :

   Espace réservé	Description
   <your-service-connection-name>	Le nom de la connexion au service que vous avez créée.
   <your-web-app-name>	Le nom de votre application web Azure App Service.
   <your-pool-name>	Le nom du pool d’agents que vous souhaitez utiliser.
   <your-python-version>	La version de Python utilisée sur votre agent. Il est conseillé de faire correspondre cette version avec la version de Python utilisée sur votre application web. La version de l’application web est affichée dans la sortie JSON de la commande az webapp up.

L’exemple complet de fichier YAML de pipeline est illustré ci-dessous :

trigger:
- main

variables:
  # Azure Resource Manager connection created during pipeline creation
  azureServiceConnectionId: '<GUID>'

  # Web app name
  webAppName: '<your-webapp-name>'

  # Agent VM image name
  vmImageName: 'ubuntu-latest'

  # Environment name
  environmentName: '<your-webapp-name>'

  # Project root folder. Point to the folder containing manage.py file.
  projectRoot: $(System.DefaultWorkingDirectory)

  pythonVersion: '3.11'

stages:
- stage: Build
  displayName: Build stage
  jobs:
  - job: BuildJob
    pool:
      vmImage: $(vmImageName)
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python $(pythonVersion)'

    - script: |
        python -m venv antenv
        source antenv/bin/activate
        python -m pip install --upgrade pip
        pip install setup
        pip install -r requirements.txt
      workingDirectory: $(projectRoot)
      displayName: "Install requirements"

    - task: ArchiveFiles@2
      displayName: 'Archive files'
      inputs:
        rootFolderOrFile: '$(projectRoot)'
        includeRootFolder: false
        archiveType: zip
        archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
        replaceExistingArchive: true

    - upload: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
      displayName: 'Upload package'
      artifact: drop

- stage: Deploy
  displayName: 'Deploy Web App'
  dependsOn: Build
  condition: succeeded()
  jobs:
  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)
    strategy:
      runOnce:
        deploy:
          steps:

          - task: UsePythonVersion@0
            inputs:
              versionSpec: '$(pythonVersion)'
            displayName: 'Use Python version'

          - task: AzureWebApp@1
            displayName: 'Deploy Azure Web App : $(webAppName)'
            inputs:
              azureSubscription: $(azureServiceConnectionId)
              appName: $(webAppName)
              package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip

La section variables contient les variables suivantes :

variables:
# Azure Resource Manager connection created during pipeline creation
azureServiceConnectionId: '<GUID>'

# Web app name
webAppName: '<your-webapp-name>'

# Agent VM image name
vmImageName: 'ubuntu-latest'

# Environment name
environmentName: '<your-webapp-name>'

# Project root folder.
projectRoot: $(System.DefaultWorkingDirectory)

# Python version: 3.11. Change this to match the Python runtime version running on your web app.
pythonVersion: '3.11'

La section variables contient les variables suivantes :

variables:
# Azure Resource Manager connection created during pipeline creation
azureServiceConnectionId: '<your-service-connection-name>'

# Web app name
webAppName: '<your-webapp-name>'

# Environment name
environmentName: '<your-webapp-name>'

# Project root folder. 
projectRoot: $(System.DefaultWorkingDirectory)

# Python version: 3.11. Change this to the version that is running on your agent and web app.
pythonVersion: '3.11'

L’étape de build contient un seul travail qui s’exécute sur le système d’exploitation défini dans la variable vmImageName.

  - job: BuildJob
    pool:
      vmImage: $(vmImageName)

L’étape de build contient un seul travail qui s’exécute sur un agent dans le pool identifié par le paramètre name. Vous pouvez spécifier les capacités de l’agent avec le mot-clé demands. Par exemple, demands: python spécifie que l’agent doit avoir Python installé. Pour spécifier un agent auto-hébergé par nom, vous pouvez utiliser le mot-clé demands: Agent.Name -equals <agent-name>.

  - job: BuildJob
    pool:
      name: <your-pool-name>
      demands: python

  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)

  - deployment: DeploymentJob
    pool:
      name: <your-pool-name>
    environment: $(environmentName)

Les steps dans le pipeline sont :

1. Utilisez la tâche UsePythonVersion pour spécifier la version de Python à utiliser sur l’agent. La version est définie dans la variable pythonVersion.

    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python version'
   

2. Déployez l’application web à l’aide de la tâche AzureWebApp@1. Cette tâche déploie l’artefact de pipeline drop sur votre application web.

   - task: AzureWebApp@1
      displayName: 'Deploy Azure Web App : <your-web-app-name>'
      inputs:
         azureSubscription: $(azureServiceConnectionId)
         appName: $(webAppName)
         package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
   

   Paramètre	Description
   azureSubscription	L’ID ou le nom de connexion au service Azure Resource Manager à utiliser.
   appName	Nom de l’application web.
   package	L’emplacement du fichier .zip à déployer.

   De plus, comme le référentiel python-vscode-flask-tutorial contient la même commande de démarrage dans un fichier nommé startup.txt, vous pouvez spécifier ce fichier en ajoutant le paramètre : startUpCommand: 'startup.txt'.

Les steps dans le pipeline sont :

1. Utilisez la tâche UsePythonVersion pour spécifier la version de Python à utiliser sur l’agent. La version est définie dans la variable pythonVersion.

    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python version'
   

2. Déployez l’application web à l’aide de la tâche AzureWebApp@1. Cette tâche déploie l’artefact de pipeline drop sur votre application web.

   - task: AzureWebApp@1
      displayName: 'Deploy Azure Web App : <your-web-app-name>'
      inputs:
         azureSubscription: $(azureServiceConnectionId)
         appName: $(webAppName)
         package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
   

   Paramètre	Description
   azureSubscription	L’ID ou le nom de connexion au service Azure Resource Manager à utiliser.
   appName	Nom de l’application web.
   package	L’emplacement du fichier .zip à déployer.

   De plus, comme le référentiel python-vscode-flask-tutorial contient la même commande de démarrage dans un fichier nommé startup.txt, vous pouvez spécifier ce fichier en ajoutant le paramètre : startUpCommand: 'startup.txt'.

     - task: AzureWebApp@1
        displayName: 'Deploy Azure Web App : $(webAppName)'
        inputs:
          azureSubscription: $(azureServiceConnectionId)
          appName: $(webAppName)
          package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
          startUpCommand: 'startup.txt'
   

   Paramètre	Description
   azureSubscription	L’ID ou le nom de connexion au service Azure Resource Manager à utiliser.
   appName	Nom de l’application web.
   package	L’emplacement du fichier .zip à déployer.
   startUpCommand	La commande à exécuter après le déploiement de l’application. L’application d’exemple utilise startup.txt.