Einführung in den Handler der Azure-Erweiterung zum Konfigurieren des gewünschten Zustands

Der Azure VM-Agent und die dazugehörigen Erweiterungen sind Teil der Microsoft Azure-Infrastrukturdienste. VM-Erweiterungen sind Softwarekomponenten, die die VM-Funktionalität erweitern und verschiedene Verwaltungsvorgänge für virtuelle Computer vereinfachen.

Hinweis

Bevor Sie die DSC-Erweiterung aktivieren, sollten Sie wissen, dass jetzt eine neuere Version von DSC als Vorschauversion verfügbar ist, die durch das Feature Gastkonfiguration von Azure Policy verwaltet wird. Die Gastkonfigurationsfunktion kombiniert Funktionen des Desired State Configuration (DSC)-Erweiterungshandlers, der Azure Automation State Configuration und die am häufigsten angeforderten Funktionen aus Kundenfeedback. Die Gastkonfiguration umfasst auch die Unterstützung von Hybridcomputern über Arc-fähige Server.

Der primäre Anwendungsfall für die Azure DSC-Erweiterung (Desired State Configuration) besteht im Bootstrap eines virtuellen Computers zum Azure Automation DSC-Dienst. Der Dienst bietet Vorteile wie die fortlaufende Verwaltung der VM-Konfiguration und die Integration mit anderen Betriebstools wie Azure Monitoring. Der Einsatz der Erweiterung zum Registrieren von VMs beim Dienst stellt eine flexible Lösung dar, die sogar übergreifend über Azure-Abonnements funktioniert.

Sie können die DSC-Erweiterung unabhängig vom Automation DSC-Dienst verwenden. Allerdings wird dadurch nur eine Konfiguration per Push in die VM übertragen. Es ist keine fortlaufende Berichterstellung verfügbar, lediglich lokal in der VM.

Dieser Artikel enthält Informationen zu beiden Szenarien: die Verwendung der DSC-Erweiterung für Automation Onboarding und die Verwendung der DSC-Erweiterung als Tool zum Zuweisen von Konfigurationen zu virtuellen Computern mit dem Azure SDK.

Voraussetzungen

• Lokaler Computer: Für die Interaktion mit der Erweiterung für virtuelle Azure-Computer müssen Sie das Azure-Portal oder das Azure PowerShell SDK verwenden.
• Gast-Agent: Der mit der DSC-Konfiguration konfigurierte Azure-Computer muss über ein Betriebssystem verfügen, das Version 4.0 oder höher von Windows Management Framework (WMF) unterstützt. Die vollständige Liste der unterstützten Betriebssystemversionen finden Sie im Versionsverlauf der DSC-Erweiterung.

Begriffe und Konzepte

Für dieses Handbuch müssen Sie mit folgenden Konzepten vertraut sein:

• Konfiguration: Ein DSC-Konfigurationsdokument.
• Knoten: Ein Ziel für die DSC-Konfiguration. In diesem Dokument bezieht sich Knoten immer auf einen virtuellen Azure-Computer.
• Konfigurationsdaten: Eine PSD1-Datei mit Umgebungsdaten für eine Konfiguration.

Aufbau

Die Azure DSC-Erweiterung nutzt das VM-Agent-Framework von Azure zur Übermittlung und Inkraftsetzung von DSC-Konfigurationen auf virtuellen Azure-Computern sowie zur Erstellung entsprechender Berichte. Die DSC-Erweiterung nimmt ein Konfigurationsdokument und einen Satz von Parametern entgegen. Wird keine Datei angegeben, wird ein Standardkonfigurationsskript in die Erweiterung eingebettet. Dieses wird ausschließlich zum Festlegen von Metadaten im lokalen Konfigurations-Manager verwendet.

Wenn die Erweiterung das erste Mal aufgerufen wird, installiert sie mit der folgenden Logik eine Version von Windows Management Framework (WMF):

• Bei einem virtuellen Azure-Computer unter Windows Server 2016 wird keine Aktion ausgeführt. Unter Windows Server 2016 ist bereits die neueste Version von PowerShell installiert.
• Bei Angabe der Eigenschaft wmfVersion wird die entsprechende WMF-Version installiert (es sei denn, die Version ist nicht mit dem Betriebssystem des virtuellen Computers kompatibel).
• Ohne Angabe der Eigenschaft wmfVersion wird die neueste geeignete WMF-Version installiert.

Für die Installation von WMF ist ein Neustart erforderlich. Nach dem Neustart lädt die Erweiterung die in der modulesUrl-Eigenschaft angegebene ZIP-Datei herunter (falls vorhanden). Befindet sich der Speicherort in Azure Blob Storage, können Sie in der sasToken-Eigenschaft ein SAS-Token für den Dateizugriff angeben. Nachdem Herunterladen und Entpacken der ZIP-Datei wird durch Ausführen der in configurationFunction definierten Konfigurationsfunktion eine MOF-Datei (Managed Object Format) generiert. Anschließend führt die Erweiterung Start-DscConfiguration -Force mit der generierten MOF-Datei aus. Die Erweiterung erfasst die Ausgabe und schreibt sie in den Azure-Statuskanal.

Standardkonfigurationsskript

Die Azure-DSC-Erweiterung enthält ein Standardkonfigurationsskript, das für das Onboarding eines virtuellen Computers in den Azure Automation DSC-Dienst vorgesehen ist. Die Skriptparameter sind an den konfigurierbaren Eigenschaften des lokalen Konfigurations-Managers ausgerichtet. Informationen zu Skriptparametern erhalten Sie in Abschnitt Standardkonfigurationsskript des Artikels Erweiterung zum Konfigurieren des gewünschten Zustands mit Azure Resource Manager-Vorlagen. Das vollständige Skript finden Sie in der Azure Schnellstartvorlage in GitHub.

Informationen zum Registrieren beim Azure Automation DSC-Dienst (State Configuration)

Beim Verwenden der DSC-Erweiterung zum Registrieren eines Knotens beim State Configuration-Dienst müssen drei Werte angegeben werden.

• RegistrationUrl – die HTTPS-Adresse des Azure Automation-Kontos
• RegistrationKey – ein gemeinsames Geheimnis, das zum Registrieren von Knoten beim Dienst verwendet wird
• NodeConfigurationName – der Name der Knotenkonfiguration (MOF), die beim Dienst abgerufen werden soll, um die Serverrolle zu konfigurieren

Sie können diese Informationen im Azure-Portal anzeigen oder PowerShell verwenden.

(Get-AzAutomationRegistrationInfo -ResourceGroupName <resourcegroupname> -AutomationAccountName <accountname>).Endpoint
(Get-AzAutomationRegistrationInfo -ResourceGroupName <resourcegroupname> -AutomationAccountName <accountname>).PrimaryKey

Achten Sie beim Namen der Knotenkonfiguration darauf, dass die Knotenkonfiguration in Azure State Configuration vorhanden ist. Ist das nicht der Fall, gibt die Erweiterungsbereitstellung einen Fehler zurück. Achten Sie außerdem darauf, dass Sie den Namen der Knotenkonfiguration verwenden, nicht den der Konfiguration. Eine Konfiguration ist in einem Skript definiert, das zum Kompilieren der Knotenkonfiguration (MOF-Datei) verwendet wird. Der Name ist immer die Konfiguration, gefolgt von einem Punkt . und entweder localhost oder dem Namen eines bestimmten Computers.

DSC-Erweiterung in Resource Manager-Vorlagen

In den meisten Szenarien sind Resource Manger-Bereitstellungsvorlagen die erwartete Methode für die Arbeit mit der DSC-Erweiterung. Weitere Informationen und Beispiele zum Einschließen der DSC-Erweiterung in Resource Manager-Bereitstellungsvorlagen finden Sie unter Erweiterung zum Konfigurieren des gewünschten Zustands mit Azure Resource Manager-Vorlagen.

PowerShell-Cmdlets für die DSC-Erweiterung

Die PowerShell-Cmdlets zum Verwalten der DSC-Erweiterung werden am besten für die interaktive Problembehandlung und zum Sammeln von Informationen verwendet. Sie können die Cmdlets zum Verpacken, Veröffentlichen und Überwachen der Bereitstellung der DSC-Erweiterung verwenden. Cmdlets für die DSC-Erweiterung wurden noch nicht für die Verwendung mit dem Standardkonfigurationsskript aktualisiert.

Mit dem Cmdlet Publish-AzVMDscConfiguration wird eine Konfigurationsdatei nach abhängigen DSC-Ressourcen durchsucht und eine ZIP-Datei erstellt. Die ZIP-Datei enthält die Konfiguration und die erforderlichen Ressourcen für deren Inkraftsetzung. Mit dem Parameter -OutputArchivePath kann das Cmdlet das Paket auch lokal erstellen. Andernfalls veröffentlicht das Cmdlet die ZIP-Datei in Azure Blob Storage und schützt sie durch ein SAS-Token.

Das von diesem Cmdlet erstellte PS1-Konfigurationsskript befindet sich in der ZIP-Datei im Stammverzeichnis des Archivordners. Der Modulordner wird im Archivordner in den Ressourcen platziert.

Mit dem Cmdlet Set-AzVMDscExtension werden die für die PowerShell DSC-Erweiterung erforderlichen Einstellungen in einem VM-Konfigurationsobjekt eingefügt.

Mit dem Cmdlet Get-AzVMDscExtension wird der DSC-Erweiterungsstatus eines bestimmten virtuellen Computers abgerufen.

Mit dem Cmdlet Get-AzVMDscExtensionStatus wird der Status der DSC-Konfiguration abgerufen, die vom DSC-Erweiterungshandler durchgeführt wird. Diese Aktion kann auf einem einzelnen virtuellen Computer oder einer Gruppe virtueller Computer ausgeführt werden.

Mit dem Cmdlet Remove-AzVMDscExtension wird der Erweiterungshandler von einem bestimmten virtuellen Computer entfernt. Dieses Cmdlet bewirkt nicht die Entfernung der Konfiguration, die Deinstallation von WMF oder eine Änderung der angewendeten Einstellungen auf dem virtuellen Computer. Es wird lediglich der Erweiterungshandler entfernt.

Wichtige Informationen zu Cmdlets für die Resource Manager-DSC-Erweiterung:

• Azure Resource Manager-Cmdlets sind synchron.
• Die Parameter ResourceGroupName, VMName, ArchiveStorageAccountName, Version und Location sind erforderlich.
• ArchiveResourceGroupName ist ein optionaler Parameter. Diesen Parameter können Sie angeben, wenn Ihr Speicherkonto nicht der Ressourcengruppe angehört, in der der virtuelle Computer erstellt wird.
• Der Schalter AutoUpdate ermöglicht die automatische Aktualisierung des Erweiterungshandlers auf die neueste Version, sobald diese verfügbar ist. Durch diesen Parameter wird die VM unter Umständen neu gestartet, wenn eine neue WMF-Version veröffentlicht wird.

Erste Schritte mit Cmdlets

Die Azure-DSC-Erweiterung kann DSC-Konfigurationsdokumente zum Konfigurieren von virtuellen Azure-Computern während der Bereitstellung verwenden. Bei diesem Schritt wird der Knoten nicht bei Azure Automation registriert. Der Knoten wird nicht zentral verwaltet.

Nachfolgend sehen Sie ein einfaches Beispiel für eine Konfiguration. Speichern Sie die Konfiguration lokal als „iisInstall.ps1“.

configuration IISInstall
{
    node "localhost"
    {
        WindowsFeature IIS
        {
            Ensure = "Present"
            Name = "Web-Server"
        }
    }
}

Mit den folgenden Befehlen platzieren Sie das Skript „iisInstall.ps1“ auf dem angegebenen virtuellen Computer. Mit den Befehlen führen Sie auch die Konfiguration aus und melden anschließend den Status.

$resourceGroup = 'dscVmDemo'
$vmName = 'myVM'
$storageName = 'demostorage'
#Publish the configuration script to user storage
Publish-AzVMDscConfiguration -ConfigurationPath .\iisInstall.ps1 -ResourceGroupName $resourceGroup -StorageAccountName $storageName -force
#Set the VM to run the DSC configuration
Set-AzVMDscExtension -Version '2.76' -ResourceGroupName $resourceGroup -VMName $vmName -ArchiveStorageAccountName $storageName -ArchiveBlobName 'iisInstall.ps1.zip' -AutoUpdate -ConfigurationName 'IISInstall'

Bereitstellung mithilfe der Azure-Befehlszeilenschnittstelle

Sie können die DSC-Erweiterung mithilfe der Azure-Befehlszeilenschnittstelle auf einem vorhandenen virtuellen Computer bereitstellen.

Für einen virtuellen Computer unter Windows:

az vm extension set \
  --resource-group myResourceGroup \
  --vm-name myVM \
  --name DSC \
  --publisher Microsoft.Powershell \
  --version 2.77 --protected-settings '{}' \
  --settings '{}'

Für einen virtuellen Computer unter Linux:

az vm extension set \
  --resource-group myResourceGroup \
  --vm-name myVM \
  --name DSCForLinux \
  --publisher Microsoft.OSTCExtensions \
  --version 2.7 --protected-settings '{}' \
  --settings '{}'

Funktionen des Azure-Portals

So richten Sie DSC im Portal ein:

1. Wechseln Sie zu einem virtuellen Computer.
2. Wählen Sie unter Einstellungen die Option Erweiterungen aus.
3. Wählen Sie auf der neu erstellten Seite + Hinzufügen und dann PowerShell Desired State Configuration.
4. Klicken Sie unten auf der angezeigten Informationsseite der Erweiterung auf Erstellen.

Für dieses Portal werden folgende Eingaben erfasst:

• Konfigurationsmodule oder -skript: Dieses Feld ist obligatorisch. (Das Formular wurde nicht für das Standardkonfigurationsskript aktualisiert.) Konfigurationsmodule und Skripts benötigen eine PS1-Datei, die ein Konfigurationsskript oder eine ZIP-Datei mit einer ps1-Konfigurationsskript auf der Stammebene aufweist. Wenn Sie eine ZIP-Datei verwenden, müssen alle abhängigen Ressourcen in Modulordnern in der ZIP-Ordner enthalten sein. Sie können die ZIP-Datei mit dem im Azure PowerShell SDK enthaltenen Cmdlet Publish-AzureVMDscConfiguration -OutputArchivePath erstellen. Die ZIP-Datei wird in Ihren Benutzer-Blobspeicher hochgeladen und durch ein SAS-Token geschützt.

• Modulspezifischer Konfigurationsname: Sie können mehrere Konfigurationsfunktionen in einer PS1-Datei einfügen. Geben Sie den Namen des PS1-Konfigurationsskripts ein – gefolgt von / und dem Namen der Konfigurationsfunktion. Wenn der Name des PS1-Skripts z.B. „configuration.ps1“ und die Konfiguration IisInstall lautet, geben Sie configuration.ps1\IisInstall ein.

• Konfigurationsargumente: Falls die Konfigurationsfunktion Argumente akzeptiert, geben Sie diese hier im Format argumentName1=value1,argumentName2=value2 ein. Hierbei handelt es sich um ein anderes Format als bei den Konfigurationsargumenten, die von PowerShell-Cmdlets oder Resource Manager-Vorlagen akzeptiert werden.

• PSD1-Konfigurationsdatendatei: Wenn Ihre Konfiguration eine Konfigurationsdatendatei in .psd1 erfordert, wählen Sie mithilfe dieses Felds die Datendatei aus, und laden Sie sie in Ihren Benutzerblobspeicher hoch. Die Konfigurationsdatei wird durch ein SAS-Token in einem Blobspeicher geschützt.

• WMF-Version: Gibt die Version von Windows Management Framework (WMF) an, die auf Ihrem virtuellen Computer installiert sein muss. Wenn diese Eigenschaft auf „latest“ festgelegt ist, wird die aktuelle Version von WMF installiert. Die einzigen derzeit möglichen Werte für diese Eigenschaft sind „4.0“, „5.0“, „5.1“ und „latest“. Diese möglichen Werte werden gelegentlich aktualisiert. Der Standardwert ist neueste.

• Datensammlung: Bestimmt, ob die Erweiterung Telemetriedaten sammelt. Weitere Informationen finden Sie unter Azure DSC extension data collection (Datensammlung mit der Azure DSC-Erweiterung).

• Version: Gibt die Version der zu installierenden DSC-Erweiterung an. Informationen zu Versionen finden Sie unter Versionsverlauf der Azure Desired State Configuration-Erweiterung.

• Nebenversion automatisch aktualisieren: Dieses Feld entspricht dem AutoUpdate-Switch in den Cmdlets und ermöglicht die Erweiterung zum automatischen Aktualisieren auf die neueste Installation während der Installation. Ja weist den Erweiterungshandler dazu an, die neueste verfügbare Version zu verwenden, während Nein die Installation der angegebenen Version erzwingt. Wird weder Ja noch Nein ausgewählt, so entspricht dies der Auswahl von Nein.

Protokolle

Protokolle für die Erweiterung werden am folgenden Speicherort gespeichert: C:\WindowsAzure\Logs\Plugins\Microsoft.Powershell.DSC\<version number>

Nächste Schritte

• Weitere Informationen zu PowerShell DSC finden Sie im PowerShell-Dokumentationscenter.
• Überprüfen Sie die Resource Manager-Vorlage für die DSC-Erweiterung.
• Durchsuchen Sie für mehr Funktionalität, die Sie mithilfe von PowerShell DSC verwalten können, und für weitere DSC-Ressourcen den PowerShell-Katalog.
• Informationen zur Weitergabe von sensiblen Parametern in Konfigurationen finden Sie unter Übergeben von Anmeldeinformationen an den Azure DSC-Erweiterungshandler.