Set-AzVMBginfoExtension

モジュール:

Az.Compute

仮想マシンに BGInfo 拡張機能を追加します。

構文

Set-AzVMBginfoExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzVMBGInfoExtension コマンドレットは、BGInfo 拡張機能を仮想マシンに追加します。

例

例 1: 仮想マシンの BGInfo 拡張機能を追加する

Set-AzVMBgInfoExtension -ResourceGroupName "ContosoRG" -VMName "ContosoVM" -Name "ExtensionName" -TypeHandlerVersion "2.1" -Location "West Europe"

このコマンドは、ContosoVM という名前の仮想マシンに BGInfo 拡張機能を追加します。 このコマンドは、仮想マシンのリソース グループと場所を指定します。 このコマンドは、拡張機能の名前とバージョンを指定します。

パラメーター

-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

-ForceRerun

同じパブリック設定または保護された設定で拡張機能を再度実行することを指定します。 値には、現在の値とは異なる任意の文字列を指定できます。 forceUpdateTag が変更されていない場合でも、ハンドラーによってパブリックまたは保護された設定の更新が適用されます。

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

-Location

仮想マシンの場所を指定します。

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

-Name

このコマンドレットが仮想マシンに追加する BGInfo 拡張機能の名前を指定します。

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

-NoWait

操作を開始し、操作が完了する直前に戻ります。 操作が正常に完了したかどうかを判断するには、他のメカニズムを使用します。

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

-ResourceGroupName

このコマンドレットが拡張機能を追加する仮想マシンのリソース グループの名前を指定します。

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

-TypeHandlerVersion

このコマンドレットが仮想マシンに追加する拡張機能のバージョンを指定します。

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

-VMName

このコマンドレットが BGInfo 拡張機能を追加する仮想マシンの名前を指定します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

String

SwitchParameter

出力

PSAzureOperationResponse