Set-AzureVMAccessExtension

Reference

Module:: Azure

Sets the VMAccess extension for a virtual machine.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Service Management APIs. See the Az PowerShell module for cmdlets to manage Azure Resource Manager resources.

Syntax

Set-AzureVMAccessExtension
   [[-UserName] <String>]
   [[-Password] <String>]
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   [-ForceUpdate]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Set-AzureVMAccessExtension
   [-Disable]
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   [-ForceUpdate]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Set-AzureVMAccessExtension
   [-Uninstall]
   [[-ReferenceName] <String>]
   [[-Version] <String>]
   [-ForceUpdate]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Set-AzureVMAccessExtension cmdlet adds the Virtual Machine VMAccess Extension to a virtual machine. VMAccess Extension can be used to set a temporary password and this should be immediately changed it after logging into the machine.

Examples

Example 1: Set the VMAccess extension applied to a specified virtual machine

PS C:\> Set-AzureVMAccessExtension -VM $VM -UserName $User -Password $PWD;

This command sets the VMAccess extension applied to the specified virtual machine as stored in the variable $VM.

Parameters

-Disable

Indicates that this cmdlet sets the Extension State to Disable.

Type:	SwitchParameter
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ForceUpdate

Indicates that this cmdlet reapplies a configuration to an extension when the configuration has not been updated.

Type:	SwitchParameter
Position:	5
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

Continue
Ignore
Inquire
SilentlyContinue
Stop
Suspend

Type:	ActionPreference
Aliases:	infa
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InformationVariable

Specifies an information variable.

Type:	String
Aliases:	iv
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Password

Specifies the password for resetting the virtual machine's credential.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:	AzureSMProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ReferenceName

Specifies the reference name of the access extension.

This is a user-defined string that is used to refer to an extension. It is specified when the extension is added to the virtual machine for the first time. For subsequent updates, you should specify the previously used reference name while updating the extension. The ReferenceName assigned to an extension is returned using the Get-AzureVM cmdlet.

Type:	String
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Uninstall

Indicates whether this cmdlet uninstalls the access extension.

Type:	SwitchParameter
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-UserName

Specifies the user name that this cmdlet uses to reset the virtual machine's credential.

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Version

Specifies the version of the extension.

Type:	String
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-VM

Specifies the persistent virtual machine object.

Type:	IPersistentVM
Aliases:	InputObject
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False