Add-AzVMSshPublicKey

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

VM を作成する場合にのみ、仮想マシンの SSH の公開キーを追加します。

構文

Add-AzVMSshPublicKey
   [-VM] <PSVirtualMachine>
   [[-KeyData] <String>]
   [[-Path] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Add-AzVMSshPublicKey コマンドレットは、Secure Shell (SSH) 経由で Linux 仮想マシンに接続するために使用できる公開キーを追加します。 これは VM の作成後に使用できません。Update-AzVM を使用せずに VM の作成後にこれを使用しようとすると、エラーは発生しません。Update-AzVM でコマンドを使用すると、コマンドはエラーになります。

例

例 1: 仮想マシンに公開キーを追加する

$VirtualMachine = Get-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"
$VirtualMachine = Add-AzVMSshPublicKey -VM $VirtualMachine -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys"

最初のコマンドは、Get-AzVM コマンドレットを使用して VirtualMachine07 という名前の仮想マシンを取得します。 コマンドは仮想マシンを変数 $VirtualMachine に保存します。 2 番目のコマンドは、Path パラメーターが指定する VirtualMachine07 上の場所に公開キーを追加します。

パラメーター

-DefaultProfile

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

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

-KeyData

公開キーの Base 64 エンコードを指定します。 LINUX 仮想マシンに接続するには、SSH を使用するか、このパラメーターで指定するキーを使用します。

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

-Path

このコマンドレットが SSH 公開キーを格納する仮想マシン上のファイルの完全なパスを指定します。 ファイルが既に存在する場合、このコマンドレットはファイルにキーを追加します。

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

-VM

このコマンドレットが変更する仮想マシン オブジェクトを指定します。 仮想マシン オブジェクトを取得するには、Get-AzVM コマンドレットを使用します。 New-AzVMConfig コマンドレットを使用して、仮想マシン オブジェクトを作成できます。

Type:PSVirtualMachine
Aliases:VMProfile
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

PSVirtualMachine

String

出力

PSVirtualMachine