Set-AzVMAccessExtension

  • リファレンス
モジュール:
Az.Compute

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

構文

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

説明

Set-AzVMAccessExtension コマンドレットは、仮想マシン アクセス (VMAccess) 仮想マシン VMAccess 拡張機能を仮想マシンに追加します。 VMAccess 拡張機能を使用して一時パスワードを設定できます。これは、マシンにログインした後すぐに変更する必要があります。 これは、Windows Do メイン コントローラーではサポートされていません。

例

例 1: VMAccess 拡張機能を追加する

Set-AzVMAccessExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "2.4"

このコマンドは、ResourceGroup11 の VirtualMachine07 という名前の仮想マシンの VMAccess 拡張機能を追加します。 このコマンドは、VMAccess の名前と型ハンドラーのバージョンを指定します。

例 2

仮想マシンに VMAccess 拡張機能を追加します。 (自動生成)

Set-AzVMAccessExtension -Credential <PSCredential> -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -TypeHandlerVersion '2.4' -VMName 'VirtualMachine07'

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

仮想マシンのユーザー名とパスワードを PSCredential オブジェクトとして指定します。 VM で現在のローカル管理者アカウントと異なる名前を入力すると、VMAccess 拡張機能によってローカル管理者アカウントの名前が追加されて、指定したパスワードがそのアカウントに割り当てられます。 VM にローカル管理者アカウントが存在する場合はパスワードがリセットされ、アカウントが無効になっている場合は VMAccess 拡張機能によって有効化されます。 資格情報を取得するには、Get-Credential コマンドレットを使用します。 詳細を表示するには「Get-Help Get-Credential」を入力します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableAutoUpgradeMinorVersion

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ForceRerun

このコマンドレットが、拡張機能をアンインストールして再インストールすることなく、仮想マシン上で同じ拡張機能構成を強制的に再実行することを示します。 値には、現在の値とは異なる任意の文字列を指定できます。 forceUpdateTag が変更されていない場合でも、ハンドラーによってパブリックまたは保護された設定の更新が適用されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Location

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

Type:String
Aliases:ExtensionName
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoWait

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

仮想マシンのリソース グループの名前を指定します。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TypeHandlerVersion

この仮想マシンに使用する拡張機能のバージョンを指定します。 バージョンを取得するには、PublisherName パラメーターに Microsoft.Compute、Type パラメーターに VMAccessAgent の値を指定して Get-AzVMExtensionImage コマンドレットを実行します。 typeHandlerVersion は 2.0 以上である必要があります。バージョン 1 は非推奨です。

Type:String
Aliases:HandlerVersion, Version
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMName

仮想マシンの名前を指定します。 このコマンドレットは、このパラメーターが指定する仮想マシンの VMAccess を追加します。

Type:String
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSCredential

String

SwitchParameter

出力

PSAzureOperationResponse