New-AzureSSHKey

  • リファレンス
モジュール:
Azure

新しい Linux ベースの Azure 仮想マシンに既存の証明書を挿入する SSH キー オブジェクトを作成します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

New-AzureSSHKey
   [-KeyPair]
   [-Fingerprint] <String>
   [-Path] <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
New-AzureSSHKey
   [-PublicKey]
   [-Fingerprint] <String>
   [-Path] <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

説明

New-AzureSSHKey コマンドレットは、Azure に既に追加されている証明書の SSH キー オブジェクトを作成します。 この SSH キー オブジェクトは、New-AzureVM を使用して新しい仮想マシンの構成オブジェクトを作成するとき、または New-AzureQuickVM を使用して新しい仮想マシンを作成するときに、New-AzureProvisioningConfig によって使用できます。 仮想マシン作成スクリプトの一部として含めると、指定した SSH 公開キーまたはキー ペアが新しい仮想マシンに追加されます。

例

例 1: 証明書設定オブジェクトを作成する

PS C:\> $myLxCert = New-AzureSSHKey -Fingerprint "D7BECD4D63EBAF86023BB4F1A5FBF5C2C924902A" -Path "/home/username/.ssh/authorized_keys"

このコマンドは、既存の証明書の証明書設定オブジェクトを作成し、後で使用するためにオブジェクトを変数に格納します。

例 2: サービスに証明書を追加する

PS C:\> Add-AzureCertificate -ServiceName "MySvc" -CertToDeploy "C:\temp\MyLxCert.cer"
$myLxCert = New-AzureSSHKey ?Fingerprint "D7BECD4D63EBAF86023BB4F1A5FBF5C2C924902A" -Path "/home/username/.ssh/authorized_keys"
New-AzureVMConfig -Name "MyVM2" -InstanceSize Small -ImageName $LxImage `
          | Add-AzureProvisioningConfig -Linux -LinuxUser $lxUser -SSHPublicKeys $myLxCert -Password 'pass@word1' `
          | New-AzureVM -ServiceName "MySvc"

このコマンドは、Azure サービスに証明書を追加し、その証明書を使用する新しい Linux 仮想マシンを作成します。

パラメーター

-Fingerprint

証明書のフィンガープリントを指定します。

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

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。

このパラメーターの有効値は、次のとおりです。

  • 続行
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • [中断]
型:ActionPreference
Aliases:infa
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InformationVariable

情報変数を指定します。

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

-KeyPair

このコマンドレットは、新しい仮想マシン構成に SSH キー ペアを挿入するためのオブジェクトを作成することを指定します。

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

-Path

SSH 公開キーまたはキー ペアを格納するパスを指定します。

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

-PublicKey

このコマンドレットは、新しい仮想マシン構成に SSH 公開キーを挿入するためのオブジェクトを作成することを指定します。

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