Set-AzureVMAccessExtension
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Set-AzureVMAccessExtension
Sets the VMAccess extension for the VM.
Syntax
Parameter Set: EnableAccessExtension
Set-AzureVMAccessExtension [[-UserName] <String> ] [[-Password] <String> ] [[-ReferenceName] <String> ] [[-Version] <String> ] -VM <IPersistentVM> [ <CommonParameters>]
Parameter Set: DisableAccessExtension
Set-AzureVMAccessExtension [-Disable] [[-ReferenceName] <String> ] [[-Version] <String> ] -VM <IPersistentVM> [ <CommonParameters>]
Parameter Set: UninstallAccessExtension
Set-AzureVMAccessExtension [-Uninstall] [[-ReferenceName] <String> ] [[-Version] <String> ] -VM <IPersistentVM> [ <CommonParameters>]
Detailed Description
This cmdlet sets the VMAccess extension for the VM.
Parameters
-Disable
Sets the extension state to 'Disable'.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Password<String>
The password for resetting the VM's credential.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ReferenceName<String>
The extension's reference name.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Uninstall
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserName<String>
The user name for resetting the VM's credential.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Version<String>
The Extension Version.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VM<IPersistentVM>
The persistent VM object.
Aliases |
InputObject |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
EXAMPLE
This example sets the VMAccess extension applied to the specified VM as stored in the variable $vm.
C:\PS>Set-AzureVMAccessExtension -VM $vm -UserName $usr -Password $pwd;