Add ResourceId parameter to the Get-AzVmss cmdlet (#21922)

* all work

* examp cleanup

* ex

* ex clean

* test fix

* clean

* clean

Author: Sandido

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

@@ -318,5 +318,12 @@ public void TestVirtualMachineScaleSetOSImageScheduledEvents()
         {
             TestRunner.RunTestScript("Test-VirtualMachineScaleSetOSImageScheduledEvents");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void TestVirtualMachineScaleSetGetById()
+        {
+            TestRunner.RunTestScript("Test-VirtualMachineScaleSetGetById");
+        }
     }
 }

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

@@ -4363,3 +4363,42 @@ function Test-VirtualMachineScaleSetOSImageScheduledEvents
         Clean-ResourceGroup $rgname;
     }
 }
+
+<#
+.SYNOPSIS
+Test the Get-AzVmss ResourceId parameter set. 
+This uses an ARM Resource Id to get an existing Vmss. 
+#>
+function Test-VirtualMachineScaleSetGetById
+{
+
+    # Setup
+    $rgname = Get-ComputeTestResourceName;
+    $loc = Get-ComputeVMLocation;
+
+    try
+    {
+        New-AzResourceGroup -Name $rgname -Location $loc -Force;
+        
+        $vmssSize = 'Standard_D4s_v3';
+        $vmssName1 = 'vmss1' + $rgname;
+        $imageName = "Win2019Datacenter";
+        $domainNameLabel = "d1" + $rgname;
+        $adminUsername = Get-ComputeTestResourceName;
+        $adminPassword = Get-PasswordForVM | ConvertTo-SecureString -AsPlainText -Force;
+        $vmCred = New-Object System.Management.Automation.PSCredential($adminUsername, $adminPassword);
+
+        $result = New-AzVmss -ResourceGroupName $rgname -Credential $vmCred -VMScaleSetName $vmssName1 -ImageName $imageName -DomainNameLabel $domainNameLabel ;
+
+        $vmss = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName1;
+        $vmssId = $vmss.Id;
+        $vmssGet = Get-AzVmss -ResourceId $vmssId;
+        
+        Assert-AreEqual $vmss.Id $vmssGet.Id;
+    } 
+    finally
+    {
+        # Cleanup
+        Clean-ResourceGroup $rgname;
+    }
+}

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

@@ -21,6 +21,7 @@
 -->
 ## Upcoming Release
 * Added useful examples to the `New-AzVMConfig` help doc.
+* Added new `ResourceId` parameter to the `Get-AzVmss` cmdlet. 
 
 ## Version 6.0.0
 * Added new switch parameter `OSImageScheduledEventEnabled` and string parameter `OSImageScheduledEventNotBeforeTimeoutInMinutes` to the cmdlets `New-AzVmssConfig` and `Update-AzVmss`.

src/Compute/Compute/ChangeLog.md

@@ -28,6 +28,7 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Management.Compute;
 using Microsoft.Azure.Management.Compute.Models;
+using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 
 namespace Microsoft.Azure.Commands.Compute.Automation
@@ -36,9 +37,7 @@ namespace Microsoft.Azure.Commands.Compute.Automation
     [OutputType(typeof(PSVirtualMachineScaleSet))]
     public partial class GetAzureRmVmss : ComputeAutomationBaseCmdlet
     {
-        protected const string DefaultParameter = "DefaultParameter";
-        protected const string FriendMethod = "FriendMethod";
-        protected const string OSUpgradeHistoryMethodParameter = "OSUpgradeHistoryMethodParameter";
+        protected const string DefaultParameter = "DefaultParameter", ResourceIdParameterSet = "ResourceIdParameterSet", FriendMethod = "FriendMethod", OSUpgradeHistoryMethodParameter = "OSUpgradeHistoryMethodParameter";
         private string UserDataExpand = ExpandTypesForGetVMScaleSets.UserData;
 
         public override void ExecuteCmdlet()
@@ -118,6 +117,17 @@ public override void ExecuteCmdlet()
                     }
                     WriteObject(TopLevelWildcardFilter(resourceGroupName, vmScaleSetName, psObject), true);
                 }
+                else if (this.ParameterSetName.Equals(ResourceIdParameterSet))
+                {
+                    ResourceIdentifier identifier = new ResourceIdentifier(this.ResourceId);
+                    resourceGroupName = identifier.ResourceGroupName;
+                    vmScaleSetName = identifier.ResourceName;
+
+                    var result = VirtualMachineScaleSetsClient.Get(resourceGroupName, vmScaleSetName);
+                    var psObject = new PSVirtualMachineScaleSet();
+                    ComputeAutomationAutoMapperProfile.Mapper.Map<VirtualMachineScaleSet, PSVirtualMachineScaleSet>(result, psObject);
+                    WriteObject(psObject);
+                }
                 else
                 {
                     var result = VirtualMachineScaleSetsClient.ListAll();
@@ -144,13 +154,31 @@ public override void ExecuteCmdlet()
 
         [Parameter(
             Position = 0,
+            ParameterSetName = DefaultParameter,
+            ValueFromPipelineByPropertyName = true)]
+        [Parameter(
+            Position = 0,
+            ParameterSetName = FriendMethod,
+            ValueFromPipelineByPropertyName = true)]
+        [Parameter(
+            Position = 0,
+            ParameterSetName = OSUpgradeHistoryMethodParameter,
             ValueFromPipelineByPropertyName = true)]
         [ResourceGroupCompleter]
         [SupportsWildcards]
         public string ResourceGroupName { get; set; }
 
         [Parameter(
             Position = 1,
+            ParameterSetName = DefaultParameter,
+            ValueFromPipelineByPropertyName = true)]
+            [Parameter(
+            Position = 1,
+            ParameterSetName = FriendMethod,
+            ValueFromPipelineByPropertyName = true)]
+        [Parameter(
+            Position = 1,
+            ParameterSetName = OSUpgradeHistoryMethodParameter,
             ValueFromPipelineByPropertyName = true)]
         [ResourceNameCompleter("Microsoft.Compute/virtualMachineScaleSets", "ResourceGroupName")]
         [SupportsWildcards]
@@ -173,5 +201,12 @@ public override void ExecuteCmdlet()
             HelpMessage = "UserData for the Vmss, which will be Base64 encoded. Customer should not pass any secrets in here.",
             ValueFromPipelineByPropertyName = true)]
         public SwitchParameter UserData { get; set; }
+
+        [Parameter(
+            ParameterSetName = ResourceIdParameterSet,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The ARM resource id specifying the specific virtual machine scale set to return.")]
+        [ValidateNotNullOrEmpty]
+        public string ResourceId { get; set; }
     }
 }

src/Compute/Compute/Generated/VirtualMachineScaleSet/VirtualMachineScaleSetGetMethod.cs

@@ -31,6 +31,11 @@ Get-AzVmss [[-ResourceGroupName] <String>] [[-VMScaleSetName] <String>] [-OSUpgr
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
+### ResourceIdParameterSet
+```
+Get-AzVmss [-ResourceId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
+```
+
 ## DESCRIPTION
 The **Get-AzVmss** cmdlet gets the model and instance view of a Virtual Machine Scale Set (VMSS).
 The model view is the user specified properties of the virtual machine scale set.
@@ -240,6 +245,28 @@ VirtualMachineProfile                       :
 
 The UserData value must be Base64 encoded. This command assumes you have created a Vmss with a UserData value. 
 
+### Example 6: Get a Virtual Machine Scale Set via its ResourceId.
+```powershell
+$rgname = "ResourceGroupName";
+$loc = "eastus";
+New-AzResourceGroup -Name $rgname -Location $loc;
+
+$vmssSize = 'Standard_D4s_v3';
+$vmssName1 = 'vmss1' + $rgname;
+$imageName = "Win2019Datacenter";
+$adminUsername = <Username>;
+$adminPassword = <Password> | ConvertTo-SecureString -AsPlainText -Force;
+$cred = New-Object System.Management.Automation.PSCredential($adminUsername, $adminPassword);
+
+$result = New-AzVmss -ResourceGroupName $rgname -Credential $cred -VMScaleSetName $vmssName1 -ImageName $imageName;
+
+$vmss = Get-AzVmss -ResourceGroupName $rgname -VMScaleSetName $vmssName1;
+$vmssId = $vmss.Id;
+$vmssGet = Get-AzVmss -ResourceId $vmssId;
+```
+
+Make a Vmss then get that same Vmss via its ARM resource Id. 
+
 ## PARAMETERS
 
 ### -DefaultProfile
@@ -292,7 +319,7 @@ Specifies the name of the Resource Group of the VMSS.
 
 ```yaml
 Type: System.String
-Parameter Sets: (All)
+Parameter Sets: DefaultParameter, FriendMethod, OSUpgradeHistoryMethodParameter
 Aliases:
 
 Required: False
@@ -302,6 +329,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: True
 ```
 
+### -ResourceId
+The ARM resource id specifying the specific virtual machine scale set object you want returned.
+
+```yaml
+Type: System.String
+Parameter Sets: ResourceIdParameterSet
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
 ### -UserData
 UserData for the Vmss, which will be base-64 encoded. Customer should not pass any secrets in here.
 
@@ -322,7 +364,7 @@ Species the name of the VMSS.
 
 ```yaml
 Type: System.String
-Parameter Sets: (All)
+Parameter Sets: DefaultParameter, FriendMethod, OSUpgradeHistoryMethodParameter
 Aliases: Name
 
 Required: False