Deprecate a parameter set for Get-AzVMSize (#27687)

Author: grizzlytheodore

src/Compute/Compute.Test/ScenarioTests/ComputeTestCommon.ps1

@@ -466,8 +466,11 @@ Gets default VM size string
 function Get-DefaultVMSize
 {
     param([string] $location = "westus")
-
-    $vmSizes = Get-AzVMSize -Location $location | where { $_.NumberOfCores -ge 4 -and $_.MaxDataDiskCount -ge 8 };
+    $vmSizes = Get-AzComputeResourceSku -Location $location | Where-Object {
+        $_.ResourceType -eq "virtualMachines" -and
+        ([int]($_.Capabilities | Where-Object { $_.Name -eq "vCPUs" }).Value) -ge 4 -and
+        ([int]($_.Capabilities | Where-Object { $_.Name -eq "MaxDataDiskCount" }).Value) -ge 8
+    }
 
     foreach ($sz in $vmSizes)
     {

src/Compute/Compute.Test/ScenarioTests/VMDynamicTests.ps1

@@ -42,7 +42,11 @@ function get_all_standard_vm_sizes
 
     $st = Write-Verbose "Getting all VM sizes in location '${location}' - Start";
 
-    $vmsizes = Get-AzVMSize -Location $location | where { $_.Name -like 'Standard_A*' -and $_.NumberOfCores -le 4 } | select -ExpandProperty Name;
+    $vmsizes = Get-AzComputeResourceSku -Location $location | Where-Object {
+        $_.Name -like 'Standard_A*' -and
+        ([int]($_.Capabilities | Where-Object { $_.Name -eq "vCPUs" }).Value) -le 4
+    } | Select-Object -ExpandProperty Name
+
 
     $st = Write-Verbose "Getting all VM sizes in location [${location}] - End";
 

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

@@ -164,13 +164,6 @@ public void TestVMImageEdgeZoneCmdletOutputFormat()
             TestRunner.RunTestScript("Test-VMImageEdgeZoneCmdletOutputFormat");
         }
 
-        [Fact]
-        [Trait(Category.AcceptanceType, Category.CheckIn)]
-        public void TestGetVMSizeFromAllLocations()
-        {
-            TestRunner.RunTestScript("Test-GetVMSizeFromAllLocations");
-        }
-
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestVirtualMachineListWithPaging()

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

@@ -915,12 +915,13 @@ function Test-VirtualMachineSizeAndUsage
         Assert-AreEqual $vm.StorageProfile.DataDisks[1].Lun 2;
         Assert-AreEqual $vm.StorageProfile.DataDisks[1].Vhd.Uri $dataDiskVhdUri2;
 
-        # Test Sizes
-        $s1 = Get-AzVMSize -Location ($loc -replace ' ');
-        Assert-NotNull $s1;
-        Assert-NotNull $s1.RequestId;
-        Assert-NotNull $s1.StatusCode;
-        Validate-VirtualMachineSize $vmsize $s1;
+        # Test Sizes 
+        # CASE 1: List Virtual Machine Sizes parameter set deprecated 
+        # s1 = Get-AzVMSize -Location ($loc -replace ' ');
+        # Assert-NotNull $s1;
+        # Assert-NotNull $s1.RequestId;
+        # Assert-NotNull $s1.StatusCode;
+        # Validate-VirtualMachineSize $vmsize $s1;
 
         $s2 = Get-AzVMSize -ResourceGroupName $rgname -VMName $vmname;
         Assert-NotNull $s2;
@@ -2168,20 +2169,6 @@ function Test-VMImageEdgeZoneCmdletOutputFormat
     Assert-OutputContains " Get-AzVMImage -Location '$locStr' -EdgeZone '$edgeZone' -PublisherName $publisher -Offer $offer -Skus $sku -Version $ver " @('Id', 'Location', 'PublisherName', 'Offer', 'Sku', 'Version', 'Name', 'DataDiskImages', 'OSDiskImage', 'PurchasePlan');
 }
 
-# Test Get VM Size from All Locations
-function Test-GetVMSizeFromAllLocations
-{
-    $locations = get_all_vm_locations;
-    foreach ($loc in $locations)
-    {
-        $vmsizes = Get-AzVMSize -Location $loc;
-        Assert-True { $vmsizes.Count -gt 0 }
-        Assert-True { ($vmsizes | where { $_.Name -eq 'Standard_A3' }).Count -eq 1 }
-
-        Write-Output ('Found VM Size Standard_A3 in Location: ' + $loc);
-    }
-}
-
 function get_all_vm_locations
 {
     if ((Get-ComputeTestMode) -ne 'Playback')

src/Compute/Compute/ChangeLog.md

@@ -20,6 +20,7 @@
 
 -->
 ## Upcoming Release
+* Deprecated `Get-AzVMSize` 'List Virtual Machine Size' parameter set. 
 * Added new parameters `EnableAutomaticZoneRebalance`, `AutomaticZoneRebalanceStrategy` and `AutomaticZoneRebalanceBehavior` to `New-AzVmssConfig` and `Update-AzVmss` cmdlets for VMSS Automatic Zone Rebalancing. 
 
 ## Version 9.3.0

src/Compute/Compute/VirtualMachineSizes/GetAzureVMSizeCommand.cs

@@ -24,25 +24,13 @@
 
 namespace Microsoft.Azure.Commands.Compute
 {
-    [GenericBreakingChangeWithVersion("The \"ListVirtualMachineSize\" parameter set will be deprecated as its API: \"Virtual Machine Sizes - List\" is deprecated. For listing available VM sizes by subscription or location, please use instead \"Get-AzComputeResourceSku\". Other parameter sets: \"List Available Sizes for Availability Set\" and \"List Available Sizes for Virtual Machine\" will continue to be supported.", "14.0.0", "10.0.0")]
-    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VMSize", DefaultParameterSetName = ListVirtualMachineSizeParamSet)]
+    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VMSize", DefaultParameterSetName = ListAvailableSizesForVirtualMachine)]
     [OutputType(typeof(PSVirtualMachineSize))]
     public class GetAzureVMSizeCommand : VirtualMachineSizeBaseCmdlet
     {
-        protected const string ListVirtualMachineSizeParamSet = "ListVirtualMachineSizeParamSet";
         protected const string ListAvailableSizesForAvailabilitySet = "ListAvailableSizesForAvailabilitySet";
         protected const string ListAvailableSizesForVirtualMachine = "ListAvailableSizesForVirtualMachine";
 
-        [Parameter(
-           Mandatory = true,
-           Position = 0,
-           ParameterSetName = ListVirtualMachineSizeParamSet,
-           ValueFromPipelineByPropertyName = true,
-           HelpMessage = "The location name.")]
-        [LocationCompleter("Microsoft.Compute/locations/vmSizes")]
-        [ValidateNotNullOrEmpty]
-        public string Location { get; set; }
-
         [Parameter(
            Mandatory = true,
            Position = 0,
@@ -93,16 +81,12 @@ public override void ExecuteCmdlet()
                         this.ResourceGroupName,
                         this.VMName).GetAwaiter().GetResult();
                 }
-                else if (!string.IsNullOrEmpty(this.AvailabilitySetName))
+                else
                 {
                     result = this.AvailabilitySetClient.ListAvailableSizesWithHttpMessagesAsync(
                         this.ResourceGroupName,
                         this.AvailabilitySetName).GetAwaiter().GetResult();
                 }
-                else
-                {
-                    result = this.VirtualMachineSizeClient.ListWithHttpMessagesAsync(this.Location.Canonicalize()).GetAwaiter().GetResult();
-                }
 
                 List<PSVirtualMachineSize> psResultList = new List<PSVirtualMachineSize>();
                 foreach (var item in result.Body)

src/Compute/Compute/help/Get-AzComputeResourceSku.md

@@ -29,6 +29,45 @@ Get-AzComputeResourceSku "westus";
 
 List all compute resource skus in West US region
 
+### Example 2
+```powershell
+Get-AzComputeResourceSku -Location "westus" | Where-Object {
+    $_.Name -like 'Standard_A*' -and
+    ([int]($_.Capabilities | Where-Object { $_.Name -eq 'vCPUs' }).Value) -le 4
+} | Select-Object -ExpandProperty Name
+```
+```output
+Standard_A0
+Standard_A1
+Standard_A1_v2
+Standard_A2
+Standard_A2m_v2
+Standard_A2_v2
+Standard_A3
+Standard_A4m_v2
+Standard_A4_v2
+Standard_A5
+Standard_A6
+```
+
+Get all compute resource skus in West US region, filter by name and vCPUs capability, and select the name property.
+
+### Example 3
+```powershell
+$vmSizes = Get-AzComputeResourceSku -Location "WestUS" | Where-Object {
+    $_.ResourceType -eq "virtualMachines" -and
+    ([int]($_.Capabilities | Where-Object { $_.Name -eq "vCPUs" }).Value) -ge 4 -and
+    ([int]($_.Capabilities | Where-Object { $_.Name -eq "MaxDataDiskCount" }).Value) -ge 8
+}
+$vmSizes.count
+```
+
+```output
+812
+```
+
+Get all compute resource skus in West US region, filter by resource type, vCPUs capability, and MaxDataDiskCount capability, and count the number of results.
+
 ## PARAMETERS
 
 ### -DefaultProfile

src/Compute/Compute/help/Get-AzVMSize.md

@@ -11,13 +11,11 @@ schema: 2.0.0
 ## SYNOPSIS
 Gets available virtual machine sizes.
 
-**Note**: The **List Virtual Machine Size** parameter set will be deprecated in the next major release (14.0.0) as its API: [Virtual Machine Sizes - List](https://learn.microsoft.com/en-us/rest/api/compute/virtual-machine-sizes/list) is deprecated. For listing available VM sizes by subscription or location, please use instead [Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku). Other parameter sets: "List Available Sizes for Availability Set" and "List Available Sizes for Virtual Machine" will continue to be supported.
-
 ## SYNTAX
 
-### ListVirtualMachineSizeParamSet (Default)
+### ListAvailableSizesForVirtualMachine (Default)
 ```
-Get-AzVMSize [-Location] <String> [-DefaultProfile <IAzureContextContainer>]
+Get-AzVMSize [-ResourceGroupName] <String> [-VMName] <String> [-DefaultProfile <IAzureContextContainer>]
  [<CommonParameters>]
 ```
 
@@ -27,36 +25,22 @@ Get-AzVMSize [-ResourceGroupName] <String> [-AvailabilitySetName] <String>
  [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
-### ListAvailableSizesForVirtualMachine
-```
-Get-AzVMSize [-ResourceGroupName] <String> [-VMName] <String> [-DefaultProfile <IAzureContextContainer>]
- [<CommonParameters>]
-```
-
 ## DESCRIPTION
 The **Get-AzVMSize** cmdlet gets available virtual machine sizes.
 
-**Note**: The **List Virtual Machine Size** parameter set will be deprecated in the next major release (14.0.0) as its API: [Virtual Machine Sizes - List](https://learn.microsoft.com/en-us/rest/api/compute/virtual-machine-sizes/list) is deprecated. For listing available VM sizes by subscription or location, please use instead [Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku). Other parameter sets: "List Available Sizes for Availability Set" and "List Available Sizes for Virtual Machine" will continue to be supported.
+For listing available VM sizes by subscription or location, use instead [Get-AzComputeResourceSku](https://learn.microsoft.com/en-us/powershell/module/az.compute/get-azcomputeresourcesku).
 
 ## EXAMPLES
 
-### Example 1: Get virtual machine sizes for a location
-```powershell
-Get-AzVMSize -Location "Central US"
-```
-
-This command gets the available sizes for virtual machines in the specified location.
-
-**Note**: This parameter set will be deprecated in the next major release. 
 
-### Example 2: Get sizes for an availability set
+### Example 1: Get sizes for an availability set
 ```powershell
 Get-AzVMSize -ResourceGroupName "ResourceGroup03" -AvailabilitySetName "AvailabilitySet17"
 ```
 
 This command gets available sizes for virtual machines that you can deploy in the availability set named AvailabilitySet17.
 
-### Example 3: Get sizes for an existing virtual machine
+### Example 2: Get sizes for an existing virtual machine
 ```powershell
 Get-AzVMSize -ResourceGroupName "ResourceGroup03" -VMName "VirtualMachine12"
 ```
@@ -96,27 +80,12 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Location
-Specifies the location for which this cmdlet gets the available virtual machine sizes.
-
-```yaml
-Type: System.String
-Parameter Sets: ListVirtualMachineSizeParamSet
-Aliases:
-
-Required: True
-Position: 0
-Default value: None
-Accept pipeline input: True (ByPropertyName)
-Accept wildcard characters: False
-```
-
 ### -ResourceGroupName
 Specifies the name of the resource group of the virtual machine.
 
 ```yaml
 Type: System.String
-Parameter Sets: ListAvailableSizesForAvailabilitySet, ListAvailableSizesForVirtualMachine
+Parameter Sets: (All)
 Aliases:
 
 Required: True

tools/StaticAnalysis/Exceptions/Az.Compute/BreakingChangeIssues.csv

@@ -0,0 +1,4 @@
+"Module","ClassName","Target","Severity","ProblemId","Description","Remediation"
+"Az.Compute","Microsoft.Azure.Commands.Compute.GetAzureVMSizeCommand","Get-AzVMSize","0","1060","The parameter set 'ListVirtualMachineSizeParamSet' for cmdlet 'Get-AzVMSize' is no longer the default parameter set.","Change the default parameter for cmdlet 'Get-AzVMSize' back to 'ListVirtualMachineSizeParamSet'."
+"Az.Compute","Microsoft.Azure.Commands.Compute.GetAzureVMSizeCommand","Get-AzVMSize","0","2000","The cmdlet 'Get-AzVMSize' no longer supports the parameter 'Location' and no alias was found for the original parameter name.","Add the parameter 'Location' back to the cmdlet 'Get-AzVMSize', or add an alias to the original parameter name."
+"Az.Compute","Microsoft.Azure.Commands.Compute.GetAzureVMSizeCommand","Get-AzVMSize","0","1050","The parameter set 'ListVirtualMachineSizeParamSet' for cmdlet 'Get-AzVMSize' has been removed.","Add parameter set 'ListVirtualMachineSizeParamSet' back to cmdlet 'Get-AzVMSize'."