Set-AzVMExtension
Aktualizuje 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ń maszyn wirtualnych 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 $Settings i $ProtectedSettings.
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ą $Settings i $ProtectedSettings.
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 ;
Dwa pierwsze polecenia tworzą ciągi zawierające ustawienia, a następnie przechowują je w zmiennych $SettingsString i $ProtectedSettingsString. Końcowe polecenie modyfikuje rozszerzenie maszyny wirtualnej o nazwie VirtualMachine22 w grupie ResourceGroup11 zgodnie z zawartością $SettingsString i $ProtectedSettingsString. Polecenie określa inne wymagane informacje, które obejmują wydawcę i typ rozszerzenia.
Parametry
-AsJob
Uruchamianie polecenia cmdlet w tle
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Confirm
Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.
Typ: | SwitchParameter |
Aliasy: | cf |
Position: | Named |
Domyślna wartość: | False |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.
Typ: | IAzureContextContainer |
Aliasy: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | 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ń.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-EnableAutomaticUpgrade
Wskazuje, czy rozszerzenie powinno zostać automatycznie uaktualnione przez platformę, jeśli jest dostępna nowsza wersja rozszerzenia.
Typ: | Nullable<T>[Boolean] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-ExtensionType
Określa typ rozszerzenia.
Typ: | String |
Aliasy: | Type |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | 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.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Location
Określa lokalizację maszyny wirtualnej.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Name
Określa nazwę rozszerzenia.
Typ: | String |
Aliasy: | ExtensionName |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | 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.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-ProtectedSettings
Określa konfigurację prywatną rozszerzenia jako tabelę skrótów. To polecenie cmdlet szyfruje konfigurację prywatną.
Typ: | Hashtable |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-ProtectedSettingString
Określa konfigurację prywatną rozszerzenia jako ciąg. To polecenie cmdlet szyfruje konfigurację prywatną.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Publisher
Określa nazwę wydawcy rozszerzenia. Wydawca podaje nazwę, gdy wydawca rejestruje rozszerzenie.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-ResourceGroupName
Określa nazwę grupy zasobów maszyny wirtualnej.
Typ: | String |
Position: | 0 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Settings
Określa publiczną konfigurację rozszerzenia jako tabelę skrótów. To polecenie cmdlet nie szyfruje konfiguracji publicznej.
Typ: | Hashtable |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SettingString
Określa publiczną konfigurację rozszerzenia jako ciąg. To polecenie cmdlet nie szyfruje konfiguracji publicznej.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-TypeHandlerVersion
Określa wersję rozszerzenia do użycia dla tej maszyny wirtualnej.
Typ: | String |
Aliasy: | HandlerVersion, Version |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-VMName
Określa nazwę maszyny wirtualnej. To polecenie cmdlet modyfikuje rozszerzenia dla maszyny wirtualnej, którą określa ten parametr.
Typ: | String |
Aliasy: | ResourceName |
Position: | 1 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-WhatIf
Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane.
Typ: | SwitchParameter |
Aliasy: | wi |
Position: | Named |
Domyślna wartość: | False |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |