Set-AzVMAccessExtension
语法
Default (默认值)
Set-AzVMAccessExtension
[-Credential <PSCredential>]
[-ResourceGroupName] <String>
[-VMName] <String>
-Name <String>
[-TypeHandlerVersion <String>]
[-Location <String>]
[-DisableAutoUpgradeMinorVersion]
[-ForceRerun <String>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Set-AzVMAccessExtension cmdlet 将虚拟机访问(VMAccess) 虚拟机 VMAccess 扩展添加到虚拟机。 VMAccess 扩展可用于设置临时密码,登录计算机后应立即对其进行更改。 Windows 域控制器不支持此作。
示例
示例 1:添加 VMAccess 扩展
Set-AzVMAccessExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "2.4"
此命令为 ResourceGroup11 中名为 VirtualMachine07 的虚拟机添加 VMAccess 扩展。
该命令指定 VMAccess 的名称和类型处理程序版本。
示例 2
将 VMAccess 扩展添加到虚拟机。 (autogenerated)
Set-AzVMAccessExtension -Credential <PSCredential> -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -TypeHandlerVersion '2.4' -VMName 'VirtualMachine07'
参数
-Confirm
在运行 cmdlet 之前,提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Credential
将虚拟机的用户名和密码指定为 PSCredential 对象。
如果键入的名称与 VM 上的当前本地管理员帐户不同,则 VMAccess 扩展将添加具有该名称的本地管理员帐户,并将指定的密码分配给该帐户。 如果 VM 上的本地管理员帐户存在,它将重置密码,如果帐户已禁用,则 VMAccess 扩展会启用它。
若要获取凭据,请使用 Get-Credential cmdlet。
有关详细信息,请键入 Get-Help Get-Credential。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DisableAutoUpgradeMinorVersion
Set-AzVMAccessExtension cmdlet 将虚拟机访问(VMAccess) 虚拟机 VMAccess 扩展添加到虚拟机。 VMAccess 扩展可用于设置临时密码,登录计算机后应立即对其进行更改。 Windows 域控制器不支持此作。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-ForceRerun
指示此 cmdlet 在虚拟机上强制重新运行相同的扩展配置,而无需卸载并重新安装该扩展。
该值可以是与当前值不同的任何字符串。
如果未更改 forceUpdateTag,则处理程序仍会应用对公共或受保护设置的更新。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-Location
指定虚拟机的位置。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-Name
指定此 cmdlet 添加的扩展的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | ExtensionName |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-NoWait
在作完成之前立即启动作并返回。 若要确定作是否已成功完成,请使用一些其他机制。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ResourceGroupName
指定虚拟机资源组的名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-TypeHandlerVersion
指定要用于此虚拟机的扩展版本。
若要获取版本,请使用 publisherName 参数的值和 Type 参数的 VMAccessAgent 的值运行 Microsoft Get-AzVMExtensionImage cmdlet。 typeHandlerVersion 必须为 2.0 或更高版本,因为版本 1 已弃用。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | HandlerVersion, 版本 |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-VMName
指定虚拟机的名称。
此 cmdlet 为此参数指定的虚拟机添加 VMAccess。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 资源名称 |
参数集
(All)
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。
命令脚本未运行。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输出