Set-AzVMExtension
拡張機能のプロパティを更新するか、仮想マシンに拡張機能を追加します。
構文
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>]
説明
Set-AzVMExtension コマンドレットは、既存の仮想マシン拡張機能のプロパティを更新するか、仮想マシンに拡張機能を追加します。
例
例 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;
最初の 2 つのコマンドでは、標準の Windows PowerShell 構文を使用してハッシュ テーブルを作成し、それらのハッシュ テーブルを$Settings変数と$ProtectedSettings変数に格納します。
詳細を表示するには「Get-Help about_Hash_Tables
」を入力します。
2 番目のコマンドには、以前に作成され、変数に格納された 2 つの値が含まれています。
最後のコマンドは、$Settingsと$ProtectedSettingsの内容に従って、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 ;
最初の 2 つのコマンドは、設定を含む文字列を作成し、それらを$SettingsString変数と$ProtectedSettingsString変数に格納します。 最後のコマンドは、$SettingsStringと$ProtectedSettingsStringの内容に従って、ResourceGroup11 の VirtualMachine22 という名前の仮想マシンの拡張機能を変更します。 このコマンドは、パブリッシャーと拡張機能の種類を含む他の必要な情報を指定します。
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DisableAutoUpgradeMinorVersion
このコマンドレットにより、Azure ゲスト エージェントが拡張機能を新しいマイナー バージョンに自動的に更新できないようにすることを示します。 既定では、このコマンドレットを使用すると、ゲスト エージェントは拡張機能を更新できます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-EnableAutomaticUpgrade
使用可能な拡張機能の新しいバージョンがある場合に、拡張機能をプラットフォームによって自動的にアップグレードするかどうかを示します。
型: | Nullable<T>[Boolean] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ExtensionType
拡張の種類を指定します。
型: | String |
Aliases: | Type |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ForceRerun
このコマンドレットが、拡張機能をアンインストールして再インストールすることなく、仮想マシン上で同じ拡張機能構成を強制的に再実行することを示します。 値には、現在の値とは異なる任意の文字列を指定できます。 forceUpdateTag が変更されていない場合でも、ハンドラーによってパブリックまたは保護された設定の更新が適用されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Location
仮想マシンの場所を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
拡張機能の名前を指定します。
型: | String |
Aliases: | ExtensionName |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-NoWait
操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ProtectedSettings
拡張機能のプライベート構成をハッシュ テーブルとして指定します。 このコマンドレットは、プライベート構成を暗号化します。
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ProtectedSettingString
拡張機能のプライベート構成を文字列として指定します。 このコマンドレットは、プライベート構成を暗号化します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Publisher
拡張機能の発行元の名前を指定します。 パブリッシャーは、パブリッシャーが拡張機能を登録するときに名前を提供します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
仮想マシンのリソース グループの名前を指定します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Settings
拡張機能のパブリック構成をハッシュ テーブルとして指定します。 このコマンドレットでは、パブリック構成は暗号化されません。
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-SettingString
拡張機能のパブリック構成を文字列として指定します。 このコマンドレットでは、パブリック構成は暗号化されません。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TypeHandlerVersion
この仮想マシンに使用する拡張機能のバージョンを指定します。
型: | String |
Aliases: | HandlerVersion, Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-VMName
仮想マシンの名前を指定します。 このコマンドレットは、このパラメーターが指定する仮想マシンの拡張機能を変更します。
型: | String |
Aliases: | ResourceName |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
出力
関連リンク
Azure PowerShell