Set-AzureVMExtension
仮想マシンのリソース拡張機能を設定します。
Note
このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。
Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。
構文
Set-AzureVMExtension
[-ExtensionName] <String>
[-Publisher] <String>
[-Version] <String>
[[-ReferenceName] <String>]
[[-PublicConfiguration] <String>]
[[-PrivateConfiguration] <String>]
[-Disable]
[-Uninstall]
[[-PublicConfigKey] <String>]
[[-PrivateConfigKey] <String>]
[-ForceUpdate]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Set-AzureVMExtension
[-ExtensionName] <String>
[-Publisher] <String>
[-Version] <String>
[[-ReferenceName] <String>]
[[-PublicConfigPath] <String>]
[[-PrivateConfigPath] <String>]
[-Disable]
[-Uninstall]
[[-PublicConfigKey] <String>]
[[-PrivateConfigKey] <String>]
[-ForceUpdate]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Set-AzureVMExtension
[-ReferenceName] <String>
[[-PublicConfiguration] <String>]
[[-PrivateConfiguration] <String>]
[-Disable]
[-Uninstall]
[[-PublicConfigKey] <String>]
[[-PrivateConfigKey] <String>]
[-ForceUpdate]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] Set-AzureVMExtension
[-ReferenceName] <String>
[[-PublicConfigPath] <String>]
[[-PrivateConfigPath] <String>]
[-Disable]
[-Uninstall]
[[-PublicConfigKey] <String>]
[[-PrivateConfigKey] <String>]
[-ForceUpdate]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>] 説明
Set-AzureVMExtension コマンドレットは、仮想マシンのリソース拡張機能を設定します。
例
例 1: リソース拡張機能が適用された仮想マシンを作成する
PS C:\> $X = New-AzureVMConfig -Name $VM -InstanceSize Small -ImageName $IMG;$X = Add-AzureProvisioningConfig -VM $X -Password $PWD -AdminUsername $USR -Windows;$X = Set-AzureVMExtension -VM $X -ExtensionName $Ext1 -Publisher $Publisher -Version $VER -PublicConfiguration $P1 -PrivateConfiguration $P2;$X = Set-AzureVMExtension -VM $X -ExtensionName $Ext2 -Publisher $Publisher -Version $VER -PublicConfiguration $P3 -PrivateConfiguration $P4;New-AzureVM -Location $LOC -ServiceName $SVC -VM $X;このコマンドを実行すると、リソース拡張機能が適用された仮想マシンが作成されます。
パラメーター
-Disable
このコマンドレットが拡張機能の状態を無効にすることを示します。
| 型: | SwitchParameter |
| 配置: | 7 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ExtensionName
仮想マシンの拡張機能名を指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ForceUpdate
構成が更新されていない場合に、このコマンドレットによって拡張機能に構成が再適用されることを示します。
| 型: | SwitchParameter |
| 配置: | 11 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InformationAction
このコマンドレットが情報イベントに応答する方法を指定します。
このパラメーターの有効値は、次のとおりです。
- 続行
- Ignore
- Inquire
- SilentlyContinue
- Stop
- [中断]
| 型: | ActionPreference |
| Aliases: | infa |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InformationVariable
情報変数を指定します。
| 型: | String |
| Aliases: | iv |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PrivateConfigKey
秘密構成キーを指定します。
| 型: | String |
| 配置: | 10 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PrivateConfigPath
プライベート構成パスを指定します。
| 型: | String |
| 配置: | 6 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PrivateConfiguration
プライベート構成テキストを指定します。
| 型: | String |
| 配置: | 6 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Profile
このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。
| 型: | AzureSMProfile |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PublicConfigKey
公開構成キーを指定します。
| 型: | String |
| 配置: | 9 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PublicConfigPath
パブリック構成パスを指定します。
| 型: | String |
| 配置: | 5 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PublicConfiguration
パブリック構成テキストを指定します。
| 型: | String |
| 配置: | 5 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Publisher
拡張機能の発行元を指定します。
| 型: | String |
| 配置: | 2 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ReferenceName
拡張機能の参照名を指定します。
これは、拡張機能を参照するために使用できるユーザー定義の文字列です。 拡張機能を仮想マシンに初めて追加するときに指定する必要があります。 以降の更新では、拡張機能の更新中に以前に使用した参照名を指定する必要があります。 拡張機能に割り当てられた ReferenceName は、Get-AzureVM コマンドレットを使用して返されます。
| 型: | String |
| 配置: | 4 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Uninstall
このコマンドレットが仮想マシンからリソース拡張機能をアンインストールすることを示します。
| 型: | SwitchParameter |
| 配置: | 8 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Version
拡張機能のバージョンを指定します。
| 型: | String |
| 配置: | 3 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-VM
永続的な仮想マシン オブジェクトを指定します。
| 型: | IPersistentVM |
| Aliases: | InputObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |