Remove unusable NextLink parameter and parameter set from Get-AzVM (#21748)

* all work

* Update ExampleIssues.csv

* Update ExampleIssues.csv

* Update BreakingChangeIssues.csv

* Update GetAzureVMCommand.cs

* Update BreakingChangeIssues.csv

* Update VirtualMachineTests.ps1

* Update GetAzureVMCommand.cs

Remove the breaking change notification

---------

Co-authored-by: Jin Lei <[email protected]>

Author: Sandido

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

@@ -629,7 +629,6 @@ function Test-VirtualMachineList
     {
         Assert-NotNull $s2[0].Id;
     }
-    Assert-ThrowsContains { $s3 = Get-AzVM -NextLink "https://www.test.com/test"; } "Unable to deserialize the response"
 }
 
 <#
@@ -6575,4 +6574,4 @@ function Test-VirtualMachineEdgeZoneSimpleParameterSet
         # Cleanup
         Clean-ResourceGroup $ResourceGroup;
     }
-}
+}

src/Compute/Compute/ChangeLog.md

@@ -22,6 +22,8 @@
 ## Upcoming Release
 * Added new switch parameter `OSImageScheduledEventEnabled` and string parameter `OSImageScheduledEventNotBeforeTimeoutInMinutes` to the cmdlets `New-AzVmssConfig` and `Update-AzVmss`.
 * Fixed an issue that `Add-AzVhd` throws `FileNotFoundException` on Windows PowerShell. [#21321]
+* Removed the `NextLink` parameter and parameter set from the `Get-AzVM` cmdelt.
+
 
 ## Version 5.7.1
 * Added a breaking change warning to the `Get-AzVM` cmdlet to show that the `NextLink` parameter and parameter set will be removed in June 2023. The parameter has been non-functional for a long time. 

src/Compute/Compute/VirtualMachine/Operation/GetAzureVMCommand.cs

@@ -29,14 +29,12 @@
 
 namespace Microsoft.Azure.Commands.Compute
 {
-    [GenericBreakingChange("In the June 2023 Powershell release, the NextLink parameter set will be removed. Powershell by default loops through the list of VMs returned, so the user no longer has to use this parameter set.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "VM", DefaultParameterSetName = DefaultParamSet)]
     [OutputType(typeof(PSVirtualMachine), typeof(PSVirtualMachineInstanceView))]
     public class GetAzureVMCommand : VirtualMachineBaseCmdlet
     {
         protected const string DefaultParamSet = "DefaultParamSet";
         protected const string GetVirtualMachineInResourceGroupParamSet = "GetVirtualMachineInResourceGroupParamSet";
-        protected const string ListNextLinkVirtualMachinesParamSet = "ListNextLinkVirtualMachinesParamSet";
         protected const string ListLocationVirtualMachinesParamSet = "ListLocationVirtualMachinesParamSet";
         protected const string GetVirtualMachineById = "GetVirtualMachineById";
         private const string InfoNotAvailable = "Info Not Available";
@@ -87,14 +85,6 @@ public class GetAzureVMCommand : VirtualMachineBaseCmdlet
         [ValidateNotNullOrEmpty]
         public SwitchParameter Status { get; set; }
 
-        [Parameter(
-            Mandatory = true,
-            Position = 1,
-            ParameterSetName = ListNextLinkVirtualMachinesParamSet,
-            ValueFromPipelineByPropertyName = true)]
-        [ValidateNotNullOrEmpty]
-        public Uri NextLink { get; set; }
-
         [Parameter(
             Mandatory = false,
             ParameterSetName = GetVirtualMachineInResourceGroupParamSet,
@@ -112,11 +102,6 @@ public class GetAzureVMCommand : VirtualMachineBaseCmdlet
             ParameterSetName = GetVirtualMachineInResourceGroupParamSet,
             HelpMessage = "UserData for the VM, which will be Base64 encoded. Customer should not pass any secrets in here.",
             ValueFromPipelineByPropertyName = true)]
-        [Parameter(
-            Mandatory = false,
-            ParameterSetName = ListNextLinkVirtualMachinesParamSet,
-            HelpMessage = "UserData for the VM, which will be Base64 encoded. Customer should not pass any secrets in here.",
-            ValueFromPipelineByPropertyName = true)]
         [Parameter(
             Mandatory = false,
             ParameterSetName = ListLocationVirtualMachinesParamSet,
@@ -153,12 +138,6 @@ public override void ExecuteCmdlet()
                         this.VirtualMachineClient.ListByLocationWithHttpMessagesAsync(this.Location).GetAwaiter().GetResult(),
                         this.VirtualMachineClient.ListByLocationNextWithHttpMessagesAsync);
                 }
-                else if (this.NextLink != null)
-                {
-                    ReturnListVMObject(
-                        this.VirtualMachineClient.ListAllNextWithHttpMessagesAsync(this.NextLink.ToString()).GetAwaiter().GetResult(),
-                        this.VirtualMachineClient.ListAllNextWithHttpMessagesAsync);
-                }
                 else if (ShouldListBySubscription(ResourceGroupName, Name))
                 {
                     ReturnListVMObject(

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

@@ -31,12 +31,6 @@ Get-AzVM -Location <String> [-Status] [-UserData] [-DefaultProfile <IAzureContex
  [<CommonParameters>]
 ```
 
-### ListNextLinkVirtualMachinesParamSet
-```
-Get-AzVM [-Status] [-NextLink] <Uri> [-UserData] [-DefaultProfile <IAzureContextContainer>]
- [<CommonParameters>]
-```
-
 ### GetVirtualMachineById
 ```
 Get-AzVM [-Status] -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
@@ -344,21 +338,6 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: True
 ```
 
-### -NextLink
-Specifies the next link.
-
-```yaml
-Type: System.Uri
-Parameter Sets: ListNextLinkVirtualMachinesParamSet
-Aliases:
-
-Required: True
-Position: 1
-Default value: None
-Accept pipeline input: True (ByPropertyName)
-Accept wildcard characters: False
-```
-
 ### -ResourceGroupName
 Specifies the name of a resource group.
 
@@ -421,7 +400,7 @@ UserData for the VM, which will be base-64 encoded. Customer should not pass any
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
-Parameter Sets: DefaultParamSet, GetVirtualMachineInResourceGroupParamSet, ListLocationVirtualMachinesParamSet, ListNextLinkVirtualMachinesParamSet
+Parameter Sets: DefaultParamSet, GetVirtualMachineInResourceGroupParamSet, ListLocationVirtualMachinesParamSet
 Aliases:
 
 Required: False

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

@@ -26,3 +26,5 @@
 "Az.Compute","Microsoft.Azure.Commands.Compute.Automation.GetAzureRmGalleryImageVersion","Get-AzGalleryImageVersion","0","3000","The type of property 'Source' of type 'Microsoft.Azure.Management.Compute.Models.GalleryOSDiskImage' has changed from 'Microsoft.Azure.Management.Compute.Models.GalleryArtifactVersionSource' to 'Microsoft.Azure.Management.Compute.Models.GalleryDiskImageSource'.","Change the type of property 'Source' back to 'Microsoft.Azure.Management.Compute.Models.GalleryArtifactVersionSource'."
 "Az.Compute","Microsoft.Azure.Commands.Compute.Automation.GetAzureRmGalleryImageVersion","Get-AzGalleryImageVersion","0","3000","The type of property 'Source' of type 'Microsoft.Azure.Management.Compute.Models.GalleryDataDiskImage' has changed from 'Microsoft.Azure.Management.Compute.Models.GalleryArtifactVersionSource' to 'Microsoft.Azure.Management.Compute.Models.GalleryDiskImageSource'.","Change the type of property 'Source' back to 'Microsoft.Azure.Management.Compute.Models.GalleryArtifactVersionSource'."
 "Az.Compute","Microsoft.Azure.Commands.Compute.Automation.NewAzureRmGalleryImageVersion","New-AzGalleryImageVersion","0","3000","The type of property 'Source' of type 'Microsoft.Azure.Management.Compute.Models.GalleryOSDiskImage' has changed from 'Microsoft.Azure.Management.Compute.Models.GalleryArtifactVersionSource' to 'Microsoft.Azure.Management.Compute.Models.GalleryDiskImageSource'.","Change the type of property 'Source' back to 'Microsoft.Azure.Management.Compute.Models.GalleryArtifactVersionSource'."
+"Az.Compute","Microsoft.Azure.Commands.Compute.GetAzureVMCommand","Get-AzVM","0","1050","The parameter set 'ListNextLinkVirtualMachinesParamSet' for cmdlet 'Get-AzVM' has been removed.","Add parameter set 'ListNextLinkVirtualMachinesParamSet' back to cmdlet 'Get-AzVM'."
+"Az.Compute","Microsoft.Azure.Commands.Compute.GetAzureVMCommand","Get-AzVM","0","2000","The cmdlet 'Get-AzVM' no longer supports the parameter 'NextLink' and no alias was found for the original parameter name.","Add the parameter 'NextLink' back to the cmdlet 'Get-AzVM', or add an alias to the original parameter name."