适用于 Windows 的 VMAccess 扩展

VMAccess 扩展用于管理用户、配置 RDP 以及检查或修复 Azure Windows 虚拟机上的磁盘。 该扩展集成了 Azure 资源管理器模板。 还可以使用 Azure CLI、Azure PowerShell、Azure 门户和 Azure 虚拟机 REST API 调用它。

本文介绍如何通过 Azure PowerShell 和 Azure 资源管理器模板运行 VMAccess 扩展。 本文还提供针对 Windows 系统的疑难解答步骤。

先决条件

支持的 Windows 版本

提示

• VMAccess 旨在当无法访问虚拟机 (VM) 时重新获取对该虚拟机的访问权限。 基于这一原则，它会将管理员权限授予用户名字段中指定的帐户。 如果你不希望某个用户拥有管理员权限，请登录到虚拟机并使用内置工具（如 net user 和 Local Users and Groups）来管理用户权限。
• 只能向一台 VM 应用一个扩展版本。 要运行另一个操作，可使用新配置更新现有扩展。
• 更新用户时，VMAccess 会修改远程桌面设置以允许登录。

扩展架构

VMAccess 扩展的配置包括用户名、密码以及重置管理员密码的相关设置。 可以将这些信息存储在配置文件中，在 PowerShell 中指定，或者包含在 Azure 资源管理器 (ARM) 模板中。 以下 JSON 架构包含可用于公共和受保护设置的所有属性。

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "<name>",
  "apiVersion": "2023-09-01",
  "location": "<location>",
  "dependsOn": [
          "[concat('Microsoft.Compute/virtualMachines/', <vmName>)]"
  ],
  "properties": {
    "publisher": "Microsoft.Compute",
    "type": "VMAccessAgent",
    "typeHandlerVersion": "2.4",
    "autoUpgradeMinorVersion": true,
    "settings": {},
    "protectedSettings": {
      "username": "<username>",
      "password": "<password>",
      "reset_password": true
    } 
  }
}

属性值

设置属性值

使用 PowerShell 部署

可以使用 PowerShell 将 VMAccess 扩展应用到 Windows 虚拟机上。 以下 PowerShell 脚本是一个重置管理员密码的示例：

$resourceGroup = "<ResourceGroupName>"
$vmName = "<VMName>"
$location = "<Location>"
$username = "<Username>"
$password = "<NewPassword>"

$settings = @{}
$protectedSettings = @{
    "username" = $username
    "password" = $password
    "reset_password" = $true
}

Set-AzVMExtension -ResourceGroupName $resourceGroup `
                    -VMName $vmName `
                    -Location $location `
                    -Name "VMAccessAgent" `
                    -Publisher "Microsoft.Compute" `
                    -ExtensionType "VMAccessAgent" `
                    -TypeHandlerVersion "2.4" `
                    -Settings $settings `
                    -ProtectedSettings $protectedSettings

模板部署

可使用 Azure 资源管理器 (ARM) 模板部署 Azure VM 扩展。 上一部分中详细说明的 JSON 架构可用于 ARM 模板，以在模板部署期间运行 VMAccess 扩展。 可在 GitHub 上找到包含 VMAccess 扩展的示例模板。

必须将虚拟机扩展的 JSON 配置嵌套在该模板的虚拟机资源片段中，具体来说是嵌套在虚拟机模板的 "resources": [] 对象和 "virtualMachineProfile":"extensionProfile":{"extensions" :[] 对象下的虚拟机规模集。

使用适用于 Windows 的 Azure PowerShell VM/VMSS 扩展命令

可以使用 Set-AzVMExtension 命令，为 Windows 虚拟机按指定配置运行 VMAccess 扩展。

以下 PowerShell 脚本是使用 Set-AzVMExtension 命令的示例：

Set-AzVMExtension `
  -ResourceGroupName "myResourceGroup" `
  -VMName "myVM" `
  -Name "VMAccessAgent" `
  -Publisher "Microsoft.Compute" `
  -Type "VMAccessAgent" `
  -TypeHandlerVersion "2.0" `
  -Settings @{ "ResetPassword" = $true } `
  -ProtectedSettings @{ "Username" = "adminUser"; "Password" = "userPassword" }

-Settings 和 - ProtectedSettings 参数也接受 JSON 文件路径。 例如，要使用 JSON 文件更新本地管理员密码，请创建一个名为 update_admin_password.json 的文件，并包含以下内容。 将值替换为自己的信息：

{
  "Username": "adminUser",
  "Password": "userPassword"
}

然后，以该 JSON 文件作为输入运行扩展：

Set-AzVMExtension `
  -ResourceGroupName "myResourceGroup" `
  -VMName "myVM" `
  -Name "VMAccessAgent" `
  -Publisher "Microsoft.Compute" `
  -Type "VMAccessAgent" `
  -TypeHandlerVersion "2.0" `
  -ProtectedSettings (Get-Content -Path "update_admin_password.json" -Raw | ConvertFrom-Json)

适用于 Windows 的 Azure PowerShell 部署

可以使用 Azure PowerShell 将 VMAccess 扩展部署到现有的 Windows 虚拟机或虚拟机规模集上。 可以通过运行以下项将扩展部署到 VM：

$username = "<username>"
$password = "<password>"
$settings = @{ "ResetPassword" = $true }
$protectedSettings = @{ "Username" = $username; "Password" = $password }
Set-AzVMExtension -ResourceGroupName "<resource-group>" `
    -VMName "<vm-name>" `
    -Location "<location>" `
    -Publisher "Microsoft.Compute" `
    -ExtensionType "VMAccessAgent" `
    -Name "VMAccessAgent" `
    -TypeHandlerVersion "2.0" `
    -Settings $settings `
    -ProtectedSettings $protectedSettings

还可以使用字符串提供和修改扩展设置：

$username = "<username>"
$password = "<password>"
$settingsString = '{"ResetPassword": true}';
$protectedSettingsString = '{"Username":"' + $username + '", "Password":"' + $password + '"}';
Set-AzVMExtension -ResourceGroupName "<resource-group>" `
    -VMName "<vm-name>" `
    -Location "<location>" `
    -Publisher "Microsoft.Compute" `
    -ExtensionType "VMAccessAgent" `
    -Name "VMAccessAgent" `
    -TypeHandlerVersion "2.0" `
    -SettingString $settingsString `
    -ProtectedSettingString $protectedSettingsString

要部署到虚拟机规模集，请运行以下命令：

$resourceGroupName = "<resource-group>"
$vmssName = "<vmss-name>"
$protectedSettings = @{
  "Username" = "adminUser"
  "Password" = "userPassword"
}
$publicSettings = @{
  "ResetPassword" = $true
}
$vmss = Get-AzVmss `
            -ResourceGroupName $resourceGroupName `
            -VMScaleSetName $vmssName
Add-AzVmssExtension -VirtualMachineScaleSet $vmss `
    -Name "VMAccessAgent" `
    -Publisher "Microsoft.Compute" `
    -Type "VMAccessAgent" `
    -TypeHandlerVersion "2.0" `
    -AutoUpgradeMinorVersion $true `
    -Setting $publicSettings `
    -ProtectedSetting $protectedSettings
Update-AzVmss `
    -ResourceGroupName $resourceGroupName `
    -Name $vmssName `
    -VirtualMachineScaleSet $vmss

故障排除和支持

VMAccess 扩展的日志存储在虚拟机本地，对故障排除尤其有用。

还可以运行以下命令来检索 VMAccess 扩展的执行状态以及给定 VM 上的其他扩展：

可以通过运行以下 PowerShell 命令来检索给定虚拟机上虚拟机扩展的执行状态：

Get-AzVMExtension -ResourceGroupName "myResourceGroup" -VMName "myVM" | Format-Table

错误消息

如需更多帮助，可以提交 Azure 支持事件。 转到 Azure 门户，然后选择“获取支持”。 有关 Azure 支持的详细信息，请阅读 Azure 支持计划 FAQ。