Freigeben über

Set-AzureRmVMExtension

  • Referenz
Modul:
AzureRM.Compute

Aktualisiert Erweiterungseigenschaften oder fügt eine Erweiterung zu einem virtuellen Computer hinzu.

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 weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

Set-AzureRmVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-Settings <Hashtable>]
   [-ProtectedSettings <Hashtable>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-SettingString <String>]
   [-ProtectedSettingString <String>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-AzureRmVMExtension aktualisiert Eigenschaften für vorhandene Erweiterungen virtueller Computer oder fügt eine Erweiterung zu einem virtuellen Computer hinzu.

Beispiele

Beispiel 1: Ändern von Einstellungen mithilfe von Hashtabellen

PS C:\> $Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
PS C:\> $ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -Type "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings;

Die ersten beiden Befehle verwenden die standardmäßige Windows PowerShell-Syntax, um Hashtabellen zu erstellen, und speichert diese Hashtabellen dann in den Variablen $Einstellungen und $Protected Einstellungen. Geben Sie Folgendes ein, um weitere Informationen zu erhalten: Get-Help about_Hash_Tables. Der zweite Befehl enthält zwei Werte, die zuvor erstellt und in Variablen gespeichert wurden. Der letzte Befehl ändert eine Erweiterung des virtuellen Computers namens VirtualMachine22 in ResourceGroup11 entsprechend dem Inhalt von $Einstellungen und $Protected Einstellungen. Der Befehl gibt weitere erforderliche Informationen an, die den Herausgeber und den Erweiterungstyp enthalten.

Beispiel 2: Ändern von Einstellungen mithilfe von Zeichenfolgen

PS C:\> $SettingsString = '{"fileUris":[],"commandToExecute":""}';
PS C:\> $ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
PS C:\> Set-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -Type "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ;

Die ersten beiden Befehle erstellen Zeichenfolgen, die Einstellungen enthalten, und speichert sie dann in den Variablen $Einstellungen String und $Protected Einstellungen String. Mit dem letzten Befehl wird eine Erweiterung des virtuellen Computers namens VirtualMachine22 in ResourceGroup11 entsprechend dem Inhalt von $Einstellungen String und $Protected Einstellungen String geändert. Der Befehl gibt weitere erforderliche Informationen an, die den Herausgeber und den Erweiterungstyp enthalten.

Parameter

-AsJob

Cmdlet im Hintergrund ausführen

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
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

-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

-DisableAutoUpgradeMinorVersion

Gibt an, dass dieses Cmdlet verhindert, dass der Azure-Gast-Agent die Erweiterungen automatisch auf eine neuere Nebenversion aktualisiert. Standardmäßig ermöglicht dieses Cmdlet dem Gast-Agent, die Erweiterungen zu aktualisieren.

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

-ExtensionType

Gibt den Erweiterungstyp an.

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

-ForceRerun

Gibt an, dass dieses Cmdlet eine erneute Ausführung derselben Erweiterungskonfiguration auf dem virtuellen Computer erzwingt, ohne die Erweiterung zu deinstallieren und neu zu installieren. Der Wert kann eine beliebige Zeichenfolge sein, die sich vom aktuellen Wert unterscheidet. Wenn forceUpdateTag nicht geändert wird, werden Updates für öffentliche oder geschützte Einstellungen weiterhin vom Handler angewendet.

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

-Location

Gibt den Speicherort des virtuellen Computers an.

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

-Name

Gibt den Namen einer Erweiterung an.

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

-ProtectedSettings

Gibt die private Konfiguration für die Erweiterung als Hashtabelle an. Dieses Cmdlet verschlüsselt die private Konfiguration.

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

-ProtectedSettingString

Gibt die private Konfiguration für die Erweiterung als Zeichenfolge an. Dieses Cmdlet verschlüsselt die private Konfiguration.

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

-Publisher

Gibt den Namen des Erweiterungsherausgebers an. Der Herausgeber stellt einen Namen bereit, wenn der Herausgeber eine Erweiterung registriert.

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

-ResourceGroupName

Gibt den Namen der Ressourcengruppe des virtuellen Computers an.

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

-Settings

Gibt die öffentliche Konfiguration für die Erweiterung als Hashtabelle an. Dieses Cmdlet verschlüsselt keine öffentliche Konfiguration.

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

-SettingString

Gibt die öffentliche Konfiguration für die Erweiterung als Zeichenfolge an. Dieses Cmdlet verschlüsselt keine öffentliche Konfiguration.

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

-TypeHandlerVersion

Gibt die Version der Erweiterung an, die für diesen virtuellen Computer verwendet werden soll.

Typ:String
Aliase:HandlerVersion, Version
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-VMName

Gibt den Namen eines virtuellen Computers an. Dieses Cmdlet ändert Erweiterungen für den virtuellen Computer, den dieser Parameter angibt.

Typ:String
Aliase:ResourceName
Position:1
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

Eingaben

String

Hashtable

SwitchParameter

Ausgaben

PSAzureOperationResponse