Reimage Support of standalone Non-Ephemeral VM (#21320)

* update

* Update ChangeLog.md

---------

Co-authored-by: Theodore Chang <[email protected]>
Co-authored-by: Yabo Hu <[email protected]>

Author: 3 people

src/Compute/Compute/ChangeLog.md

@@ -20,10 +20,8 @@
 
 -->
 ## Upcoming Release
-* Removed the image alias `CoreOS` as the publisher CoreOS no longer has any images for Azure. 
-* Updated the names of the `openSUSE-Leap` and `SLES` aliases to `OpenSuseLeap154` and `SuseSles15SP4` respectively. Updated these aliases to point to an image that actually exists and updated the alias names to be descriptive and versioned.
-* Added new descriptive and versioned alias names for the Linux image aliases.
 * Addressed bug in `Remove-AzVmss` to throw error when `-InstanceId` is null. [#21162]
+* Added `-CustomData`, `-AdminPassword`, and `-ExactVersion` parameters to `Invoke-AzVMReimage`.
 * Removed the image alias `CoreOS` as the publisher CoreOS no longer has any images for Azure. 
   Updated the names of the `openSUSE-Leap` and `SLES` aliases to `OpenSuseLeap154` and `SuseSles15SP4` respectively. Updated these aliases to point to an image that actually exists.
 * Added a breaking change warning to `New-AzVM` and `New-AzVmss` for future planned image alias removals due to the images reaching their End of Support date. 

src/Compute/Compute/Generated/VirtualMachine/VirtualMachineReimageMethod.cs

@@ -43,11 +43,34 @@ public override void ExecuteCmdlet()
             {
                 if (ShouldProcess(this.VMName, VerbsLifecycle.Invoke))
                 {
+                    VirtualMachineReimageParameters vmReimageParams = new VirtualMachineReimageParameters();
+                    vmReimageParams.TempDisk = this.TempDisk.IsPresent ? true : (bool?)null;
                     string resourceGroupName = this.ResourceGroupName;
                     string vmName = this.VMName;
-                    bool? tempDisk = this.TempDisk.IsPresent ? true : (bool?)null;
 
-                    var result = VirtualMachinesClient.ReimageWithHttpMessagesAsync(resourceGroupName, vmName, tempDisk).GetAwaiter().GetResult();
+                    if (this.IsParameterBound(c => c.ExactVersion))
+                    {
+                        vmReimageParams.ExactVersion = this.ExactVersion;
+                    }
+
+                    if (this.IsParameterBound(c => c.CustomData))
+                    {
+                        if (vmReimageParams.OsProfile == null) { 
+                            vmReimageParams.OsProfile = new OSProfileProvisioningData();
+                        }
+                        vmReimageParams.OsProfile.CustomData = this.CustomData;
+                    }
+
+                    if (this.IsParameterBound(c => c.AdminPassword))
+                    {
+                        if (vmReimageParams.OsProfile == null)
+                        {
+                            vmReimageParams.OsProfile = new OSProfileProvisioningData();
+                        }
+                        vmReimageParams.OsProfile.AdminPassword = this.AdminPassword; 
+                    }
+
+                    var result = VirtualMachinesClient.ReimageWithHttpMessagesAsync(resourceGroupName, vmName, vmReimageParams).GetAwaiter().GetResult();
                     PSOperationStatusResponse output = new PSOperationStatusResponse
                     {
                         StartTime = this.StartTime,
@@ -87,5 +110,23 @@ public override void ExecuteCmdlet()
 
         [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
         public SwitchParameter AsJob { get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.")]
+        public string ExactVersion { get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.")]
+        public string CustomData { get; set; }
+
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "Specifies the password of the administrator account.")]
+        public string AdminPassword { get; set; }
     }
 }

src/Compute/Compute/help/Invoke-AzVMReimage.md

@@ -14,6 +14,7 @@ Reimage an Azure virtual machine.
 
 ```
 Invoke-AzVMReimage [-ResourceGroupName] <String> [-VMName] <String> [-TempDisk] [-AsJob]
+ [-ExactVersion <String>] [-CustomData <String>] [-AdminPassword <String>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -29,8 +30,43 @@ Invoke-AzVMReimage -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"
 
 This command reimages the virtual machine named VirtualMachine07 in ResourceGroup11.
 
+### Example 2
+```powershell
+$SecurePassword = ConvertTo-SecureString "password" -AsPlainText 
+Invoke-AzVMReimage -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -TempDisk -CustomData $CustomData -AdminPassword $SecurePassword -ExactVersion "10.0.14393.0"
+```
+
+Passing in -AdminPassword using SecureString along with other parameters to reimage the virtual machine.
+
 ## PARAMETERS
 
+### -AdminPassword
+Specifies the password of the administrator account. 
+<br><br> **Minimum-length (Windows):** 8 characters 
+<br><br> **Minimum-length (Linux):** 6 characters 
+<br><br> **Max-length (Windows):** 123 characters 
+<br><br> **Max-length (Linux):** 72 characters 
+<br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled 
+<br> Has lower characters 
+<br>Has upper characters 
+<br> Has a digit 
+<br> Has a special character (Regex match [\\W_]) 
+<br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\" 
+<br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp) 
+<br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -AsJob
 Run cmdlet in the background
 
@@ -46,6 +82,25 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -CustomData
+Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. 
+<br><br> **Note: Do not pass any secrets or passwords in customData property** 
+<br><br> This property cannot be updated after the VM is created. 
+<br><br> customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/) 
+<br><br> For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -DefaultProfile
 The credentials, account, tenant, and subscription used for communication with Azure.
 
@@ -61,6 +116,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ExactVersion
+Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
 ### -ResourceGroupName
 Specifies the name of the resource group of the virtual machine.