Set-AzVMOperatingSystem: EnableAutoUpdate no longer overwrites existing value (#15419)

* still & issue

* test works

* changelog

* TimeZone fix too

* test work in progress

* commented out fix I think

* enacting fix.

Author: Sandido

src/Compute/Compute.Test/ScenarioTests/VirtualMachineTests.cs

@@ -416,5 +416,12 @@ public void TestVirtualMachineAssessmentMode()
         {
             TestRunner.RunTestScript("Test-VirtualMachineAssessmentMode");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestVirtualMachineEnableAutoUpdate()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineEnableAutoUpdate");
+        }
     }
 }

src/Compute/Compute.Test/ScenarioTests/VirtualMachineTests.ps1

@@ -5011,4 +5011,50 @@ function Test-VirtualMachineAssessmentMode
         # Cleanup
         Clean-ResourceGroup $rgname;
     }
-}
+}
+
+<#
+.SYNOPSIS
+Windows machine test ensuring the EnableAutoUpdate value on the 
+provided VM is not overwritten. 
+#>
+function Test-VirtualMachineEnableAutoUpdate
+{
+    # Setup
+    $rgname = Get-ComputeTestResourceName;
+    $loc = Get-ComputeVMLocation;
+
+    try
+    {
+        New-AzResourceGroup -Name $rgname -Location $loc -Force;
+
+        # VM Profile & Hardware
+        $vmname = 'vm' + $rgname;
+        $vmsize = "Standard_B1s";
+        $domainNameLabel = "d1" + $rgname;
+        $computerName = "v" + $rgname;
+
+        # VM Credential
+        $user = "usertest";
+        $password = "Testing1234567";
+        $securePassword = ConvertTo-SecureString $password -AsPlainText -Force;
+        $cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
+
+        # Creating a VM 
+        $vmConfig = New-AzVmConfig -VMName $vmname -vmsize $vmsize;
+        
+        $vmSet = Set-AzVMOperatingSystem -VM $vmConfig -Windows -ComputerName $computerName -Credential $cred -provisionVMAgent -EnableAutoUpdate:$false;
+        Assert-AreEqual $vmSet.OSProfile.WindowsConfiguration.EnableAutomaticUpdates $false;
+        
+        $vmSet2 = Set-AzVMOperatingSystem -VM $vmSet -Windows -ComputerName $computerName -Credential $cred -provisionVMAgent -EnableAutoUpdate;
+        Assert-AreEqual $vmSet2.OSProfile.WindowsConfiguration.EnableAutomaticUpdates $true;
+
+        $vmSet3 = Set-AzVMOperatingSystem -VM $vmSet2 -Windows -ComputerName $computerName -Credential $cred -provisionVMAgent;
+        Assert-AreEqual $vmSet3.OSProfile.WindowsConfiguration.EnableAutomaticUpdates $true;
+    }
+    finally 
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname;
+    }
+} 

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineTests/TestVirtualMachineEnableAutoUpdate.json

@@ -21,6 +21,7 @@
 -->
 ## Upcoming Release
 * Fixed the warning in `New-AzVM` cmdlet stating the sku of the VM is being defaulted even if a sku size is provided by the user. Now it only occurs when the user does not provide a sku size.
+* Edited `Set-AzVmOperatingSystem` cmdlet to no longer overwrite any existing EnableAutomaticUpdates value on the passed in virtual machine if it exists.
 
 ## Version 4.15.0
 * Added optional parameter `-OrchestrationMode` to `New-AzVmss` and `New-AzVmssConfig`

src/Compute/Compute/ChangeLog.md

@@ -304,14 +304,27 @@ public class SetAzureVMOperatingSystemCommand : Microsoft.Azure.Commands.Resourc
 
         public override void ExecuteCmdlet()
         {
-            this.VM.OSProfile = new OSProfile
+            if (this.VM.OSProfile == null)
             {
-                ComputerName = this.ComputerName,
-                AdminUsername = this.Credential.UserName,
-                AdminPassword = ConversionUtilities.SecureStringToString(this.Credential.Password),
-                CustomData = string.IsNullOrWhiteSpace(this.CustomData) ? null : Convert.ToBase64String(Encoding.UTF8.GetBytes(this.CustomData)),
-            };
-
+                this.VM.OSProfile = new OSProfile
+                {
+                    ComputerName = this.ComputerName,
+                    AdminUsername = this.Credential.UserName,
+                    AdminPassword = ConversionUtilities.SecureStringToString(this.Credential.Password),
+                    CustomData = string.IsNullOrWhiteSpace(this.CustomData) ? null : Convert.ToBase64String(Encoding.UTF8.GetBytes(this.CustomData)),
+                };
+            }
+            // These two checks below are present to allow users to change the OS type in the VM object.
+            // This behavior may change in the future. 
+            else if ((this.ParameterSetName == LinuxParamSet) & this.VM.OSProfile.WindowsConfiguration != null)
+            {
+                this.VM.OSProfile.WindowsConfiguration = null;
+            }
+            else if ((this.ParameterSetName == WindowsParamSet) & this.VM.OSProfile.LinuxConfiguration != null)
+            {
+                this.VM.OSProfile.LinuxConfiguration = null;
+            }
+            
             if (this.ParameterSetName == LinuxParamSet)
             {
                 if (this.VM.OSProfile.WindowsConfiguration != null)
@@ -408,9 +421,15 @@ public override void ExecuteCmdlet()
                     this.VM.OSProfile.WindowsConfiguration.ProvisionVMAgent = false;
                 }
 
-                this.VM.OSProfile.WindowsConfiguration.EnableAutomaticUpdates = this.EnableAutoUpdate.IsPresent;
+                if (this.IsParameterBound(c => c.EnableAutoUpdate))
+                {
+                    this.VM.OSProfile.WindowsConfiguration.EnableAutomaticUpdates = this.EnableAutoUpdate;
+                }
 
-                this.VM.OSProfile.WindowsConfiguration.TimeZone = this.TimeZone;
+                //adam tmp removal, if (this.IsParameterBound(c => c.TimeZone))
+                //{
+                    this.VM.OSProfile.WindowsConfiguration.TimeZone = this.TimeZone;
+                //}
 
                 this.VM.OSProfile.WindowsConfiguration.WinRM =
                     !(this.WinRMHttp.IsPresent || this.WinRMHttps.IsPresent)