< Back

Set-AzureVMAccessExtension

Wed Jan 30, 2019 5:54 pm

NAME Set-AzureVMAccessExtension



SYNOPSIS

Sets the VMAccess extension for a virtual machine.





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 sets the VMAccess extension for the virtual machine.





PARAMETERS

-UserName <String>

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



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Password <String>

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



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ReferenceName <String>

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.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Version <String>

Specifies the version of the extension.



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ForceUpdate [<SwitchParameter>]

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



Required? false

Position? 5

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-VM <IPersistentVM>

Specifies the persistent virtual machine object.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Disable [<SwitchParameter>]

Indicates that this cmdlet sets the Extension State to Disable.



Required? true

Position? 1

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Uninstall [<SwitchParameter>]

Indicates whether this cmdlet uninstalls the access extension.



Required? true

Position? 1

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- 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.



RELATED LINKS

Get-AzureVMAccessExtension

Remove-AzureVMAccessExtension