Merge pull request #8816 from niander/setVMCSEParameterSets

Add new parameter sets to Set-AzVMCustomScriptExtension with piping for resource id, resource and top level resource objects

Author: Maddie Clayton

documentation/development-docs/azure-powershell-developer-guide.md

@@ -260,6 +260,9 @@ Please see our guide on [Using Azure TestFramework](../testing-docs/using-azure-
     - Use `Assert-NotNull object` to verify that an object is not null
     - Use `Assert-Exists path` to verify that a file exists
     - Use `Assert-AreEqualArray a1 a2` to verify that arrays are the same
+    - Use `Assert-StartsWith s1 s2` to verify that the string `s2` starts with the string `s1`
+    - Use `Assert-Match s1 s2` to verify that the string `s2` matches the regular expression `s1`
+    - Use `Assert-NotMatch s1 s2` to verify that the string `s2` does not match the regular expression `s1`
 
 ### Using Active Directory
 

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

@@ -45,6 +45,13 @@ public void TestVirtualMachineCustomScriptExtension()
             TestRunner.RunTestScript("Test-VirtualMachineCustomScriptExtension");
         }
 
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestVirtualMachineCustomScriptExtensionPiping()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineCustomScriptExtensionPiping");
+        }
+
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestVirtualMachineCustomScriptExtensionWrongStorage()

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

@@ -483,6 +483,72 @@ function Test-VirtualMachineCustomScriptExtension
     }
 }
 
+function Test-VirtualMachineCustomScriptExtensionPiping
+{
+    # 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;
+
+        Assert-NotNull $cseobject;
+        Assert-Match $runname $cseobject.CommandToExecute;
+
+        # Parameter set InputObject
+        $argument = "-NonInteractive";
+        $cseobject | Set-AzVMCustomScriptExtension -Argument $argument;
+        $cseobject = Get-AzVMCustomScriptExtension -ResourceGroupName $rgname -VMName $vmname -Name $csename;
+
+        Assert-NotNull $cseobject;
+        Assert-Match $runname $cseobject.CommandToExecute;
+        Assert-Match $argument $cseobject.CommandToExecute;
+
+        # Parameter set ResourceId
+        Set-AzVMCustomScriptExtension -ResourceId $cseobject.Id -Location $loc `
+            -FileUri $fileUri -Run $runname;
+        $cseobject = Get-AzVMCustomScriptExtension -ResourceGroupName $rgname -VMName $vmname -Name $csename;
+
+        Assert-NotNull $cseobject;
+        Assert-Match $runname $cseobject.CommandToExecute;
+        Assert-NotMatch $argument $cseobject.CommandToExecute;
+
+
+        # Parameter set TopLevelResourceObject
+        $vmobject | Set-AzVMCustomScriptExtension -Name $csename -Location $loc `
+            -FileUri $fileUri -Run $runname -Argument $argument;
+        $cseobject = Get-AzVMCustomScriptExtension -ResourceGroupName $rgname -VMName $vmname -Name $csename;
+
+        Assert-NotNull $cseobject;
+        Assert-Match $runname $cseobject.CommandToExecute;
+        Assert-Match $argument $cseobject.CommandToExecute;
+    }
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname
+    }
+}
+
 <#
 .SYNOPSIS
 Test Virtual Machine Custom Script Extensions with wrong storage account name

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

@@ -21,6 +21,9 @@
 ## Upcoming Release
 * Fix issue with path resolution in Get-AzVmBootDiagnosticsData
 * Update Compute client library to 25.0.0.
+* Add new parameter sets to Set-AzVMCustomScriptExtension
+    - Accepts PSVirtualMachine object from pipeline
+    - Accepts Resource Id and a VirtualMachineCustomScriptExtensionContext also from pipeline
 
 ## Version 1.5.0
 * Add wildcard support to Get cmdlets