Veröffentlichung in Entwicklungs- und Testumgebungen mithilfe von Windows PowerShell-Skripts

Wenn Sie eine Webanwendung in Visual Studio erstellen, können Sie ein Windows PowerShell-Skript generieren. Mit diesem können Sie später die Veröffentlichung Ihrer Website in Azure als Web-App im Azure App Service oder als virtueller Computer automatisieren. Sie können das Windows PowerShell-Skript im Visual Studio-Editor entsprechend Ihren Anforderungen bearbeiten und erweitern oder das Skript in vorhandene Build-, Test- und Veröffentlichungsskripts integrieren.

Mithilfe dieser Skripts können Sie angepasste Versionen Ihrer Website (auch als Entwicklungs- und Testumgebungen bezeichnet) zur vorübergehenden Verwendung bereitstellen. Sie können z. B. eine bestimmte Version Ihrer Website auf einem virtuellen Azure-Computer oder auf dem Stagingslot einer Website einrichten, um eine Testsuite auszuführen, einen Bug zu reproduzieren, einen Bugfix zu testen, eine vorgeschlagene Änderung zu prüfen oder eine benutzerdefinierte Umgebung für eine Demonstration oder eine Präsentation einzurichten. Nachdem Sie ein Skript zum Veröffentlichen Ihres Projekts erstellt haben, können Sie identische Umgebungen erstellen, indem Sie das Skript bei Bedarf erneut ausführen. Sie können das Skript auch mit Ihrem eigenen Build Ihrer Webanwendung ausführen, um eine benutzerdefinierte Umgebung für Testzwecke zu erstellen.

Voraussetzungen

• Visual Studio mit dem Azure-Workload installiert. Siehe Visual Studio-Downloads.
• Azure PowerShell 0.7.4 oder höher. Weitere Informationen finden Sie unter Installieren und Konfigurieren von Azure PowerShell.
• Windows PowerShell 3.0 oder höher.
• Ein Azure-Konto. Wenn Sie nicht über ein Azure-Konto verfügen, aktivieren Sie Ihre Azure-Nutzen für Visual Studio-Abonnenten oder registrieren Sie sich für eine kostenlose Testversion.

Weitere Tools

Für die Arbeit mit PowerShell in Visual Studio für die Azure-Entwicklung stehen weitere Tools und Ressourcen zur Verfügung. Weitere Informationen finden Sie unter PowerShell-Tools für Visual Studio.

Generieren der Veröffentlichungsskripts

Sie können die Veröffentlichungsskripts für einen virtuellen Computer generieren, der Ihre Website hostet, wenn Sie ein neues Projekt anhand dieser Anweisungen erstellen. Sie können auch Veröffentlichungsskripts für Web-Apps in Azure App Service generieren.

Von Visual Studio generierte Skripts

Visual Studio generiert einen Ordner auf Projektebene namens PublishScripts, der zwei Windows PowerShell-Dateien enthält – ein Veröffentlichungsskript für Ihren virtuellen Computer oder die Website und ein Modul, das Funktionen enthält, die Sie in den Skripts verwenden können. Visual Studio generiert außerdem eine Datei im JSON-Format, die die Details des von Ihnen bereitgestellten Projekts angibt.

Windows PowerShell-Veröffentlichungsskript

Das Veröffentlichungsskript enthält spezifische Veröffentlichungsschritte für die Bereitstellung auf einer Website oder einem virtuellen Computer. Visual Studio stellt farbige Syntaxmarkierung für die Windows PowerShell-Entwicklung zur Verfügung. Hilfe zu den einzelnen Funktionen ist verfügbar, und Sie können die Funktionen im Skript frei bearbeiten und so an Ihre sich ändernden Anforderungen anpassen.

Windows PowerShell-Modul

Das von Visual Studio generierte Windows PowerShell-Modul enthält Funktionen, die vom Veröffentlichungsskript verwendet werden. Diese Azure PowerShell-Funktionen sollten nicht geändert werden. Weitere Informationen finden Sie unter Installieren und Konfigurieren von Azure PowerShell.

JSON-Konfigurationsdatei

Die JSON-Datei wird im Ordner Konfigurationen erstellt und enthält die spezifischen Konfigurationsdaten, die genau angeben, welche Ressourcen in Azure bereitgestellt werden. Der Name der von Visual Studio generierten Datei lautet "projektname-WAWS-dev.json", wenn Sie eine Website erstellt haben, bzw. "projektname-VM-dev.json", wenn Sie einen virtuellen Computer erstellt haben. Das folgende Beispiel zeigt eine JSON-Konfigurationsdatei, die generiert wird, wenn Sie eine Website erstellen. Die meisten Werte sind selbsterklärend. Der Websitename wird von Azure generiert. Er stimmt daher ggf. nicht mit Ihrem Projektnamen überein.

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

Wenn Sie einen virtuellen Computer erstellen, sieht die JSON-Konfigurationsdatei wie im folgenden Beispiel aus. Ein Clouddienst wird als Container für den virtuellen Computer erstellt. Der virtuelle Computer enthält die üblichen Endpunkte für den Webzugriff über HTTP und HTTPS sowie Endpunkte für Web Deploy. Letzteres ermöglicht die Veröffentlichung auf der Website über Ihren lokalen Computer, Remotedesktop und 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"
        }
    }
}

Sie können die JSON-Konfiguration bearbeiten, um das Verhalten beim Ausführen der Veröffentlichungsskripts zu ändern. Die Abschnitte cloudService und virtualMachine sind erforderlich, der Abschnitt databases kann jedoch gelöscht werden, wenn er nicht benötigt wird. Die Eigenschaften, die in der von Visual Studio generierten Standardkonfigurationsdatei leer sind, sind optional. Die Eigenschaften, die in der Standardkonfigurationsdatei Werte aufweisen, sind erforderlich.

Wenn Sie eine Website mit mehreren Bereitstellungsumgebungen (als Slots bezeichnet) anstelle einer einzelnen Produktionswebsite in Azure verwenden, können Sie den Slotnamen in den Namen der Website in der JSON-Konfigurationsdatei einschließen. Wenn Sie z. B. eine Website mit dem Namen mysite und einen zugehörigen Slot namens test verwenden, lautet der URI mysite-test.cloudapp.net. Der richtige Name für die Verwendung in der Konfigurationsdatei ist jedoch mysite(test). Diese Vorgehensweise ist nur möglich, wenn die Website und die Slots bereits in Ihrem Abonnement vorhanden sind. Andernfalls erstellen Sie die Website, indem Sie das Skript ausführen, ohne den Slot anzugeben. Erstellen Sie den Slot dann im Azure-Portal, und führen Sie anschließend das Skript mit dem geänderten Websitenamen aus. Weitere Informationen zu den Bereitstellungsslots für Web-Apps finden Sie unter Einrichten von Stagingumgebungen für Web-Apps in Azure App Service.

Ausführen der Veröffentlichungsskripts

Wenn Sie noch nie zuvor ein Windows PowerShell-Skript ausgeführt haben, müssen Sie zuerst die Ausführungsrichtlinie festlegen, damit die Ausführung von Skripts ermöglicht wird. Die Richtlinie ist eine Sicherheitsmaßnahme, die die Ausführung von Windows PowerShell-Skripts durch Benutzer verhindert, die von Schadsoftware oder Viren betroffen sein könnten, die eine Skriptausführung beinhalten.

Führen Sie das Skript aus.

1. Erstellen Sie das Web Deploy-Paket für Ihr Projekt. Web Deploy-Pakete sind komprimierte Archive (ZIP-Dateien), die Dateien enthalten, die Sie auf Ihre Website oder den virtuellen Computer kopieren möchten. In Visual Studio können Sie Web Deploy-Pakete für beliebige Webanwendungen erstellen.

   

   Weitere Informationen finden Sie unter Gewusst wie: Erstellen eines Webbereitstellungspakets in Visual Studio. Sie können die Erstellung Ihres Web Deploy-Pakets wie unter Customizing and extending the publish scripts (Anpassen und Erweitern des Veröffentlichungsskripts) beschrieben automatisieren.

2. Öffnen Sie im Projektmappen-Explorer das Kontextmenü für das Skript, und wählen Sie dann Mit PowerShell-ISE öffnen aus.

3. Wenn Sie Windows PowerShell-Skripts erstmals auf diesem Computer ausführen, öffnen Sie ein Eingabeaufforderungsfenster mit Administratorberechtigungen, und geben Sie den folgenden Befehl ein:

   Set-ExecutionPolicy RemoteSigned
   

4. Melden Sie sich mithilfe des folgenden Befehls bei Azure an.

   Add-AzureAccount
   

   Geben Sie Ihren Benutzernamen und Ihr Kennwort ein, wenn Sie dazu aufgefordert werden.

   Beachten Sie, dass diese Methode für die Bereitstellung von Azure-Anmeldeinformationen bei einer Automatisierung des Skripts nicht funktioniert. Stattdessen sollten Sie die .publishsettings-Datei zum Bereitstellen von Anmeldeinformationen verwenden. Sie verwenden den Befehl Get-AzurePublishSettingsFile einmalig zum Herunterladen der Datei aus Azure. Danach verwenden Sie Import-AzurePublishSettingsFile, um die Datei zu importieren. Ausführliche Anweisungen finden Sie unter Installieren und Konfigurieren von Azure PowerShell.

5. (Optional:) Wenn Sie Azure-Ressourcen (z.B. virtuelle Computer, Datenbanken und Websites) erstellen möchten, ohne Ihre Webanwendung zu veröffentlichen, verwenden Sie den Befehl Publish-WebApplication.ps1 mit dem Argument -Configuration, das auf die JSON-Konfigurationsdatei festgelegt ist. Diese Befehlszeile verwendet die JSON-Konfigurationsdatei, um zu ermitteln, welche Ressourcen erstellt werden sollen. Da sie die Standardeinstellungen für andere Befehlszeilenargumente verwendet, werden die Ressourcen erstellt, Ihre Webanwendung wird jedoch nicht veröffentlicht. Die Option "–Verbose" stellt weitere Informationen zu den Vorgängen zur Verfügung.

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

6. Verwenden Sie den Befehl Publish-WebApplication.ps1 wie in einem der folgenden Beispiele gezeigt, um das Skript aufzurufen und Ihre Webanwendung zu veröffentlichen. Wenn Sie die Standardeinstellungen für andere Argumente (z.B. den Abonnementnamen, den Namen des Veröffentlichungspakets, die Anmeldeinformationen des virtuellen Computers oder die Anmeldeinformationen des Datenbankservers) außer Kraft setzen müssen, können Sie diese Parameter angeben. Verwenden Sie die Option -Verbose, um weitere Informationen zum Verlauf des Veröffentlichungsvorgangs anzuzeigen.

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

   Wenn Sie einen virtuellen Computer erstellen, sieht der Befehl wie im folgenden Beispiel aus. Dieses Beispiel zeigt außerdem, wie die Anmeldeinformationen für mehrere Datenbanken angegeben werden. Für die virtuellen Computer, die durch diese Skripts erstellt werden, stammt das SSL-Zertifikat nicht von einer vertrauenswürdigen Stammzertifizierungsstelle. Aus diesem Grund müssen Sie die Option –AllowUntrusted verwenden.

   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
   

   Das Skript kann Datenbanken erstellen, es erstellt jedoch keine Datenbankserver. Wenn Sie einen Datenbankserver erstellen möchten, können Sie die Funktion New-AzureSqlDatabaseServer im Azure-Modul verwenden.

Anpassen und Erweitern der Veröffentlichungsskripts

Sie können das Veröffentlichungsskript und die JSON-Konfigurationsdatei anpassen. Die Funktionen im Windows PowerShell-Modul AzureWebAppPublishModule.psm1 sollten nicht geändert werden. Wenn Sie nur eine andere Datenbank angeben oder einige Eigenschaften des virtuellen Computers ändern möchten, bearbeiten Sie die JSON-Konfigurationsdatei. Wenn Sie die Funktionen des Skripts so erweitern möchten, dass der Buildvorgang und das Testen des Projekts automatisiert werden, können Sie Funktionsstubs in Publish-WebApplication.ps1implementieren.

Wenn Sie den Buildvorgang Ihres Projekts automatisieren möchten, fügen Sie Code hinzu, der MSBuild für New-WebDeployPackage aufruft. Dies wird im folgenden Codebeispiel gezeigt. Der Pfad zum MSBuild-Befehl kann abhängig von der installierten Version von Visual Studio variieren. Zum Ermitteln des richtigen Pfads können Sie die Funktion Get-MSBuildCmd wie in diesem Beispiel gezeigt verwenden.

So automatisieren Sie die Erstellung Ihres Projekts

1. Fügen Sie den Parameter $ProjectFile im Abschnitt mit den globalen Parametern hinzu.

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

2. Kopieren Sie die Funktion Get-MSBuildCmd in Ihre Skriptdatei.

   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. Ersetzen Sie New-WebDeployPackage durch den folgenden Code, und ersetzen Sie die Platzhalter in der Zeile, mit der $msbuildCmd erstellt wird.

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

   Verwenden Sie zum Erstellen Ihrer Webanwendung „MSBuild.exe“. Hilfreiche Informationen finden Sie in der Referenz zur MSBuild-Befehlszeile.

   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)
   

Starten des Buildbefehls

$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. Rufen Sie die Funktion New-WebDeployPackage vor dieser Zeile auf: $Config = Read-ConfigFile $Configuration für Web-Apps bzw. $Config = Read-ConfigFile $Configuration -HasWebDeployPackage:([Bool]$WebDeployPackage) für virtuelle Computer.

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

2. Rufen Sie das angepasste Skript über die Befehlszeile auf, und übergeben Sie das Argument $Project, wie im folgenden Beispiel gezeigt:

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

   Wenn Sie das Testen Ihrer Anwendung automatisieren möchten, fügen Sie der Test-WebApplicationCode hinzu. Stellen Sie in Publish-WebApplication.ps1 sicher, dass die Auskommentierung der Zeilen aufgehoben wird, in denen diese Funktionen aufgerufen werden. Wenn Sie keine Implementierung bereitstellen, können Sie Ihr Projekt manuell mit Visual Studio erstellen und dann das Veröffentlichungsskript zum Veröffentlichen in Azure aufrufen.

Zusammenfassung der Veröffentlichungsfunktion

Wenn Sie Hilfe zu Funktionen abrufen möchten, können Sie an der Windows PowerShell-Eingabeaufforderung den Befehl Get-Help function-nameverwenden. Die Hilfe umfasst Parameterhilfe und Beispiele. Sie finden den gleichen Hilfetext auch in den Skriptquelldateien AzureWebAppPublishModule.psm1 und Publish-WebApplication.ps1. Das Skript und die Hilfe sind in Ihrer Visual Studio-Sprache lokalisiert.

AzureWebAppPublishModule

Publish-WebApplication

Zugehöriger Inhalt

Weitere Informationen zur PowerShell-Skripterstellung finden Sie unter Skripterstellung mit Windows PowerShell. Weitere Azure PowerShell-Skripts finden Sie im Script Center.