Returning Substatuses from Get-AzVMCustomScriptExtension (#12089)

* Mapping Substatus to VirtualMachineCustomScriptExtensionContext

* Updating changelog.md

* Update ChangeLog.md

* Adding testcase for substatuses check

* Correcting name

* Update ChangeLog.md

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

Author: haagha

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

@@ -87,6 +87,14 @@ public void TestVirtualMachineCustomScriptExtensionManagedDisk()
             TestRunner.RunTestScript("Test-VirtualMachineCustomScriptExtensionManagedDisk");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestVirtualMachineCustomScriptExtensionSubstatuses()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineCustomScriptExtensionSubstatuses");
+        }
+
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestVirtualMachineAccessExtension()

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

@@ -1177,6 +1177,49 @@ function Test-VirtualMachineCustomScriptExtensionManagedDisk
     }
 }
 
+<#
+.SYNOPSIS
+Test Virtual Machine Custom Script Extensions return Substatuses
+#>
+function Test-VirtualMachineCustomScriptExtensionSubstatuses
+{
+    # Setup
+    $rgname = Get-ComputeTestResourceName
+
+    try
+    {
+        # Common
+        $loc = Get-ComputeVMLocation;
+        New-AzResourceGroup -Name $rgname -Location $loc -Force;
+
+        $vmname = 'vm' + $rgname;
+        $user = "Foo12";
+        $password = $PLACEHOLDER;
+        $securePassword = ConvertTo-SecureString $password -AsPlainText -Force;
+        $cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
+        [string]$domainNameLabel = "$vmname-$vmname".tolower();
+        $vmobject = New-AzVm -Name $vmname -ResourceGroupName $rgname -Credential $cred -DomainNameLabel $domainNameLabel;
+
+        $csename = "myCustomExtension";
+        $fileUri = "https://raw.githubusercontent.com/neilpeterson/nepeters-azure-templates/master/windows-custom-script-simple/support-scripts/Create-File.ps1";
+        $runname = "Create-File.ps1";
+
+        # Parameter set interactive
+        Set-AzVMCustomScriptExtension -ResourceGroupName $rgname -VMName $vmname -Name $csename `
+            -Location $loc -FileUri $fileUri -Run $runname;
+        $cseobject = Get-AzVMCustomScriptExtension -ResourceGroupName $rgname -VMName $vmname -Name $csename -Status;
+
+        Assert-NotNull $cseobject;
+        Assert-NotNull $cseobject.SubStatuses;
+        Assert-Match $runname $cseobject.CommandToExecute;
+
+    }
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname
+    }
+}
 <#
 .SYNOPSIS
 Test Virtual Machine Access Extensions

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

@@ -19,9 +19,10 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
-* Added SimulateEviction parameter to `Set-AzVM` and `Set-AzVmssVM` cmdlets.
-* Added 'Premium_LRS' to the argument completer of StorageAccountType parameter for `New-AzGalleryImageVersion` cmdlet.
-* Added 'Delete' to the argument completer of EvictionPolicy parameter for `New-AzVM` and `New-AzVMConfig` cmdlets.
+* Added SimulateEviction parameter to Set-AzVM and Set-AzVmssVM cmdlets.
+* Added 'Premium_LRS' to the argument completer of StorageAccountType parameter for New-AzGalleryImageVersion cmdlet.
+* Added Substatuses to VMCustomScriptExtension [#11297]
+* Added 'Delete' to the argument completer of EvictionPolicy parameter for New-AzVM and New-AzVMConfig cmdlets.
 * Fixed name of new VM Extension for SAP
 
 ## Version 4.1.0

src/Compute/Compute/ChangeLog.md

@@ -42,6 +42,7 @@ public VirtualMachineCustomScriptExtensionContext(PSVirtualMachineExtension psEx
             ProtectedSettings = psExt.ProtectedSettings;
             ProvisioningState = psExt.ProvisioningState;
             Statuses = psExt.Statuses;
+            SubStatuses = psExt.SubStatuses;
             CommandToExecute = (publicSettings == null) ? null : publicSettings.commandToExecute;
         }
     }