Add-AzureRmVmssSshPublicKey

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

VMSS に SSH 公開キーを追加します。

警告

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

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

構文

Add-AzureRmVmssSshPublicKey
   [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
   [[-Path] <String>]
   [[-KeyData] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

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

例

例 1: VMSS に SSH 公開キーを追加する

PS C:\> $VMSS = New-AzureRmVmssConfig
PS C:\> Add-AzureRmVmssSshPublicKey -VirtualMachineScaleSet $VMSS -KeyData "MIIDszCCApugAwIBAgIJALBV9YJCF/tAMA0GCSq12Ib3DQEB21QUAMEUxCzAJBgNV" -Path "/home/admin/.ssh/authorized_keys"

この例では、VMSS に SSH 公開キーを追加します。 最初のコマンドでは、 New-AzureRmVmssConfig コマンドレットを使用して VMSS 構成オブジェクトを作成し、結果を $VMSS という名前の変数に格納します。 2 番目のコマンドは、指定したキー データを持つ SSH キーを追加し、仮想マシン上の指定したパスにキーを格納します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-KeyData

SSH RSA 公開キー データを指定します。

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

-Path

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

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

-VirtualMachineScaleSet

VMSS オブジェクトを指定します。 New-AzureRmVmssConfig コマンドレットを使用してオブジェクトを作成できます。

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

-WhatIf

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

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

入力

PSVirtualMachineScaleSet

String

出力

PSVirtualMachineScaleSet