Export-AzSshConfig

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 Galleryからモジュールのインストールを試みますが、ユーザーはモジュールを自分でインストールすることもできます。 ユーザーが Az.Ssh.ArcProxy モジュールでプロキシ ファイルを実行するアクセス許可を持っているか、接続が失敗することが重要です。 Az.Ssh.ArcServer モジュールは、PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxyにあります。

Export-AzSshConfig -ResourceGroupName myRg -Name myMachine -ConfigFilePath ./sshconfig.config

-LocalUser が指定されていない場合、コマンドレットはMicrosoft Entra IDを使用してログインする証明書の作成を試みます。 これは現在、Linux OS を実行しているリソースでのみサポートされています。 Microsoft Entra IDを使用してリソースにログインする場合、構成エントリのホスト名は"{リソース グループ名}-{リソース名}"、または Azure VM の場合は "{ip address}" になります。

Export-AzSshConfig -Ip 1.2.3.4 -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -CertificateFile ./cert -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config

ローカル ユーザー資格情報を使用してログインする場合、構成エントリのホスト名は "{リソース グループ名}-{リソース名}-{username}"、または Azure VM の場合は "{ip address}-{username}" になります。

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -KeysDestinationFolder /home/user/mykeys -ConfigFilePath ./sshconfig.config

生成されたキーと証明書は、既定では、構成ファイルと同じディレクトリの "az_ssh_config" ディレクトリに格納されます。 -KeysDestinationFolder パラメーターを使用すると、ユーザーはキーを格納する場所を決定できます。

Export-AzSshConfig -Ip * -ConfigFilePath ./sshconfig.config

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -ResourceType Microsoft.Compute/virtualMachines -ConfigFilePath ./sshconfig.config

このパラメーターは、リソース グループ内に同じ名前のサポートされているリソースが複数ある場合に便利です。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。