Utilisation de scripts Windows PowerShell pour publier des environnements de développement et de test

Lorsque vous créez une application web dans Visual Studio, vous pouvez générer un script Windows PowerShell que vous pouvez utiliser ultérieurement pour automatiser la publication de votre site web sur Azure en tant qu’application web dans Azure App Service ou dans une machine virtuelle. Vous pouvez modifier et étendre le script Windows PowerShell dans l’éditeur Visual Studio, conformément à vos besoins, ou intégrer le script à la build, aux tests et aux scripts de publication existants.

À l’aide de ces scripts, vous pouvez configurer des versions personnalisées (également connues comme environnements de développement et de test) de votre site pour une utilisation temporaire. Par exemple, vous pouvez configurer une version particulière de votre site web sur une machine virtuelle Azure ou sur l’emplacement intermédiaire d’un site web pour exécuter une suite de tests, reproduire un bogue, tester un correctif, évaluer une proposition de modification ou configurer un environnement personnalisé pour une démonstration ou une présentation. Une fois que vous avez créé un script qui publie votre projet, vous pouvez recréer des environnements identiques en réexécutant le script en fonction des besoins, ou en exécutant le script avec votre propre build de votre application web pour créer un environnement personnalisé de test.

Prérequis

• Visual Studio avec la charge de travail Azure installée. Voir Téléchargements Visual Studio.
• Azure PowerShell 0.7.4 ou version ultérieure. Consultez Installation et configuration d’Azure PowerShell.
• Windows PowerShell 3.0 ou version ultérieure.
• Un compte Azure. Si vous ne possédez pas de compte Azure, activez vos avantages Azure pour les abonnés Visual Studio ou inscrivez-vous pour un essai gratuit.

Outils supplémentaires

Des outils et ressources supplémentaires sont disponibles pour l’utilisation de PowerShell dans Visual Studio pour le développement Azure. Consultez Outils PowerShell pour Visual Studio.

Génération de scripts de publication

Vous pouvez générer des scripts de publication pour une machine virtuelle qui héberge votre site web lorsque vous créez un projet en suivant ces instructions. Vous pouvez également Générer des scripts de publication pour les applications web dans Azure App Service.

Scripts générés par Visual Studio

Visual Studio génère un dossier au niveau de la solution appelé PublishScripts qui contient deux fichiers Windows PowerShell, un script de publication pour votre machine virtuelle ou site web et un module qui contient les fonctions que vous pouvez utiliser dans les scripts. Visual Studio génère également un fichier au format JSON qui spécifie les détails du projet que vous déployez.

Script de publication Windows PowerShell

Le script de publication contient des étapes de publication spécifiques pour le déploiement sur un site web ou une machine virtuelle. Visual Studio propose la coloration de syntaxe pour le développement de Windows PowerShell. Vous pouvez bénéficier d’une aide sur les fonctions et modifier librement les fonctions dans le script en fonction de l’évolution de vos besoins.

Module Windows PowerShell

Le module Windows PowerShell généré par Visual Studio contient des fonctions que le script de publication utilise. Ces fonctions Azure PowerShell ne sont pas destinées à être modifiées. Consultez Installation et configuration d’Azure PowerShell.

Fichier de configuration JSON

Le fichier JSON est créé dans le dossier Configurations. Il inclut les données de configuration qui spécifient les ressources devant être déployées dans Azure. Le nom du fichier généré par Visual Studio est projet-nom-WAWS-dev.json, si vous avez créé un site web, ou projet-nom-VM-dev.json, si vous avez créé une machine virtuelle. Voici un exemple de fichier de configuration JSON généré lorsque vous créez un site web. La plupart des valeurs sont explicites. Le nom du site web est généré par Azure ; il peut donc ne pas correspondre au nom de votre projet.

{
    "environmentSettings": {
        "webSite": {
            "name": "WebApplication26632",
            "location": "West US"
        },
        "databases": [{
            "connectionStringName": "DefaultConnection",
            "databaseName": "WebApplication26632_db",
            "serverName": "YourDatabaseServerName",
            "user": "sqluser2",
            "password": "",
            "edition": "",
            "size": "",
            "collation": "",
            "location": "West US"
        }]
    }
}

Lorsque vous créez une machine virtuelle, le fichier de configuration JSON ressemble à ce qui suit. Un service cloud est créé comme un conteneur pour la machine virtuelle. La machine virtuelle contient les points de terminaison habituels pour l’accès web via HTTP et HTTPS, ainsi que les points de terminaison pour Web Deploy, ce qui vous permet de publier sur le site web à partir de votre ordinateur local, de la connexion Bureau à distance et de Windows PowerShell.

{
    "environmentSettings": {
        "cloudService": {
            "name": "myusernamevm1",
            "affinityGroup": "",
            "location": "West US",
            "virtualNetwork": "",
            "subnet": "",
            "availabilitySet": "",
            "virtualMachine": {
                "name": "myusernamevm1",
                "vhdImage": "a699494373c04fc0bc8f2bb1389d6106__Win2K8R2SP1-Datacenter-201403.01-en.us-127GB.vhd",
                "size": "Small",
                "user": "vmuser1",
                "password": "",
                "enableWebDeployExtension": true,
                "endpoints": [{
                        "name": "Http",
                        "protocol": "TCP",
                        "publicPort": "80",
                        "privatePort": "80"
                    },
                    {
                        "name": "Https",
                        "protocol": "TCP",
                        "publicPort": "443",
                        "privatePort": "443"
                    },
                    {
                        "name": "WebDeploy",
                        "protocol": "TCP",
                        "publicPort": "8172",
                        "privatePort": "8172"
                    },
                    {
                        "name": "Remote Desktop",
                        "protocol": "TCP",
                        "publicPort": "3389",
                        "privatePort": "3389"
                    },
                    {
                        "name": "Powershell",
                        "protocol": "TCP",
                        "publicPort": "5986",
                        "privatePort": "5986"
                    }
                ]
            }
        },
        "databases": [{
            "connectionStringName": "",
            "databaseName": "",
            "serverName": "",
            "user": "",
            "password": ""
        }],
        "webDeployParameters": {
            "iisWebApplicationName": "Default Web Site"
        }
    }
}

Vous pouvez modifier la configuration JSON pour changer ce qui se passe lorsque vous exécutez les scripts de publication. Les sections cloudService et virtualMachine sont obligatoires, mais vous pouvez supprimer la section databases si vous n’en avez pas besoin. Les propriétés qui sont vides dans le fichier de configuration par défaut généré par Visual Studio sont facultatives ; celles qui ont des valeurs dans le fichier de configuration par défaut sont obligatoires.

Si vous possédez un site web qui compte plusieurs environnements de déploiement (appelés emplacements) au lieu d’un site de production unique dans Azure, vous pouvez inclure le nom de l’emplacement dans le nom du site web dans le fichier de configuration JSON. Par exemple, si votre site web s'appelle mysite et que l'emplacement correspondant se nomme test, l'URI peut être mysite-test.cloudapp.net, bien que le nom correct à utiliser dans le fichier de configuration soit mysite(test). Vous pouvez uniquement effectuer cette opération si le site web et les emplacements existent déjà dans votre abonnement. S’ils n’existent pas, créez le site web en exécutant le script sans spécifier l’emplacement, puis créez l’emplacement dans le portail Azure. Ensuite, exécutez le script avec le nom de site web modifié. Pour plus d’informations sur les emplacements de déploiement pour les applications web, consultez Configurer des environnements intermédiaires pour les applications web dans Azure App Service.

Exécution de scripts de publication

Si vous n’avez jamais exécuté de script Windows PowerShell auparavant, vous devez d’abord définir la stratégie d’exécution pour permettre l’exécution de scripts. Cette stratégie est une fonctionnalité de sécurité visant à empêcher les utilisateurs d’exécuter des scripts Windows PowerShell s’ils sont vulnérables aux programmes malveillants ou aux virus impliquant l’exécution de scripts.

Exécuter le script

1. Créez le package Web Deploy pour votre projet. Un package Web Deploy est une archive compressée (fichier .zip) contenant les fichiers que vous souhaitez copier sur votre site web ou sur votre machine virtuelle. Vous pouvez créer des packages Web Deploy dans Visual Studio pour toute application web.

   

   Pour plus d’informations, consultez Comment : créer un package de déploiement web dans Visual Studio. Vous pouvez également automatiser la création de votre package Web Deploy, comme indiqué dans la section Personnalisation et extension des scripts de publication.

2. Dans l’Explorateur de solutions, ouvrez le menu contextuel du script, puis choisissez Ouvrir avec PowerShell ISE.

3. Si vous exécutez des scripts Windows PowerShell sur cet ordinateur pour la première fois, ouvrez une fenêtre d’invite de commandes avec des privilèges d’administrateur et tapez la commande suivante :

   Set-ExecutionPolicy RemoteSigned
   

4. Connectez-vous à Azure en utilisant la commande suivante.

   Add-AzureAccount
   

   Lorsque vous y êtes invité, indiquez votre nom d’utilisateur et votre mot de passe.

   Notez que lorsque vous automatisez le script, cette méthode de renseignement des informations d’identification Azure ne fonctionne pas. À la place, vous devez utiliser le fichier .publishsettings pour fournir des informations d’identification. Une fois seulement, vous utilisez la commande Get-AzurePublishSettingsFile pour télécharger le fichier à partir d’Azure. Ensuite, vous utilisez Import-AzurePublishSettingsFile pour importer le fichier. Pour des instructions détaillées, consultez Installation et configuration d’Azure PowerShell.

5. (Facultatif) Si vous voulez créer des ressources Azure telles que la machine virtuelle, la base de données et le site web sans avoir à publier votre application web, utilisez la commande Publish-WebApplication.ps1 avec l'argument -Configuration défini pour le fichier de configuration JSON. Cette ligne de commande utilise le fichier de configuration JSON pour déterminer les ressources à créer. Étant donné qu’elle utilise les paramètres par défaut pour les autres arguments de ligne de commande, elle crée les ressources, mais ne publie pas votre application web. L’option –Verbose vous donne plus d’informations sur ce qui se passe.

   Publish-WebApplication.ps1 -Verbose –Configuration C:\Path\WebProject-WAWS-dev.json
   

6. Utilisez la commande Publish-WebApplication.ps1 comme montré dans l'un des exemples suivants pour appeler le script et publier votre application web. Si vous souhaitez remplacer les paramètres par défaut de tout autre argument, comme le nom de l’abonnement, le nom du package de publication, les informations d’identification de la machine virtuelle ou les informations d’identification du serveur de base de données, vous pouvez spécifier ces paramètres. Utilisez l’option –Verbose pour afficher des informations supplémentaires sur l’avancement du processus de publication.

   Publish-WebApplication.ps1 –Configuration C:\Path\WebProject-WAWS-dev-json `
   –SubscriptionName Contoso `
   -WebDeployPackage C:\Documents\Azure\ADWebApp.zip `
   -DatabaseServerPassword @{Name="dbServerName";Password="adminPassword"} `
   -Verbose
   

   Si vous créez une machine virtuelle, la commande ressemble à ce qui suit. Cet exemple montre également comment spécifier les informations d’identification pour plusieurs bases de données. Pour les machines virtuelles créées par ces scripts, le certificat SSL n’est pas d’une autorité racine de confiance. Vous devez donc utiliser l’option –AllowUntrusted.

   Publish-WebApplication.ps1 `
   -Configuration C:\Path\ADVM-VM-test.json `
   -SubscriptionName Contoso `
   -WebDeployPackage C:\Path\ADVM.zip `
   -AllowUntrusted `
   -VMPassword @{name = "vmUserName"; password = "YourPasswordHere"} `
   -DatabaseServerPassword @{Name="server1";Password="adminPassword1"}, @{Name="server2";Password="adminPassword2"} `
   -Verbose
   

   Le script peut créer des bases de données, mais il ne crée pas de serveurs de base de données. Si vous souhaitez créer un serveur de base de données, vous pouvez utiliser la fonction New-AzureSqlDatabaseServer du module Azure.

Personnalisation et extension des scripts de publication

Vous pouvez personnaliser le script de publication et le fichier de configuration JSON. Les fonctions dans le module Windows PowerShell AzureWebAppPublishModule.psm1 ne sont pas destinées à être modifiées. Si vous souhaitez simplement spécifier une autre base de données ou modifier certaines propriétés de la machine virtuelle, modifiez le fichier de configuration JSON. Si vous voulez étendre les fonctionnalités du script afin d’automatiser la création et le test de votre projet, vous pouvez implémenter des stubs de fonction dans Publish-WebApplication.ps1.

Pour automatiser la création de votre projet, ajoutez le code appelant MSBuild sur New-WebDeployPackage , comme illustré dans cet exemple de code. Le chemin d’accès à la commande MSBuild est différent selon la version de Visual Studio que vous avez installée. Pour obtenir le chemin d’accès correct, vous pouvez utiliser la fonction Get-MSBuildCmd, comme illustré dans cet exemple.

Pour automatiser la création de votre projet

1. Ajoutez le paramètre $ProjectFile dans la section des paramètres globaux.

   [Parameter(Mandatory = $false)]
   [ValidateScript({Test-Path $_ -PathType Leaf})]
   [String]
   $ProjectFile,
   

2. Copiez la fonction Get-MSBuildCmd dans votre fichier de script.

   function Get-MSBuildCmd
   {
      process
      {
       $StartInfo  = New-Object System.Diagnostics.ProcessStartInfo;
       $StartInfo.Filename = ${Env:ProgramFiles(x86)} + "\\Microsoft Visual Studio\\Installer\\vswhere.exe"
       $StartInfo.Arguments = " -latest -requires Microsoft.Component.MSBuild -find MSBuild\\**\\Bin\\MSBuild.exe"
       $StartInfo.RedirectStandardOutput = $True
       $StartInfo.UseShellExecute = $False
       [System.Diagnostics.Process] $VSWhere = [Diagnostics.Process]::Start($StartInfo)
       $VSWhere.WaitForExit()
       return $VSWhere.StandardOutput.ReadToEnd();
       }
   }
   

3. Remplacez New-WebDeployPackage avec le code suivant et remplacez les espaces réservés dans la ligne créant $msbuildCmd.

   function New-WebDeployPackage
   {
       #Write a function to build and package your web application
   

   Pour générer votre application web, utilisez MSBuild.exe. Pour obtenir de l’aide, consultez le Guide de référence des lignes de commande MSBuild

   Write-VerboseWithTime 'Build-WebDeployPackage: Start'
   
   $msbuildCmd = '"{0}" "{1}" /T:Rebuild;Package /p:OutputPath="{2}\MSBuildOutputPath" /flp:logfile=msbuild.log,v=d' -f (Get-MSBuildCmd), $ProjectFile, $scriptDirectory
   
   Write-VerboseWithTime ('Build-WebDeployPackage: ' + $msbuildCmd)
   

Démarrez l’exécution de la commande build

$job = Start-Process cmd.exe -ArgumentList('/C "' + $msbuildCmd + '"') -WindowStyle Normal -Wait -PassThru

if ($job.ExitCode -ne 0) {
    throw('MSBuild exited with an error. ExitCode:' + $job.ExitCode)
}

#Obtain the project name
$projectName = (Get-Item $ProjectFile).BaseName

#Construct the path to web deploy zip package
$DeployPackageDir =  '.\MSBuildOutputPath\_PublishedWebsites\{0}_Package\{0}.zip' -f $projectName

#Get the full path for the web deploy zip package. This is required for MSDeploy to work
$WebDeployPackage = Resolve-Path –LiteralPath $DeployPackageDir

Write-VerboseWithTime 'Build-WebDeployPackage: End'

return $WebDeployPackage
}

1. Appelez la fonction New-WebDeployPackage avant cette ligne : $Config = Read-ConfigFile $Configuration pour les applications web ou $Config = Read-ConfigFile $Configuration -HasWebDeployPackage:([Bool]$WebDeployPackage) pour les machines virtuelles.

   if($ProjectFile)
   {
   $WebDeployPackage = New-WebDeployPackage
   }
   

2. Appelez le script personnalisé à partir de la ligne de commande à l’aide de la transmission de l’argument $Project, comme dans l'exemple suivant :

   .\Publish-WebApplicationVM.ps1 -Configuration .\Configurations\WebApplication5-VM-dev.json `
   -ProjectFile ..\WebApplication5\WebApplication5.csproj `
   -VMPassword @{Name="VMUser";Password="Test.123"} `
   -AllowUntrusted `
   -Verbose
   

   Pour automatiser le test de votre application, ajoutez le code à Test-WebApplication. Veillez à supprimer les marques de commentaire des lignes dans Publish-WebApplication.ps1 où ces fonctions sont appelées. Si vous ne fournissez pas d’implémentation, vous pouvez créer votre projet manuellement avec Visual Studio, puis exécuter le script de publication pour publier dans Azure.

Résumé de la fonction de publication

Pour obtenir de l’aide pour les fonctions que vous pouvez utiliser à l’invite de commande Windows PowerShell, utilisez la commande Get-Help function-name. L’aide inclut de l’aide sur les paramètres et des exemples. Le même texte d’aide figure également dans les fichiers sources du script, AzureWebAppPublishModule.psm1 et Publish-WebApplication.ps1. Le script et l’aide sont localisés dans votre langue Visual Studio.

AzureWebAppPublishModule

Publish-WebApplication

Contenu connexe

Pour en savoir plus sur l’écriture de scripts PowerShell lisez Écriture de scripts avec Windows PowerShell et consultez d’autres scripts Azure PowerShell sur le Centre de scripts.