Set-AzVMAccessExtension

Syntax

Default (Default)

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

Description

Examples

Example 1: Add a VMAccess extension

Set-AzVMAccessExtension -ResourceGroupName "ResourceGroup11" -Location "Central US" -VMName "VirtualMachine07" -Name "ContosoTest" -TypeHandlerVersion "2.4"

Example 2

Set-AzVMAccessExtension -Credential <PSCredential> -Location 'Central US' -Name 'ContosoTest' -ResourceGroupName 'ResourceGroup11' -TypeHandlerVersion '2.4' -VMName 'VirtualMachine07'

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-Credential

Specifies the user name and password for the virtual machine as a PSCredential object. If you type a different name than the current local administrator account on your VM, the VMAccess extension will add a local administrator account with that name, and assign your specified password to that account. If the local administrator account on your VM exists, it will reset the password and if the account is disabled, the VMAccess extension enables it. To obtain a credential, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Parameter properties

Parameter sets

-DefaultProfile

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

Parameter properties

Parameter sets

-DisableAutoUpgradeMinorVersion

The Set-AzVMAccessExtension 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. This is not supported on Windows Domain Controllers.

Parameter properties

Parameter sets

-ForceRerun

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.

Parameter properties

Parameter sets

-Location

Specifies the location of the virtual machine.

Parameter properties

Parameter sets

-Name

Specifies the name of the extension that this cmdlet adds.

Parameter properties

Parameter sets

-NoWait

Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism.

Parameter properties

Parameter sets

-ResourceGroupName

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

Parameter properties

Parameter sets

-TypeHandlerVersion

Specifies the version of the extension to use for this virtual machine. To obtain the version, run the Get-AzVMExtensionImage cmdlet with a value of Microsoft.Compute for the PublisherName parameter and VMAccessAgent for the Type parameter. The typeHandlerVersion must be 2.0 or greater, as version 1 is deprecated.

Parameter properties

Parameter sets

-VMName

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

Parameter properties

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Parameter sets

CommonParameters

Inputs

PSCredential

String

SwitchParameter

Outputs

PSAzureOperationResponse

Related Links

• Get-AzVMAccessExtension
• Remove-AzVMAccessExtension
• Set-AzVMExtension
• Get-AzVMExtensionImage