Enter-AzVM
启动到 Azure 资源的交互式 SSH 会话(例如 Azure VM 或 Arc 服务器)。
用户可以通过标准 SSH 身份验证使用 Microsoft Entra 帐户或本地用户帐户登录。 使用 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 服务器)。
用户可以使用 Microsoft Entra 颁发的证书或使用本地用户凭据登录。 建议尽可能使用 Microsoft Entra 颁发的证书登录。
重要说明:连接到 Azure Arc 资源时,此 cmdlet 需要同时在客户端计算机中安装 Az.Ssh.ArcProxy 模块。 该 cmdlet 将尝试从 PowerShell 库安装模块,但用户还可以选择自行安装该模块。 用户还必须有权在 Az.Ssh.ArcProxy 模块中执行代理文件,否则连接将失败。 可以在 PowerShell 库 https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy中找到 Az.Ssh.ArcServer 模块。
示例
示例 1:使用 Microsoft Entra 颁发的证书连接到 Azure 资源
Enter-AzVM -ResourceGroupName myRg -Name myMachine
如果未提供 -LocalUser,cmdlet 将尝试使用 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:使用 Microsoft Entra 颁发的证书连接到 Azure 虚拟机的公共 IP
示例 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
如果未提供自定义密钥文件,cmdlet 将生成密钥对。
示例 8:通过 SSH 连接启动 RDP 连接。
Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser username -Rdp
此参数可用于通过 Arc 连接平台创建到 Arc 资源的 RDP 会话。
参数
-CertificateFile
用于向本地用户帐户进行身份验证的 SSH 证书。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Force
连接到 Arc 资源时,在更新连接终结点中允许的 SSH 连接的端口以匹配目标端口或根据需要从 PowerShell 库安装 Az.Ssh.ArcProxy 模块之前,请不要提示进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Ip
目标 Azure VM 的 IP 地址。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
IpAddress
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-LocalUser
目标资源中本地用户的用户名。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Name
目标 Azure 资源的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
Interactive
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-PassThru
如果连接成功,则返回 true。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Port
要连接到远程主机上的端口。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PrivateKeyFile
私钥文件的路径。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PublicKeyFile
公钥文件的路径。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Rdp
通过 SSH 连接启动 RDP 连接。 仅在 Windows OS 上受支持。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ResourceGroupName
资源组名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
Interactive
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-ResourceId
目标资源的资源 ID。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
ResourceId
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-ResourceType
目标资源的资源类型。
参数属性
| 类型: | String
|
| 默认值: | None |
| 接受的值: | Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines |
| 支持通配符: | False |
| 不显示: | False |
参数集
Interactive
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SshArgument
传递给 OpenSSH 的其他 SSH 参数。
参数属性
| 类型: | String[]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UsePrivateIp
连接到 Azure VM 时,此标志指定应连接到 VM 的其中一个专用 IP。 它需要连接到专用 IP。
参数属性
参数集
Interactive
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
ResourceId
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输出