Set-AzVMExtension

Aktualizacje właściwości rozszerzenia lub dodaje rozszerzenie do maszyny wirtualnej.

Składnia

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>]

Opis

Polecenie cmdlet Set-AzVMExtension aktualizuje właściwości istniejących rozszerzeń maszyny wirtualnej lub dodaje rozszerzenie do maszyny wirtualnej.

Przykłady

Przykład 1. Modyfikowanie ustawień przy użyciu tabel skrótów

$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;

Pierwsze dwa polecenia używają standardowej składni programu Windows PowerShell do tworzenia tabel skrótów, a następnie przechowuje te tabele skrótów w zmiennych $Ustawienia i $Protected Ustawienia. Aby uzyskać więcej informacji, wpisz Get-Help about_Hash_Tables. Drugie polecenie zawiera dwie wartości utworzone wcześniej i przechowywane w zmiennych. Końcowe polecenie modyfikuje rozszerzenie maszyny wirtualnej o nazwie VirtualMachine22 w grupie ResourceGroup11 zgodnie z zawartością $Ustawienia i $Protected Ustawienia. Polecenie określa inne wymagane informacje, które obejmują wydawcę i typ rozszerzenia.

Przykład 2. Modyfikowanie ustawień przy użyciu ciągów

$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 ;

Pierwsze dwa polecenia tworzą ciągi zawierające ustawienia, a następnie przechowują je w zmiennych $Ustawienia String i $Protected Ustawienia String. Końcowe polecenie modyfikuje rozszerzenie maszyny wirtualnej o nazwie VirtualMachine22 w grupie ResourceGroup11 zgodnie z zawartością $Ustawienia String i $Protected Ustawienia String. Polecenie określa inne wymagane informacje, które obejmują wydawcę i typ rozszerzenia.

Parametry

-AsJob

Uruchamianie polecenia cmdlet w tle

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableAutoUpgradeMinorVersion

Wskazuje, że to polecenie cmdlet uniemożliwia agentowi gościa platformy Azure automatyczne aktualizowanie rozszerzeń do nowszej wersji pomocniczej. Domyślnie to polecenie cmdlet umożliwia agentowi gościowi aktualizowanie rozszerzeń.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EnableAutomaticUpgrade

Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli jest dostępna nowsza wersja rozszerzenia.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExtensionType

Określa typ rozszerzenia.

Type:String
Aliases:Type
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ForceRerun

Wskazuje, że to polecenie cmdlet wymusza ponowne uruchomienie tej samej konfiguracji rozszerzenia na maszynie wirtualnej bez odinstalowywania i ponownego instalowania rozszerzenia. Wartość może być dowolnym ciągiem innym niż bieżąca wartość. Jeśli element forceUpdateTag nie zostanie zmieniony, aktualizacje ustawień publicznych lub chronionych są nadal stosowane przez program obsługi.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Location

Określa lokalizację maszyny wirtualnej.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Określa nazwę rozszerzenia.

Type:String
Aliases:ExtensionName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoWait

Uruchamia operację i zwraca natychmiast, zanim operacja zostanie ukończona. Aby określić, czy operacja została ukończona pomyślnie, użyj innego mechanizmu.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProtectedSettings

Określa konfigurację prywatną rozszerzenia jako tabelę skrótów. To polecenie cmdlet szyfruje konfigurację prywatną.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProtectedSettingString

Określa konfigurację prywatną rozszerzenia jako ciąg. To polecenie cmdlet szyfruje konfigurację prywatną.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Publisher

Określa nazwę wydawcy rozszerzenia. Wydawca podaje nazwę, gdy wydawca rejestruje rozszerzenie.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Określa nazwę grupy zasobów maszyny wirtualnej.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Settings

Określa publiczną konfigurację rozszerzenia jako tabelę skrótów. To polecenie cmdlet nie szyfruje konfiguracji publicznej.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SettingString

Określa publiczną konfigurację rozszerzenia jako ciąg. To polecenie cmdlet nie szyfruje konfiguracji publicznej.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TypeHandlerVersion

Określa wersję rozszerzenia do użycia dla tej maszyny wirtualnej.

Type:String
Aliases:HandlerVersion, Version
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMName

Określa nazwę maszyny wirtualnej. To polecenie cmdlet modyfikuje rozszerzenia dla maszyny wirtualnej, którą określa ten parametr.

Type:String
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Dane wejściowe

String

Hashtable

SwitchParameter

Dane wyjściowe

PSAzureOperationResponse