Export-AzSshConfig
このコマンドレットは、OpenSSH 構成と証明書をサポートするクライアント アプリケーションを介して Azure リソースに接続するために使用できる SSH 構成ファイルをエクスポートします。 Microsoft Entra ID によって発行された証明書またはローカル ユーザー資格情報を使用する SSH 構成ファイルを作成できます。
構文
Export-AzSshConfig
-ResourceGroupName <String>
-Name <String>
-ConfigFilePath <String>
[-PublicKeyFile <String>]
[-PrivateKeyFile <String>]
[-UsePrivateIp]
[-LocalUser <String>]
[-Port <String>]
[-ResourceType <String>]
[-CertificateFile <String>]
[-Overwrite]
[-KeysDestinationFolder <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Export-AzSshConfig
-Ip <String>
-ConfigFilePath <String>
[-PublicKeyFile <String>]
[-PrivateKeyFile <String>]
[-LocalUser <String>]
[-Port <String>]
[-CertificateFile <String>]
[-Overwrite]
[-KeysDestinationFolder <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Export-AzSshConfig
-ResourceId <String>
-ConfigFilePath <String>
[-PublicKeyFile <String>]
[-PrivateKeyFile <String>]
[-UsePrivateIp]
[-LocalUser <String>]
[-Port <String>]
[-CertificateFile <String>]
[-Overwrite]
[-KeysDestinationFolder <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
エクスポートされた SSH 構成ファイルを使用して、OpenSSH 構成と証明書をサポートするクライアント アプリケーションによって Azure リソースに接続できます。 git や rsync などのアプリケーションでは、コマンドを 'ssh -F /path/to/config' に設定することで、構成ファイルを使用できます。 例: rsync -e 'ssh -F /path/to/config'。 ユーザーは、Microsoft Entra ID によって発行された証明書またはローカル ユーザー資格情報を使用する ssh 構成ファイルを作成できます。 重要な注意: Azure Arc リソースに接続する場合、このコマンドレットでは、Az.Ssh.ArcProxy モジュールもクライアント コンピューターにインストールする必要があります。 コマンドレットはPowerShell ギャラリーからモジュールのインストールを試みますが、ユーザーはモジュールを自分でインストールすることもできます。 ユーザーが Az.Ssh.ArcProxy モジュールでプロキシ ファイルを実行するアクセス許可を持っているか、接続が失敗することが重要です。 Az.Ssh.ArcServer モジュールは、PowerShell ギャラリーにありますhttps://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy。
例
例 1: 認証のために Microsoft Entra ID によって発行された証明書を使用して、リソースに接続するための SSH 構成ファイルをエクスポートします。
Export-AzSshConfig -ResourceGroupName myRg -Name myMachine -ConfigFilePath ./sshconfig.config-LocalUser が指定されていない場合、コマンドレットは Microsoft Entra ID を使用してログインするための証明書の作成を試みます。 これは現在、Linux OS を実行しているリソースでのみサポートされています。 Microsoft Entra ID を使用してリソースにログインする場合、構成エントリのホスト名は Azure VM の "{リソース グループ名}-{リソース名}" または "{ip address}" になります。
例 2: Microsoft Entra ID で発行された証明書を使用して、Azure 仮想マシンのパブリック IP に接続するための SSH 構成ファイルをエクスポートします。
Export-AzSshConfig -Ip 1.2.3.4 -ConfigFilePath ./sshconfig.config例 3: 認証に SSH 証明書を使用して Azure Resource 上のローカル ユーザーに接続するための SSH 構成ファイルをエクスポートする
Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -CertificateFile ./cert -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.configローカル ユーザー資格情報を使用してログインする場合、構成エントリのホスト名は Azure VM の "{リソース グループ名}-{リソース名}-{username}" または "{ip address}-{username}" になります。
例 4: 認証に SSH 秘密キーを使用して Azure Resource のローカル ユーザーに接続するための SSH 構成ファイルをエクスポートする
Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config例 5: 認証に対話型のユーザー名とパスワードを使用して Azure Resource のローカル ユーザーに接続するための SSH 構成ファイルをエクスポートする
Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -ConfigFilePath ./sshconfig.config例 6: 証明書の生成されたキーと証明書が格納される場所を決定します。
Export-AzSshConfig -ResourceGroupName myRg -Name myVm -KeysDestinationFolder /home/user/mykeys -ConfigFilePath ./sshconfig.config生成されたキーと証明書は、既定では、構成ファイルと同じディレクトリの "az_ssh_config" ディレクトリに格納されます。 -KeysDestinationFolder パラメーターを使用すると、ユーザーはキーを格納する場所を決定できます。
例 7: 任意の Azure VM で使用する汎用構成を作成します。
Export-AzSshConfig -Ip * -ConfigFilePath ./sshconfig.config例 8: ターゲットのリソースの種類を指定します。
Export-AzSshConfig -ResourceGroupName myRg -Name myVm -ResourceType Microsoft.Compute/virtualMachines -ConfigFilePath ./sshconfig.configこのパラメーターは、リソース グループ内に同じ名前のサポートされているリソースが複数ある場合に便利です。
パラメーター
-CertificateFile
ローカル ユーザー アカウントに対する認証に使用される SSH 証明書。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConfigFilePath
SSH 構成の書き込みパス。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Arc リソースに接続する場合は、接続エンドポイントで SSH 接続の許可ポートを更新してターゲット ポートに一致させるか、必要に応じて、PowerShell ギャラリーから Az.Ssh.ArcProxy モジュールをインストールする前に確認を求めないでください。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Ip
ターゲット Azure VM の IP アドレス。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeysDestinationFolder
生成されたキーと証明書が格納されるディレクトリ。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LocalUser
ターゲット リソース内のローカル ユーザーのユーザー名。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
ターゲットの Azure リソースの名前。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Overwrite
ファイルの末尾に新しいエントリを追加するのではなく、構成ファイルを上書きします。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
リモート ホスト上で接続するポート。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateKeyFile
秘密キー ファイルへのパス。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublicKeyFile
公開キー ファイルへのパス。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
リソース グループ名。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
ターゲット リソースのリソース ID。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceType
ターゲット リソースのリソースの種類。
| Type: | String |
| Accepted values: | Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UsePrivateIp
Azure VM に接続する場合、このフラグは、VM のいずれかのプライベート IP に接続する必要があることを指定します。 プライベート IP への接続が必要です。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |