Cplat enable automatic upgrade (#13956)

* update for the new parameter

* update

* Update VirtualMachineScaleSetExtensionTests.cs

* Update ChangeLog.md

fix change log

Co-authored-by: Jin Lei <[email protected]>

Author: grizzlytheodore

src/Compute/Compute.Test/ScenarioTests/VirtualMachineExtensionTests.cs

@@ -176,5 +176,11 @@ public void TestVirtualMachineADDomainExtensionDomainJoin()
         {
             TestRunner.RunTestScript("Test-VirtualMachineADDomainExtensionDomainJoin");
         }
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestVirtualMachineExtensionEnableAutomaticUpgrade()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineExtensionEnableAutomaticUpgrade");
+        }
     }
 }

src/Compute/Compute.Test/ScenarioTests/VirtualMachineExtensionTests.ps1

@@ -2519,3 +2519,64 @@ function Test-VirtualMachineADDomainExtensionDomainJoin
         Clean-ResourceGroup $rgname
     }
 }
+
+<#
+.SYNOPSIS
+Test Virtual Machine Extensions EnableAutomaticUpgrade
+#>
+function Test-VirtualMachineExtensionEnableAutomaticUpgrade
+{
+    # Setup
+    $rgname = Get-ComputeTestResourceName;
+
+    try
+    {
+        $loc = Get-ComputeVMLocation;
+        New-AzResourceGroup -Name $rgname -Location $loc -Force;
+
+        $user = "Foo2";
+        $password = $PLACEHOLDER;
+        $securePassword = ConvertTo-SecureString $password -AsPlainText -Force;
+        $cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
+
+        $vmname = "extensionTestVM"
+        $vmssname = "extensionTestVmss"
+        $domainNameLabel = 'pubip'+$rgname;
+        $domainNameLabel2 = $domainNameLabel + '2'
+
+
+        # create vm/vmss
+        New-AzVM -ResourceGroupName $rgname -Location $loc -name $vmname -credential $cred -domainNameLabel $domainNameLabel
+        New-AzVmss -ResourceGroupName $rgname -Location $loc -VMScalesetName $vmssname -credential $cred -domainNameLabel $domainNameLabel2
+
+        # check vm/vmss
+        $vm = Get-AzVM -Name $vmname -ResourceGroupName $rgname;
+        Assert-NotNull $vm;
+        $vmss = Get-AzVmss -Name $vmssname -ResourceGroupName $rgname;
+        Assert-NotNull $vmss;
+        
+        # Extension
+        $extname = 'csetest';
+        $publisher = 'Microsoft.Compute';
+        $exttype = 'CustomScriptExtension';
+        $extver = '1.1';
+        
+        # Set extension settings by raw strings
+        $settingstr = '{"fileUris":[],"commandToExecute":"powershell Get-Process"}';
+        $protectedsettingstr = '{"storageAccountName":"somename","storageAccountKey":"somekey"}';
+
+        Set-AzVMExtension -ResourceGroupName $rgname -Location $loc -VMName $vmname -Name $extname -Publisher $publisher -ExtensionType $exttype -TypeHandlerVersion $extver -SettingString $settingstr -ProtectedSettingString $protectedsettingstr -enableAutomaticUpgrade $False; 
+        $VMSSext = Add-AzVmssExtension -VirtualMachineScaleSet $vmss -Name $extname -Publisher $publisher -Type $exttype -TypeHandlerVersion $extver -enableAutomaticUpgrade $False; 
+        
+        $VMext = Get-AzVMExtension -ResourceGroupName $rgname -VMName $vmname -Name $extname;
+
+        # check enableAutomaticUpgrade property
+        Assert-False { $VMext.EnableAutomaticUpgrade };
+        Assert-False { $VMSSext.VirtualMachineProfile.ExtensionProfile.Extensions[-1].EnableAutomaticUpgrade };
+    }
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname
+    }
+}

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineExtensionTests/TestVirtualMachineExtensionEnableAutomaticUpgrade.json

@@ -20,6 +20,7 @@
 
 -->
 ## Upcoming Release
+* Added parameter `-EnableAutomaticUpgrade` to `Set-AzVmExtension` and `Add-AzVmssExtension`.
 * Removed FilterExpression parameter from `Get-AzVMImage` cmdlet documentation. 
 * Added deprecation message to the ContainerService cmdlets:
     - `Add-AzureRmContainerServiceAgentPoolProfileCommand`

src/Compute/Compute/ChangeLog.md

@@ -69,6 +69,10 @@ public class SetAzureVMExtensionBaseCmdlet : VirtualMachineExtensionBaseCmdlet
             HelpMessage = "Disable auto-upgrade of minor version")]
         public SwitchParameter DisableAutoUpgradeMinorVersion { get; set; }
 
+        [Parameter(
+            Mandatory = false)]
+        public bool? EnableAutomaticUpgrade { get; set; }
+
         [Parameter(
             Mandatory = false,
             ValueFromPipelineByPropertyName = true,

src/Compute/Compute/Extension/SetAzureVMExtensionBaseCmdlet.cs

@@ -102,7 +102,8 @@ public override void ExecuteCmdlet()
                         Settings = this.Settings,
                         ProtectedSettings = this.ProtectedSettings,
                         AutoUpgradeMinorVersion = !this.DisableAutoUpgradeMinorVersion.IsPresent,
-                        ForceUpdateTag = this.ForceRerun
+                        ForceUpdateTag = this.ForceRerun,
+                        EnableAutomaticUpgrade = this.EnableAutomaticUpgrade
                     };
 
                     if (NoWait.IsPresent)

src/Compute/Compute/Extension/SetAzureVMExtensionCommand.cs

@@ -83,6 +83,10 @@ public partial class AddAzureRmVmssExtensionCommand : Microsoft.Azure.Commands.R
             ValueFromPipelineByPropertyName = true)]
         public Object ProtectedSetting { get; set; }
 
+        [Parameter(
+            Mandatory = false)]
+        public bool? EnableAutomaticUpgrade { get; set; }
+
         [Parameter(
             Mandatory = false,
             ValueFromPipelineByPropertyName = true)]
@@ -132,6 +136,7 @@ private void Run()
             vExtensions.Settings = this.IsParameterBound(c => c.Setting) ? this.Setting : null;
             vExtensions.ProtectedSettings = this.IsParameterBound(c => c.ProtectedSetting) ? this.ProtectedSetting : null;
             vExtensions.ProvisionAfterExtensions = this.IsParameterBound(c => c.ProvisionAfterExtension) ? this.ProvisionAfterExtension : null;
+            vExtensions.EnableAutomaticUpgrade = this.IsParameterBound(c => c.EnableAutomaticUpgrade) ? this.EnableAutomaticUpgrade : null;
             this.VirtualMachineScaleSet.VirtualMachineProfile.ExtensionProfile.Extensions.Add(vExtensions);
             WriteObject(this.VirtualMachineScaleSet);
         }

src/Compute/Compute/Generated/VirtualMachineScaleSet/Config/AddAzureRmVmssExtensionCommand.cs

@@ -32,6 +32,7 @@ public class PSVirtualMachineScaleSetExtension
         public string Type { get; set; } // This is Type1 in SDK, but mapped to Type to hide a breaking change.  
         public string TypeHandlerVersion { get; set; }
         public bool? AutoUpgradeMinorVersion { get; set; }
+        public bool? EnableAutomaticUpgrade { get; set; }
         public object Settings { get; set; }
         public object ProtectedSettings { get; set; }
         public string ProvisioningState { get; set; }

src/Compute/Compute/Manual/PSVirtualMachineScaleSetExtension.cs

@@ -52,6 +52,7 @@ public class PSVirtualMachineExtension
         public bool? AutoUpgradeMinorVersion { get; set; }
 
         public string ForceUpdateTag { get; set; }
+        public bool? EnableAutomaticUpgrade { get; set; }
     }
 
     public static class PSVirtualMachineExtensionConversions
@@ -85,7 +86,8 @@ public static PSVirtualMachineExtension ToPSVirtualMachineExtension(this Virtual
                 Statuses = ext.InstanceView == null ? null : ext.InstanceView.Statuses,
                 SubStatuses = ext.InstanceView == null ? null : ext.InstanceView.Substatuses,
                 AutoUpgradeMinorVersion = ext.AutoUpgradeMinorVersion,
-                ForceUpdateTag = ext.ForceUpdateTag
+                ForceUpdateTag = ext.ForceUpdateTag,
+                EnableAutomaticUpgrade = ext.EnableAutomaticUpgrade
             };
 
             return result;

src/Compute/Compute/Models/PSVirtualMachineExtension.cs

@@ -17,8 +17,8 @@ Adds an extension to the VMSS.
 Add-AzVmssExtension [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Name] <String>]
  [[-Publisher] <String>] [[-Type] <String>] [[-TypeHandlerVersion] <String>]
  [[-AutoUpgradeMinorVersion] <Boolean>] [[-Setting] <Object>] [[-ProtectedSetting] <Object>]
- [-ForceUpdateTag <String>] [-ProvisionAfterExtension <String[]>] [-DefaultProfile <IAzureContextContainer>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-EnableAutomaticUpgrade <Boolean>] [-ForceUpdateTag <String>] [-ProvisionAfterExtension <String[]>]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -77,6 +77,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -EnableAutomaticUpgrade
+Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
+
+```yaml
+Type: System.Nullable`1[System.Boolean]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ForceUpdateTag
 If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
 

src/Compute/Compute/help/Add-AzVmssExtension.md

@@ -17,16 +17,18 @@ Updates extension properties or adds an extension to a virtual machine.
 ```
 Set-AzVMExtension -Publisher <String> -ExtensionType <String> [-Settings <Hashtable>]
  [-ProtectedSettings <Hashtable>] [-AsJob] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>]
- [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>]
- [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion]
+ [-EnableAutomaticUpgrade <Boolean>] [-ForceRerun <String>] [-NoWait]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### SettingString
 ```
 Set-AzVMExtension -Publisher <String> -ExtensionType <String> [-SettingString <String>]
  [-ProtectedSettingString <String>] [-AsJob] [-ResourceGroupName] <String> [-VMName] <String> [-Name <String>]
- [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion] [-ForceRerun <String>]
- [-NoWait] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-TypeHandlerVersion <String>] [-Location <String>] [-DisableAutoUpgradeMinorVersion]
+ [-EnableAutomaticUpgrade <Boolean>] [-ForceRerun <String>] [-NoWait]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -106,6 +108,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -EnableAutomaticUpgrade
+Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
+
+```yaml
+Type: System.Nullable`1[System.Boolean]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ExtensionType
 Specifies the extension type.
 

src/Compute/Compute/help/Set-AzVMExtension.md

@@ -55,7 +55,8 @@ This command reimages the VMSS named ContosoVMSS that belongs to the resource gr
 
 Sets specific actions on a specified VMSS. (autogenerated)
 
-```powershell <!-- Aladdin Generated Example --> 
+```powershell
+<!-- Aladdin Generated Example --> 
 Set-AzVmss -ReimageAll -ResourceGroupName 'ContosoGroup' -VMScaleSetName 'ContosoVMSS'
 ```