你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AzureRmVMAccessExtension

将 VMAccess 扩展添加到虚拟机。

警告

截至 2024 年 2 月 29 日,AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新,建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行,但它不再维护或受支持,但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导,请参阅我们的迁移资源

语法

Set-AzureRmVMAccessExtension
   [-Credential <PSCredential>]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name <String>]
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-AzureRmVMAccessExtension cmdlet 将虚拟机访问(VMAccess) 虚拟机 VMAccess 扩展添加到虚拟机。 VMAccess 扩展可用于设置临时密码,登录计算机后应立即对其进行更改。 Windows 域控制器不支持此操作。

示例

示例 1:添加 VMAccess 扩展

PS C:\> Set-AzureRmVMAccessExtension -ResourceGroupName "ResrouceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "2.4" -UserName "PFuller" -Password "Password"

此命令为 ResrouceGroup11 中名为 VirtualMachine07 的虚拟机添加 VMAccess 扩展。 该命令指定 VMAccess 的名称和类型处理程序版本。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
Aliases:cf
Position:Named
默认值:False
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

将虚拟机的用户名和密码指定为 PSCredential 对象。 如果在 VM 上键入不同于当前本地管理员帐户的名称,则 VMAccess 扩展使用该名称添加本地管理员帐户,将指定密码分配给该帐户。 如果 VM 上存在本地管理员帐户,则该帐户会重置密码,如果该账户处于禁用状态,则 VMAccess 扩展会启用它。 若要获取凭据,请使用 Get-Credential cmdlet。 要了解详情,请键入 Get-Help Get-Credential

类型:PSCredential
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableAutoUpgradeMinorVersion

类型:SwitchParameter
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-ForceRerun

指示此 cmdlet 在虚拟机上强制重新运行相同的扩展配置,而无需卸载并重新安装该扩展。 该值可以是与当前值不同的任何字符串。 如果未更改 forceUpdateTag,则处理程序仍会应用对公共或受保护设置的更新。

类型:String
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Location

指定虚拟机的位置。

类型:String
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

指定此 cmdlet 添加的扩展的名称。

类型:String
Aliases:ExtensionName
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

指定虚拟机资源组的名称。

类型:String
Position:0
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-TypeHandlerVersion

指定要用于此虚拟机的扩展版本。 若要获取版本,请使用 PublisherName 参数的值和 Type 参数的 VMAccessAgent 值运行 Get-AzureRmVMExtensionImage cmdlet。 typeHandlerVersion 必须是 2.0 或更高版本,因为版本 1 已弃用。

类型:String
Aliases:HandlerVersion, Version
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-VMName

指定虚拟机的名称。 此 cmdlet 为此参数指定的虚拟机添加 VMAccess。

类型:String
Aliases:ResourceName
Position:1
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
Aliases:wi
Position:Named
默认值:False
必需:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PSCredential

String

SwitchParameter

输出

PSAzureOperationResponse