< Back

Set-AzureRmVMAccessExtension

Tue Jan 29, 2019 9:39 pm

NAME Set-AzureRmVMAccessExtension



SYNOPSIS

Adds the VMAccess extension to a virtual machine.





SYNTAX

Set-AzureRmVMAccessExtension [-ResourceGroupName] <String> [-VMName] <String> [-Credential <PSCredential>] [-DefaultProfile

<IAzureContextContainer>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>] [-Location <String>] [-Name <String>] [-TypeHandlerVersion

<String>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmVMAccessExtension cmdlet adds the Virtual Machine Access (VMAccess) 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.





PARAMETERS

-Credential <PSCredential>

Specifies the user name and password for the virtual machine as a PSCredential object. To obtain a credential, use the Get-Credential cmdlet.

For more information, type `Get-Help Get-Credential`.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DisableAutoUpgradeMinorVersion [<SwitchParameter>]





Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ForceRerun <String>

Indicates that this cmdlet forces a rerun of the same extension configuration on the virtual machine without uninstalling and reinstalling the

extension. The value can be any string different from the current value.



If forceUpdateTag is not changed, updates to public or protected settings are still applied by the handler.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Location <String>

Specifies the location of the virtual machine.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of the extension that this cmdlet adds.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group of the virtual machine.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-TypeHandlerVersion <String>

Specifies the version of the extension to use for this virtual machine. To obtain the version, run the Get-AzureRmVMExtensionImage cmdlet with

a value of Microsoft.Compute for the PublisherName parameter and VMAccessAgent for the Type parameter.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VMName <String>

Specifies the name of a virtual machine. This cmdlet adds VMAccess for the virtual machine that this parameter specifies.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs.



The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

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 (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Compute.Models.PSAzureOperationResponse







NOTES









Example 1: Add a VMAccess extension



PS C:\\> Set-AzureRmVMAccessExtension -ResourceGroupName "ResrouceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest"

-TypeHandlerVersion "2.0" -UserName "PFuller" -Password "Password"



This command adds a VMAccess extension for the virtual machine named VirtualMachine07 in ResrouceGroup11. The command specifies the name and type

handler version for VMAccess.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... sextension

Get-AzureRmVMAccessExtension

Remove-AzureRmVMAccessExtension

Set-AzureRmVMExtension

Get-AzureRmVMExtensionImage