Enter-AzVM
このコマンドレットは 、プレビュー モジュールの一部です。 プレビュー バージョンは、運用環境で使用することはお勧めしません。 詳細については、を参照してください。
Azure リソース (Azure VM や Arc Server など) への対話型 SSH セッションを開始します。
ユーザーは、Microsoft Entra アカウントを使用してログインするか、標準の SSH 認証を使用してローカル ユーザー アカウントを使用してログインできます。 最適なセキュリティと利便性Microsoft Entraアカウント ログインを使用します。
構文
Interactive (既定)
Enter-AzVM
-ResourceGroupName <String>
-Name <String>
[-PublicKeyFile <String>]
[-PrivateKeyFile <String>]
[-UsePrivateIp]
[-LocalUser <String>]
[-Port <String>]
[-ResourceType <String>]
[-CertificateFile <String>]
[-SshArgument <String[]>]
[-Rdp]
[-PassThru]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
IpAddress
Enter-AzVM
-Ip <String>
[-PublicKeyFile <String>]
[-PrivateKeyFile <String>]
[-LocalUser <String>]
[-Port <String>]
[-CertificateFile <String>]
[-SshArgument <String[]>]
[-Rdp]
[-PassThru]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceId
Enter-AzVM
-ResourceId <String>
[-PublicKeyFile <String>]
[-PrivateKeyFile <String>]
[-UsePrivateIp]
[-LocalUser <String>]
[-Port <String>]
[-CertificateFile <String>]
[-SshArgument <String[]>]
[-Rdp]
[-PassThru]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Azure リソースへの対話型 SSH セッションを開始します (現在、AZURE VM と Arc Server がサポートされています)。
ユーザーは、発行された証明書Microsoft Entra使用するか、ローカル ユーザー資格情報を使用してログインできます。 可能な場合は、Microsoft Entra発行された証明書を使用してログインすることをお勧めします。
重要な注意: Azure Arc リソースに接続する場合、このコマンドレットでは、Az.Ssh.ArcProxy モジュールもクライアント コンピューターにインストールする必要があります。 コマンドレットはPowerShell Galleryからモジュールのインストールを試みますが、ユーザーはモジュールを自分でインストールすることもできます。 ユーザーが Az.Ssh.ArcProxy モジュールでプロキシ ファイルを実行するアクセス許可を持っているか、接続が失敗することが重要です。 Az.Ssh.ArcServer モジュールは、PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxyにあります。
例
例 1: 発行された証明書を使用して Azure リソースMicrosoft Entra接続する
Enter-AzVM -ResourceGroupName myRg -Name myMachine
-LocalUser が指定されていない場合、コマンドレットはMicrosoft Entra IDを使用してログインを試みます。 これは現在、Linux OS を実行しているリソースでのみサポートされています。
例 2: 認証に SSH 証明書を使用して Azure リソースのローカル ユーザーに接続する
Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser -PrivateKeyFile ./id_rsa -CertificateFile ./cert
例 3: 認証に SSH 秘密キーを使用して Azure リソースのローカル ユーザーに接続する
Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser -PrivateKeyFile ./id_rsa
例 4: 対話型のユーザー名とパスワード認証を使用して Azure リソースのローカル ユーザーに接続する
Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser
例 5: 発行された証明書を使用してAzure仮想マシンのパブリック IP Microsoft Entra接続する
例 6: ターゲットのリソースの種類を指定します。
Enter-AzVM -ResourceGroupName myRg -Name myMachine -ResourceType Microsoft.HybridCompute/machines
このパラメーターは、リソース グループ内に同じ名前のサポートされているリソースが複数ある場合に便利です。
例 7: 証明書によって発行された証明書とカスタム キー ファイルMicrosoft Entra使用して Azure リソースに接続する
Enter-AzVM -ResourceGroupName myRg -Name myMachine -PrivateKeyFile ./id_rsa -PublicKeyFile ./id_rsa.pub
カスタム キー ファイルが指定されていない場合、コマンドレットによってキー ペアが生成されます。
例 8: SSH 接続経由で RDP 接続を開始します。
Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser username -Rdp
このパラメーターは、Arc Connectivity Platform 経由で Arc リソースへの RDP セッションを作成する場合に役立ちます。
パラメーター
-CertificateFile
ローカル ユーザー アカウントに対する認証に使用される SSH 証明書。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
Arc リソースに接続する場合は、接続エンドポイントの SSH 接続で許可されているポートを更新してターゲット ポートに一致させるか、必要に応じて、PowerShell Galleryから Az.Ssh.ArcProxy モジュールをインストールする前に確認を求めないでください。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Ip
ターゲット Azure VM の IP アドレス。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
IpAddress
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LocalUser
ターゲット リソース内のローカル ユーザーのユーザー名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
ターゲット Azure リソースの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Interactive
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PassThru
接続が成功した場合は true を返します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Port
リモート ホスト上で接続するポート。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PrivateKeyFile
秘密キー ファイルへのパス。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PublicKeyFile
公開キー ファイルへのパス。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Rdp
SSH 接続経由で RDP 接続を開始します。 Windows OS でのみサポートされます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループ名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Interactive
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResourceId
ターゲット リソースのリソース ID。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ResourceId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ResourceType
ターゲット リソースのリソースの種類。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| 指定可能な値: | Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Interactive
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SshArgument
OpenSSH に渡される追加の SSH 引数。
パラメーターのプロパティ
| 型: | String[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UsePrivateIp
Azure VM に接続する場合、このフラグは、VM のいずれかのプライベート IP に接続する必要があることを指定します。 プライベート IP への接続が必要です。
パラメーターのプロパティ
パラメーター セット
Interactive
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ResourceId
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力