Freigeben über

Set-AzureRmVMDscExtension

  • Referenz
Modul:
AzureRM.Compute

Konfiguriert die DSC-Erweiterung auf einem virtuellen Computer.

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul möglicherweise weiterhin funktioniert, wird es nicht mehr gewartet, und es wird kein Support mehr angeboten. Die weitere Nutzung erfolgt daher nach Ermessen und Risiko des Benutzers. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

Set-AzureRmVMDscExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-ArchiveBlobName] <String>
   [-ArchiveStorageAccountName] <String>
   [-ArchiveResourceGroupName <String>]
   [-ArchiveStorageEndpointSuffix <String>]
   [-ArchiveContainerName <String>]
   [-ConfigurationName <String>]
   [-ConfigurationArgument <Hashtable>]
   [-ConfigurationData <String>]
   [-Version] <String>
   [-Force]
   [-Location <String>]
   [-AutoUpdate]
   [-WmfVersion <String>]
   [-DataCollection <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-AzureRmVMDscExtension konfiguriert die Windows PowerShell Desired State Configuration (DSC)-Erweiterung auf einem virtuellen Computer in einer Ressourcengruppe.

Beispiele

Beispiel 1: Festlegen einer DSC-Erweiterung

PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US"

Mit diesem Befehl wird die DSC-Erweiterung auf dem virtuellen Computer mit dem Namen VM07 festgelegt, um Sample.ps1.zip aus dem Speicherkonto "Stg" und dem Standardcontainer herunterzuladen. Der Befehl ruft die Konfiguration mit dem Namen ConfigName auf. Die Sample.ps1.zip Datei wurde zuvor mithilfe von Publish-AzureRmVMDscConfiguration hochgeladen.

Beispiel 2: Festlegen einer DSC-Erweiterung mit Konfigurationsdaten

PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US"

Mit diesem Befehl wird die Erweiterung auf dem virtuellen Computer mit dem Namen VM13 festgelegt, um Sample.ps1.zip aus dem Speicherkonto "Stg" und dem Container mit dem Namen "WindowsPowerShellDSC" herunterzuladen. Der Befehl der Konfiguration mit dem Namen ConfigName und gibt Konfigurationsdaten und Argumente an. Die Sample.ps1.zip Datei wurde zuvor mithilfe von Publish-AzureRmVMDscConfiguration hochgeladen.

Beispiel 3: Festlegen einer DSC-Erweiterung mit Konfigurationsdaten mit automatischer Aktualisierung

PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate

Dieser Befehl legt die Erweiterung auf dem virtuellen Computer mit dem Namen VM22 fest, um Sample.ps1.zip aus dem Speicherkonto "Stg" und dem Container mit dem Namen "WindowsPowerShellDSC" herunterzuladen. Der Befehl ruft die Konfiguration mit dem Namen ConfigName auf und gibt Konfigurationsdaten und Argumente an. Mit diesem Befehl wird auch die automatische Aktualisierung des Erweiterungshandlers auf die neueste Version aktiviert. Die Sample.ps1.zip wurde zuvor mithilfe von Publish-AzureRmVMSCConfiguration hochgeladen.

Parameter

-ArchiveBlobName

Gibt den Namen der Konfigurationsdatei an, die zuvor vom Cmdlet Publish-AzureRmVMDscConfiguration hochgeladen wurde.

Typ:String
Aliase:ConfigurationArchiveBlob
Position:5
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ArchiveContainerName

Artenname des Azure-Speichercontainers, in dem sich das Konfigurationsarchiv befindet.

Typ:String
Aliase:ContainerName
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ArchiveResourceGroupName

Gibt den Namen der Ressourcengruppe an, die das Speicherkonto enthält, das das Konfigurationsarchiv enthält. Dieser Parameter ist optional, wenn sich das Speicherkonto und der virtuelle Computer in derselben Ressourcengruppe befinden.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ArchiveStorageAccountName

Gibt den Namen des Azure-Speicherkontos an, der zum Herunterladen des ArchiveBlobName verwendet wird.

Typ:String
Aliase:StorageAccountName
Position:4
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ArchiveStorageEndpointSuffix

Gibt das Suffix des Speicherendpunkts an.

Typ:String
Aliase:StorageEndpointSuffix
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AutoUpdate

Gibt die vom Versionsparameter angegebene Erweiterungshandlerversion an. Standardmäßig ist der Erweiterungshandler nicht automatisch aktualisiert. Verwenden Sie den AutoUpdate-Parameter , um die automatische Aktualisierung des Erweiterungshandlers auf die neueste Version zu aktivieren, sobald sie verfügbar ist.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ConfigurationArgument

Gibt eine Hashtabelle an, die die Argumente für die Konfigurationsfunktion enthält.

Typ:Hashtable
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ConfigurationData

Gibt den Pfad einer PSD1-Datei an, die die Daten für die Konfiguration angibt.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ConfigurationName

Gibt den Namen der Konfiguration an, die von der DSC-Erweiterung aufgerufen wird.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DataCollection

Gibt den Datentyp der Datensammlung an. Die zulässigen Werte für diesen Parameter sind: "Aktivieren" und "Deaktivieren".

Typ:String
Zulässige Werte:Enable, Disable
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:IAzureContextContainer
Aliase:AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Erzwingt die Ausführung des Befehls ohne Aufforderung zur Bestätigung durch den Benutzer.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Location

Gibt den Pfad der Ressourcenerweiterung an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Gibt den Namen der Azure Resource Manager-Ressource an, die die Erweiterung darstellt. Der Standardwert ist Microsoft.Powershell.DSC.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ResourceGroupName

Gibt den Namen der Ressourcengruppe des virtuellen Computers an.

Typ:String
Position:2
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Version

Gibt die Version der DSC-Erweiterung an, auf die Set-AzureRmVMDscExtension die Einstellungen anwendet.

Typ:String
Aliase:HandlerVersion
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-VMName

Gibt den Namen des virtuellen Computers an, auf dem der DSC-Erweiterungshandler installiert ist.

Typ:String
Position:3
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WmfVersion

Gibt die WMF-Version an.

Typ:String
Zulässige Werte:4.0, 5.0, 5.1, latest
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

Eingaben

String

Hashtable

Ausgaben

PSAzureOperationResponse