Add-AzVMSshPublicKey
VM を作成する場合にのみ、仮想マシンの SSH の公開キーを追加します。
構文
Default (既定)
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 との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-KeyData
公開キーの Base 64 エンコードを指定します。 LINUX 仮想マシンに接続するには、SSH を使用するか、このパラメーターで指定するキーを使用します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Path
このコマンドレットが SSH 公開キーを格納する仮想マシン上のファイルの完全なパスを指定します。 ファイルが既に存在する場合、このコマンドレットはファイルにキーを追加します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-VM
このコマンドレットが変更する仮想マシン オブジェクトを指定します。 仮想マシン オブジェクトを取得するには、 Get-AzVM コマンドレットを使用します。 New-AzVMConfig コマンドレットを使用して、仮想マシン オブジェクトを作成できます。
パラメーターのプロパティ
| 型: | PSVirtualMachine |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | VMProfile |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。