Set-AzureVMBGInfoExtension

  • リファレンス
モジュール:
Azure

仮想マシンの BGInfo 拡張機能を設定します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される 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

このコマンドレットが拡張機能の状態を無効にすることを示します。

型:SwitchParameter
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。

このパラメーターの有効値は、次のとおりです。

  • 続行
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • [中断]
型:ActionPreference
Aliases:infa
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InformationVariable

情報変数を指定します。

型:String
Aliases:iv
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

型:AzureSMProfile
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ReferenceName

BGInfo 拡張機能の参照名を指定します。

このパラメーターは、拡張機能を参照するために使用できるユーザー定義の文字列です。 これは、拡張機能が仮想マシンに初めて追加されるときに指定されます。 拡張機能の更新中に、以前に使用した参照名を指定できます。

型:String
配置:2
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Uninstall

このコマンドレットが BGInfo 拡張機能をアンインストールすることを示します。

型:SwitchParameter
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Version

BGInfo 拡張機能のバージョンを指定します。

型:String
配置:3
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-VM

永続的な仮想マシン オブジェクトを指定します。

型:IPersistentVM
Aliases:InputObject
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False