Add-AzureRmVMSshPublicKey

リファレンス

モジュール:: AzureRM.Compute

仮想マシンの SSH の公開キーを追加します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

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

説明

Add-AzureRmVMSshPublicKey コマンドレットは、Secure Shell (SSH) 経由で仮想マシンに接続するために使用できる公開キーを追加します。

例

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

PS C:\> $VirtualMachine = Get-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"
PS C:\> $VirtualMachine = Add-AzureRmVMSshPublicKey -VM $VirtualMachine -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys"

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

パラメーター

-DefaultProfile

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

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

-KeyData

公開キーの Base 64 エンコードを指定します。仮想マシンに接続するには、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-AzureRmVM コマンドレットを使用します。 New-AzureRmVMConfig コマンドレットを使用して、仮想マシンオブジェクトを作成できます。

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

入力

PSVirtualMachine

String

出力