Az.Compute - MSP AddProxyAgentExtension parameter (#28634)

Author: ookoka

src/Compute/Compute.Test/ScenarioTests/VirtualMachineScaleSetTests.cs

@@ -479,5 +479,12 @@ public void TestProxyAgentSetting()
         {
             TestRunner.RunTestScript("Test-ProxyAgentSetting");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestVirtualMachineScaleSetAddProxyAgentExtension()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineScaleSetAddProxyAgentExtension");
+        }
     }
 }

src/Compute/Compute.Test/ScenarioTests/VirtualMachineScaleSetTests.ps1

@@ -5965,4 +5965,54 @@ function Test-ProxyAgentSetting
         # Cleanup
         Clean-ResourceGroup $rgname;
     }
+}
+
+<#
+.SYNOPSIS
+Test-VirtualMachineScaleSetAddProxyAgentExtension creates a VMSS with Enabled ProxyAgent and added ProxyAgentExtension
+#>
+function Test-VirtualMachineScaleSetAddProxyAgentExtension
+{
+    # Setup
+    $rgname = Get-ComputeTestResourceName;
+    $loc = "eastus2";
+
+    
+    try
+    {
+        # Common
+        New-AzResourceGroup -Name $rgname -Location $loc -Force;
+
+        $vmssName = 'vmss' + $rgname;
+        $domainNameLabel1 = "d1" + $rgname;
+        
+        $adminUsername = Get-ComputeTestResourceName;
+        $password = Get-PasswordForVM;
+        $adminPassword = $password | ConvertTo-SecureString -AsPlainText -Force;
+        $cred = New-Object System.Management.Automation.PSCredential ($adminUsername, $adminPassword);
+        $linuxImage = "Canonical:0001-com-ubuntu-server-jammy:22_04-lts:latest"
+
+        # Case 1: Create using simple parameter set
+        $vmss = New-AzVmss -ResourceGroupName $rgname -Location $loc -Credential $cred -VMScaleSetName $vmssName -DomainNameLabel $domainNameLabel1 -Image $linuxImage -EnableProxyAgent -AddProxyAgentExtension
+
+        # verify
+        Assert-AreEqual $vmss.VirtualMachineProfile.SecurityProfile.ProxyAgentSettings.Enabled $true
+
+
+        # Update vmss to add proxy agent extension 
+        $VMSS = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName
+        $VMSS = Set-AzVmssProxyAgentSetting -VirtualMachineScaleSet $VMSS -EnableProxyAgent $true -AddProxyAgentExtension $false
+        $vmssUpdated = Update-AzVmss -ResourceGroupName $rgname -Name $vmssName -VirtualMachineScaleSet $VMSS
+
+        
+
+        # Validate 
+        Assert-AreEqual $vmssUpdated.VirtualMachineProfile.SecurityProfile.ProxyAgentSettings.Enabled $true
+        Assert-AreEqual $vmssUpdated.VirtualMachineProfile.SecurityProfile.ProxyAgentSettings.AddProxyAgentExtension $false
+    }
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname;
+    }
 }

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

@@ -682,11 +682,19 @@ public void TestEncryptionIdentityNotPartOfAssignedIdentitiesInAzureVm()
         {
             TestRunner.RunTestScript("Test-EncryptionIdentityNotPartOfAssignedIdentitiesInAzureVm");
         }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestVirtualMachinePlacement()
         {
             TestRunner.RunTestScript("Test-VirtualMachinePlacement");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestVirtualMachineAddProxyAgentExtension()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineAddProxyAgentExtension");
+        }
     }
 }

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

@@ -7915,7 +7915,7 @@ function Test-VirtualMachinePlacement
         $user = Get-ComputeTestResourceName;
         $cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
 
-        # create VM with placement feature 
+        # create VM with placement feature
         $vmname = '1' + $rgname;
         $domainNameLabel = "d1" + $rgname;
         $vm = New-AzVM -ResourceGroupName $rgname -Name $vmname -Credential $cred -Image CentOS85Gen2 -DomainNameLabel $domainNameLabel -ZonePlacementPolicy "Any" -IncludeZone "1","2" -AlignRegionalDisksToVMZone
@@ -7938,4 +7938,40 @@ function Test-VirtualMachinePlacement
         # Cleanup
         Clean-ResourceGroup $rgname;
     }
-}
+}
+
+<#
+.SYNOPSIS
+Test-VirtualMachineAddProxyAgentExtension creates a VM with Enabled ProxyAgent and added ProxyAgentExtension
+#>
+function Test-VirtualMachineAddProxyAgentExtension
+{
+    # Setup
+    $resourceGroupName = Get-ComputeTestResourceName;
+    $adminUsername = Get-ComputeTestResourceName;
+    $adminPassword = Get-PasswordForVM | ConvertTo-SecureString -AsPlainText -Force;
+    $cred = New-Object System.Management.Automation.PSCredential ($adminUsername, $adminPassword);
+    $vmName = 'VM1';
+    $imageName = "Canonical:0001-com-ubuntu-server-jammy:22_04-lts:latest";
+    $domainNameLabel = "d1" + $resourceGroupName;
+
+
+    try
+    {
+        New-AzVM -ResourceGroupName $resourceGroupName -Name $VMName -Credential $cred -image $imageName -DomainNameLabel $domainNameLabel -Location 'eastus2' -EnableProxyAgent -AddProxyAgentExtension
+
+        # Update vm to add proxy agent extension 
+        $VM = Get-AzVM -ResourceGroupName $resourceGroupName -VMName $vmName
+        $VM = Set-AzVMProxyAgentSetting -VM $VM -EnableProxyAgent $true -AddProxyAgentExtension $false
+        Update-AzVM -ResourceGroupName $resourceGroupName -VM $VM
+
+        # Validate 
+        Assert-AreEqual $VM.SecurityProfile.ProxyAgentSettings.Enabled $true
+        Assert-AreEqual $VM.SecurityProfile.ProxyAgentSettings.AddProxyAgentExtension $false
+    }
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $resourceGroupName;
+    }
+}

src/Compute/Compute.Test/SessionRecords/Microsoft.Azure.Commands.Compute.Test.ScenarioTests.VirtualMachineScaleSetTests/TestVirtualMachineScaleSetAddProxyAgentExtension.json

@@ -21,6 +21,9 @@
 -->
 ## Upcoming Release
 * Added `-Redeploy` switch parameter for `Update-AzHost` cmdlet to enable dedicated host redeployment.
+* ComputeRP related cmdlets will now use 2025-04-01 version of the ComputeRP API.
+* Added `-AddProxyAgentExtension` parameter (Switch) to `New-AzVmss` and `New-AzVM`
+* Added `-AddProxyAgentExtension` parameter (Bool) to `Set-AzVMProxyAgentSetting` and  `Set-AzVmssProxyAgentSetting`
 
 ## Version 10.4.0
 * Added `-InstantAccessDurationMinutes` parameter to New-AzSnapshotConfig.

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

@@ -69,6 +69,12 @@ public class SetAzureVmssProxySetting : Microsoft.Azure.Commands.ResourceManager
             HelpMessage = "Specifies the InVMAccessControlProfileVersion resource id in the IMDS enpoint. Format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}")]
         public string ImdsProfile { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os.")]
+        public bool? AddProxyAgentExtension { get; set; }
+
         public override void ExecuteCmdlet()
         {
             if (this.VirtualMachineScaleSet.VirtualMachineProfile == null)
@@ -96,6 +102,11 @@ public override void ExecuteCmdlet()
                 })
             };
 
+            if (this.MyInvocation.BoundParameters.ContainsKey(nameof(AddProxyAgentExtension)))
+            {
+                this.VirtualMachineScaleSet.VirtualMachineProfile.SecurityProfile.ProxyAgentSettings.AddProxyAgentExtension = this.AddProxyAgentExtension;
+            }
+
             WriteObject(this.VirtualMachineScaleSet);
         }
     }

src/Compute/Compute/ChangeLog.md

@@ -20,5 +20,9 @@ public partial class PSVirtualMachineScaleSet
     {
         // Gets or sets the FQDN.
         public string FullyQualifiedDomainName { get; set; }
+
+        // Gets or sets the AddProxyAgentExtension.
+        public bool? AddProxyAgentExtension { get; set; }
+
     }
 }

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

@@ -41,5 +41,6 @@ public class PSVirtualMachineScaleSetVMProfile
         public PSApplicationProfile ApplicationProfile { get; set; }
         public SecurityPostureReference SecurityPostureReference { get; set; }
         public System.DateTime? TimeCreated { get; private set; }
+        public bool? AddProxyAgentExtension { get; set; }
     }
 }