Set-AzureVMBGInfoExtension
仮想マシンの BGInfo 拡張機能を設定します。
注意
このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。
構文
Set-AzureVMBGInfoExtension
[-Disable]
[[-ReferenceName] <String>]
[[-Version] <String>]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
Set-AzureVMBGInfoExtension
[-Uninstall]
[[-ReferenceName] <String>]
[[-Version] <String>]
-VM <IPersistentVM>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
説明
Set-AzureVMBGInfoExtension コマンドレットは、仮想マシンの BGInfo 拡張機能を設定します。
例
例 1: 仮想マシンの BGInfo 拡張機能を設定する
PS C:\> Set-AzureVMBGInfoExtension -VM $VM
このコマンドは、指定した仮想マシンの BGInfo 拡張機能を変数$VMに格納されるように設定します。
パラメーター
-Disable
このコマンドレットが拡張機能の状態を無効にすることを示します。
Type: | SwitchParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InformationAction
このコマンドレットが情報イベントに応答する方法を指定します。
このパラメーターの有効値は、次のとおりです。
- 続行
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Type: | ActionPreference |
Aliases: | infa |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InformationVariable
情報変数を指定します。
Type: | String |
Aliases: | iv |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Profile
このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。
Type: | AzureSMProfile |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReferenceName
BGInfo 拡張機能の参照名を指定します。
このパラメーターは、拡張機能を参照するために使用できるユーザー定義の文字列です。 これは、拡張機能が仮想マシンに初めて追加されるときに指定されます。 拡張機能の更新中に、以前に使用した参照名を指定できます。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Uninstall
このコマンドレットが BGInfo 拡張機能をアンインストールすることを示します。
Type: | SwitchParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Version
BGInfo 拡張機能のバージョンを指定します。
Type: | String |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VM
永続的な仮想マシン オブジェクトを指定します。
Type: | IPersistentVM |
Aliases: | InputObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |