Set-AzVMExtension

  • Reference
Modul:
Az.Compute

Aktualizuje vlastnosti rozšíření nebo přidá rozšíření do virtuálního počítače.

Syntaxe

Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-Settings <Hashtable>]
   [-ProtectedSettings <Hashtable>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-SettingString <String>]
   [-ProtectedSettingString <String>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-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í syntaxi Windows PowerShellu k vytvoření tabulek hash a potom tyto tabulky hash uloží do $Settings a $ProtectedSettings proměnných. Další informace potřebujete zadáním 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í

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DisableAutoUpgradeMinorVersion

Označuje, že tato rutina brání agentu hosta Azure v automatické aktualizaci rozšíření na novější podverzi. Ve výchozím nastavení tato rutina umožňuje agentu hosta aktualizovat rozšíření.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-EnableAutomaticUpgrade

Určuje, jestli má být rozšíření automaticky upgradováno platformou, pokud je k dispozici novější verze rozšíření.

Typ:Nullable<T>[Boolean]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ExtensionType

Určuje typ rozšíření.

Typ:String
Aliasy:Type
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky: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.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Location

Určuje umístění virtuálního počítače.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Name

Určuje název rozšíření.

Typ:String
Aliasy:ExtensionName
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky: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.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ProtectedSettings

Určuje privátní konfiguraci rozšíření jako tabulku hash. Tato rutina šifruje privátní konfiguraci.

Typ:Hashtable
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ProtectedSettingString

Určuje privátní konfiguraci rozšíření jako řetězec. Tato rutina šifruje privátní konfiguraci.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Publisher

Určuje název vydavatele rozšíření. Vydavatel zadá název, když vydavatel zaregistruje rozšíření.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ResourceGroupName

Určuje název skupiny prostředků virtuálního počítače.

Typ:String
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Settings

Určuje veřejnou konfiguraci rozšíření jako tabulku hash. Tato rutina nešifruje veřejnou konfiguraci.

Typ:Hashtable
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SettingString

Určuje veřejnou konfiguraci rozšíření jako řetězec. Tato rutina nešifruje veřejnou konfiguraci.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-TypeHandlerVersion

Určuje verzi rozšíření, která se má použít pro tento virtuální počítač.

Typ:String
Aliasy:HandlerVersion, Version
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky: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.

Typ:String
Aliasy:ResourceName
Position:1
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

String

Hashtable

SwitchParameter

Výstupy

PSAzureOperationResponse