Set-AzVMExtension
Aktualizuje vlastnosti rozšíření nebo přidá rozšíření do virtuálního počítače.
Syntax
Settings (Výchozí)
Set-AzVMExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-Publisher <String>
-ExtensionType <String>
-Name <String>
[-Settings <Hashtable>]
[-ProtectedSettings <Hashtable>]
[-EnableAutomaticUpgrade <Boolean>]
[-AsJob]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SettingString
Set-AzVMExtension
[-ResourceGroupName] <String>
[-VMName] <String>
-Publisher <String>
-ExtensionType <String>
-Name <String>
[-SettingString <String>]
[-ProtectedSettingString <String>]
[-EnableAutomaticUpgrade <Boolean>]
[-AsJob]
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Rutina Set-AzVMExtension aktualizuje vlastnosti pro existující rozšíření virtuálních počítačů nebo přidá rozšíření do virtuálního počítače.
Příklady
Příklad 1: Úprava nastavení pomocí tabulek hash
$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings;
První dva příkazy používají standardní Windows syntaxi PowerShellu k vytvoření hodnot hash tabulek a potom tyto hashovací tabulky uloží do $Settings a $ProtectedSettings proměnných.
Pro více informací zadejte Get-Help about_Hash_Tables.
Druhý příkaz obsahuje dvě hodnoty, které byly dříve vytvořeny a uloženy v proměnných.
Poslední příkaz upraví rozšíření virtuálního počítače s názvem VirtualMachine22 v ResourceGroup11 podle obsahu $Settings a $ProtectedSettings.
Příkaz určuje další požadované informace, které zahrnují vydavatele a typ rozšíření.
Příklad 2: Úprava nastavení pomocí řetězců
$SettingsString = '{"fileUris":[],"commandToExecute":""}';
$ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ;
První dva příkazy vytvoří řetězce, které obsahují nastavení, a pak je uloží do $SettingsString a $ProtectedSettingsString proměnných.
Poslední příkaz upraví rozšíření virtuálního počítače s názvem VirtualMachine22 v ResourceGroup11 podle obsahu $SettingsString a $ProtectedSettingsString.
Příkaz určuje další požadované informace, které zahrnují vydavatele a typ rozšíření.
Parametry
-AsJob
Spuštění rutiny na pozadí
Vlastnosti parametru
Typ: SwitchParameter
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
Typ: SwitchParameter
Default value: False Podporuje zástupné znaky: False DontShow: False Aliasy: viz
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.
Vlastnosti parametru
Typ: IAzureContextContainer
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: AzContext, AzureRmContext, AzureCredential
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-DisableAutoUpgradeMinorVersion
Označuje, že tato rutina brání agentu hosta Azure automaticky aktualizovat rozšíření na novější podverzi.
Ve výchozím nastavení tato rutina umožňuje agentu hosta aktualizovat rozšíření.
Vlastnosti parametru
Typ: SwitchParameter
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-EnableAutomaticUpgrade
Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření.
Vlastnosti parametru
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-ExtensionType
Určuje typ rozšíření.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: Typ
Sady parametrů
(All)
Position: Named Povinné: True Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-ForceRerun
Označuje, že tato rutina vynutí opětovné spuštění stejné konfigurace rozšíření na virtuálním počítači bez odinstalace a přeinstalace rozšíření.
Hodnota může být libovolný řetězec, který se liší od aktuální hodnoty.
Pokud se forceUpdateTag nezmění, aktualizace veřejných nebo chráněných nastavení se stále použijí obslužnou rutinou.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-Location
Určuje umístění virtuálního počítače.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-Name
Určuje název rozšíření.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: Název rozšíření
Sady parametrů
(All)
Position: Named Povinné: True Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-NoWait
Spustí operaci a vrátí se okamžitě před dokončením operace. Pokud chcete zjistit, jestli se operace úspěšně dokončila, použijte jiný mechanismus.
Vlastnosti parametru
Typ: SwitchParameter
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
-ProtectedSettings
Určuje privátní konfiguraci rozšíření jako tabulku hash.
Tato rutina šifruje privátní konfiguraci.
Vlastnosti parametru
Typ: Hashtable
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
Settings
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-ProtectedSettingString
Určuje privátní konfiguraci rozšíření jako řetězec.
Tato rutina šifruje privátní konfiguraci.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
SettingString
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-Publisher
Určuje název vydavatele rozšíření.
Vydavatel zadá název, když vydavatel zaregistruje rozšíření.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: Named Povinné: True Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-ResourceGroupName
Určuje název skupiny prostředků virtuálního počítače.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
(All)
Position: 0 Povinné: True Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-Settings
Určuje veřejnou konfiguraci rozšíření jako tabulku hash.
Tato rutina nešifruje veřejnou konfiguraci.
Vlastnosti parametru
Typ: Hashtable
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
Settings
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-SettingString
Určuje veřejnou konfiguraci rozšíření jako řetězec.
Tato rutina nešifruje veřejnou konfiguraci.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False
Sady parametrů
SettingString
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-TypeHandlerVersion
Určuje verzi rozšíření, která se má použít pro tento virtuální počítač.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: HandlerVersion, Verze
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-VMName
Určuje název virtuálního počítače.
Tato rutina upraví rozšíření pro virtuální počítač, který tento parametr určuje.
Vlastnosti parametru
Typ: String
Default value: None Podporuje zástupné znaky: False DontShow: False Aliasy: ResourceName
Sady parametrů
(All)
Position: 1 Povinné: True Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: True Hodnota ze zbývajících argumentů: False
-WhatIf
Ukazuje, co se stane, když se příkaz spustí.
Příkazový modul nebyl spuštěn.
Vlastnosti parametru
Typ: SwitchParameter
Default value: False Podporuje zástupné znaky: False DontShow: False Aliasy: Wi
Sady parametrů
(All)
Position: Named Povinné: False Hodnota z kanálu: False Hodnota z kanálu podle názvu vlastnosti: False Hodnota ze zbývajících argumentů: False
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters .
Výstupy
