Set-AzVMExtension

  • 參考
模組:
Az.Compute

更新擴充功能屬性，或將擴充功能新增至虛擬機。

Syntax

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

Set-AzVMExtension Cmdlet 會更新現有虛擬機擴充功能的屬性，或將擴充功能新增至虛擬機。

範例

範例 1：使用哈希表修改設定

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

前兩個命令會使用標準 Windows PowerShell 語法來建立哈希表，然後將這些哈希表儲存在 $設定 和 $Protected設定 變數中。 如需詳細資訊，請輸入 Get-Help about_Hash_Tables。 第二個命令包含先前建立並儲存在變數中的兩個值。 最後一個命令會根據 $設定 和 $Protected設定 的內容，修改 ResourceGroup11 中名為 VirtualMachine22 的虛擬機擴充功能。 命令會指定包含發行者和延伸模組類型的其他必要資訊。

範例 2：使用字串修改設定

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

前兩個命令會建立包含設定的字串，然後將它們儲存在 $設定 String 和 $Protected設定 String 變數中。 最後一個命令會根據 $設定 String 和 $Protected設定 String 的內容，修改 ResourceGroup11 中名為 VirtualMachine22 的虛擬機擴充功能。 命令會指定包含發行者和延伸模組類型的其他必要資訊。

參數

-AsJob

在背景執行 Cmdlet

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

-Confirm

執行 Cmdlet 之前先提示您確認。

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

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。

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

-DisableAutoUpgradeMinorVersion

指出此 Cmdlet 會防止 Azure 客體代理程式將擴充功能自動更新為較新的次要版本。 根據預設，此 Cmdlet 可讓客體代理程式更新擴充功能。

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

-EnableAutomaticUpgrade

指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。

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

-ExtensionType

指定延伸模組類型。

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

-ForceRerun

表示此 Cmdlet 會在虛擬機上強制重新執行相同的擴充功能組態，而不需卸載並重新安裝擴充功能。 值可以是與目前值不同的任何字串。 如果未變更 forceUpdateTag，處理程式仍會套用對公用或受保護設定的更新。

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

-Location

指定虛擬機的位置。

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

-Name

指定延伸模組的名稱。

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

-NoWait

啟動作業，並在作業完成之前立即傳回。 若要判斷作業是否已順利完成，請使用一些其他機制。

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

-ProtectedSettings

指定延伸模組的私人組態，做為哈希表。 此 Cmdlet 會加密私人組態。

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

-ProtectedSettingString

將擴充功能的私人組態指定為字串。 此 Cmdlet 會加密私人組態。

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

-Publisher

指定擴充功能發行者的名稱。 發行者會在發行者註冊擴充功能時提供名稱。

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

-ResourceGroupName

指定虛擬機的資源群組名稱。

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

-Settings

指定延伸模組的公用組態，做為哈希表。 此 Cmdlet 不會加密公用組態。

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

-SettingString

將延伸模組的公用組態指定為字串。 此 Cmdlet 不會加密公用組態。

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

-TypeHandlerVersion

指定要用於此虛擬機的擴充功能版本。

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

-VMName

指定虛擬機的名稱。 這個 Cmdlet 會修改此參數所指定之虛擬機的擴充功能。

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

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

String

Hashtable

SwitchParameter

輸出

PSAzureOperationResponse