Breaking Change - Removed ApiVersion parameter from Az.Resources deployments cmdlets and changed the output type of Get-AzResourceGroupDeploymentOperations (#13112)

* Remove ApiVersion Parameter from deployments

* update changelog

* Delete ApiVersion param

* Switch to SDK use in ResourceGroup Deployments cmdlets

* Include review fixes

* Changed help file to reflect new output type

* Rollback breaking changes from PR #12141

* Change Get-AzResourceGroupDeploymentOperation implementation to use SDK

* Update help

* Rollback changes to help files of untouched cmdlets

* Suppress breaking change issues

* remove subscriptionId param

* Update breakingchanges csv

* Suppress breaking changes

* Review fixes + breaking change suppression

* Add missed breaking change issue to fix static analysis failure

* Update ChangeLog.md

Co-authored-by: Yeming Liu <[email protected]>

Author: Xynoclafe

src/Resources/ResourceManager/Implementation/CmdletBase/ResourceManagerCmdletBase.cs

@@ -25,15 +25,13 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.RestClients;
     using Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkClient;
     using Microsoft.Rest.Azure;
-    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using Newtonsoft.Json.Linq;
     using System;
     using System.Collections.Generic;
     using System.Linq;
     using System.Management.Automation;
     using System.Runtime.ExceptionServices;
     using System.Threading;
-    using System.Threading.Tasks;
 
     /// <summary>
     /// The base class for resource manager cmdlets.
@@ -66,14 +64,6 @@ protected CancellationToken? CancellationToken
         /// </summary>
         private SubscriptionSdkClient subscriptionSdkClient;
 
-        /// <summary>
-        /// Gets or sets the API version.
-        /// </summary>
-        [CmdletParameterBreakingChange("ApiVersion", ChangeDescription = "Parameter is being deprecated without being replaced")]
-        [Parameter(Mandatory = false, HelpMessage = "When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.")]
-        [ValidateNotNullOrEmpty]
-        public virtual string ApiVersion { get; set; }
-
         /// <summary>
         /// Gets or sets the switch that indicates if pre-release API version should be considered.
         /// </summary>
@@ -223,42 +213,6 @@ protected virtual void OnStopProcessing()
             // no-op
         }
 
-        /// <summary>
-        /// Determines the API version.
-        /// </summary>
-        /// <param name="resourceId">The resource Id.</param>
-        /// <param name="pre">When specified, indicates if pre-release API versions should be considered.</param>
-        protected Task<string> DetermineApiVersion(string resourceId, bool? pre = null)
-        {
-            return string.IsNullOrWhiteSpace(this.ApiVersion)
-                ? ApiVersionHelper.DetermineApiVersion(
-                    context: DefaultContext,
-                    resourceId: resourceId,
-                    cancellationToken: this.CancellationToken.Value,
-                    pre: pre ?? this.Pre,
-                    cmdletHeaderValues: this.GetCmdletHeaders())
-                : Task.FromResult(this.ApiVersion);
-        }
-
-        /// <summary>
-        /// Determines the API version.
-        /// </summary>
-        /// <param name="providerNamespace">The provider namespace.</param>
-        /// <param name="resourceType">The resource type.</param>
-        /// <param name="pre">When specified, indicates if pre-release API versions should be considered.</param>
-        protected Task<string> DetermineApiVersion(string providerNamespace, string resourceType, bool? pre = null)
-        {
-            return string.IsNullOrWhiteSpace(this.ApiVersion)
-                ? ApiVersionHelper.DetermineApiVersion(
-                    DefaultContext,
-                    providerNamespace: providerNamespace,
-                    resourceType: resourceType,
-                    cancellationToken: this.CancellationToken.Value,
-                    pre: pre ?? this.Pre,
-                    cmdletHeaderValues: this.GetCmdletHeaders())
-                : Task.FromResult(this.ApiVersion);
-        }
-
         /// <summary>
         /// Gets a new instance of the <see cref="ResourceManagerRestRestClient"/>.
         /// </summary>

src/Resources/ResourceManager/Implementation/CmdletBase/ResourceManagerCmdletBaseWithAPiVersion.cs

@@ -13,16 +13,63 @@
 // ----------------------------------------------------------------------------------
 
 using System.Management.Automation;
+using System.Threading.Tasks;
+using System.Collections.Generic;
 
 namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
 {
-    public abstract class ResourceManagerCmdletBaseWithAPiVersion : ResourceManagerCmdletBase
+    public abstract class ResourceManagerCmdletBaseWithApiVersion : ResourceManagerCmdletBase
     {
         /// <summary>
         /// Gets or sets the API version.
         /// </summary>
         [Parameter(Mandatory = false, HelpMessage = "When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.")]
         [ValidateNotNullOrEmpty]
-        public override string ApiVersion { get; set; }
+        public string ApiVersion { get; set; }
+
+        private Dictionary<string, string> GetCmdletHeaders()
+        {
+            return new Dictionary<string, string>
+            {
+                {"ParameterSetName", this.ParameterSetName },
+                {"CommandName", this.CommandRuntime.ToString() }
+            };
+        }
+
+        /// <summary>
+        /// Determines the API version.
+        /// </summary>
+        /// <param name="resourceId">The resource Id.</param>
+        /// <param name="pre">When specified, indicates if pre-release API versions should be considered.</param>
+        protected Task<string> DetermineApiVersion(string resourceId, bool? pre = null)
+        {
+            return string.IsNullOrWhiteSpace(this.ApiVersion)
+                ? Components.ApiVersionHelper.DetermineApiVersion(
+                    context: DefaultContext,
+                    resourceId: resourceId,
+                    cancellationToken: this.CancellationToken.Value,
+                    pre: pre ?? this.Pre,
+                    cmdletHeaderValues: this.GetCmdletHeaders())
+                : Task.FromResult(this.ApiVersion);
+        }
+
+        /// <summary>
+        /// Determines the API version.
+        /// </summary>
+        /// <param name="providerNamespace">The provider namespace.</param>
+        /// <param name="resourceType">The resource type.</param>
+        /// <param name="pre">When specified, indicates if pre-release API versions should be considered.</param>
+        protected Task<string> DetermineApiVersion(string providerNamespace, string resourceType, bool? pre = null)
+        {
+            return string.IsNullOrWhiteSpace(this.ApiVersion)
+                ? Components.ApiVersionHelper.DetermineApiVersion(
+                    DefaultContext,
+                    providerNamespace: providerNamespace,
+                    resourceType: resourceType,
+                    cancellationToken: this.CancellationToken.Value,
+                    pre: pre ?? this.Pre,
+                    cmdletHeaderValues: this.GetCmdletHeaders())
+                : Task.FromResult(this.ApiVersion);
+        }
     }
 }

src/Resources/ResourceManager/Implementation/CmdletBase/ResourceManipulationCmdletBase.cs

@@ -23,7 +23,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// <summary>
     /// The base class for manipulating resources.
     /// </summary>
-    public abstract class ResourceManipulationCmdletBase : ResourceManagerCmdletBaseWithAPiVersion
+    public abstract class ResourceManipulationCmdletBase : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// The subscription level parameter set.

src/Resources/ResourceManager/Implementation/Locations/GetAzureLocationCmdlet.cs

@@ -28,7 +28,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Get all locations with the supported providers.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "Location"), OutputType(typeof(PSResourceProviderLocation))]
-    public class GetAzureLocationCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class GetAzureLocationCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// Executes the cmdlet

src/Resources/ResourceManager/Implementation/Lock/ResourceLockManagementCmdletBase.cs

@@ -26,7 +26,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// <summary>
     /// Base class for resource lock management cmdlets.
     /// </summary>
-    public abstract class ResourceLockManagementCmdletBase : ResourceManagerCmdletBaseWithAPiVersion
+    public abstract class ResourceLockManagementCmdletBase : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary> 
         /// The Id parameter set. 

src/Resources/ResourceManager/Implementation/ManagedApplications/ManagedApplicationCmdletBase.cs

@@ -32,7 +32,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// <summary>
     /// Base class for policy assignment cmdlets.
     /// </summary>
-    public abstract class ManagedApplicationCmdletBase : ResourceManagerCmdletBaseWithAPiVersion
+    public abstract class ManagedApplicationCmdletBase : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// Gets the next set of resources using the <paramref name="nextLink"/>

src/Resources/ResourceManager/Implementation/Policy/GetAzurePolicyAliasCmdlet.cs

@@ -27,7 +27,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Get an existing resource.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, AzureRMConstants.AzureRMPrefix + "PolicyAlias"), OutputType(typeof(PsResourceProviderAlias))]
-    public class GetAzurePolicyAlias : ResourceManagerCmdletBaseWithAPiVersion
+    public class GetAzurePolicyAlias : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// Gets or sets the provider namespace match string

src/Resources/ResourceManager/Implementation/Policy/PolicyCmdletBase.cs

@@ -32,7 +32,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// <summary>
     /// Base class for policy cmdlets.
     /// </summary>
-    public abstract class PolicyCmdletBase : ResourceManagerCmdletBaseWithAPiVersion
+    public abstract class PolicyCmdletBase : ResourceManagerCmdletBaseWithApiVersion
     {
         public enum ListFilter
         {

src/Resources/ResourceManager/Implementation/Providers/GetAzureProviderCmdlet.cs

@@ -29,7 +29,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Get an existing resource.
     /// </summary>
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceProvider", DefaultParameterSetName = GetAzureProviderCmdlet.ListAvailableParameterSet), OutputType(typeof(PSResourceProvider))]
-    public class GetAzureProviderCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class GetAzureProviderCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// The individual provider parameter set name

src/Resources/ResourceManager/Implementation/Providers/RegisterAzureProviderCmdlet.cs

@@ -24,7 +24,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Register the previewed features of a certain azure resource provider.
     /// </summary>
     [Cmdlet("Register", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceProvider", SupportsShouldProcess = true), OutputType(typeof(PSResourceProvider))]
-    public class RegisterAzureProviderCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class RegisterAzureProviderCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// Gets or sets the provider namespace

src/Resources/ResourceManager/Implementation/Providers/UnregisterAzureProviderCmdlet.cs

@@ -25,7 +25,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Un-registers the resource provider from the current subscription.
     /// </summary>
     [Cmdlet("Unregister", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceProvider", SupportsShouldProcess = true), OutputType(typeof(PSResourceProvider))]
-    public class UnregisterAzureProviderCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class UnregisterAzureProviderCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// Gets or sets the provider namespace

src/Resources/ResourceManager/Implementation/Resource/GetAzureResourceCmdlet.cs

@@ -36,7 +36,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Cmdlet to get existing resources.
     /// </summary>
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "Resource", DefaultParameterSetName = ByTagNameValueParameterSet), OutputType(typeof(PSResource))]
-    public sealed class GetAzureResourceCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public sealed class GetAzureResourceCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         public const string ByResourceIdParameterSet = "ByResourceId";
         public const string ByTagObjectParameterSet = "ByTagObjectParameterSet";

src/Resources/ResourceManager/Implementation/Resource/MoveAzureResourceCmdlet.cs

@@ -28,7 +28,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Moves existing resources to a new resource group or subscription.
     /// </summary>
     [Cmdlet("Move", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "Resource", SupportsShouldProcess = true), OutputType(typeof(bool))]
-    public class MoveAzureResourceCommand : ResourceManagerCmdletBaseWithAPiVersion
+    public class MoveAzureResourceCommand : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// Caches the current resource ids to get all resource ids in the pipeline

src/Resources/ResourceManager/Implementation/ResourceGroupDeployments/GetAzureResourceGroupDeploymentOperationCmdlet.cs

@@ -14,22 +14,14 @@
 
 namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
 {
-    using Commands.Common.Authentication.Abstractions;
     using Common.ArgumentCompleters;
-    using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components;
-    using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
-    using Microsoft.Azure.Commands.ResourceManager.Common;
-    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
-    using Newtonsoft.Json.Linq;
-    using System;
     using System.Management.Automation;
-    using System.Threading.Tasks;
+    using Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels;
 
     /// <summary>
     /// Gets the deployment operation.
     /// </summary>
-    [CmdletOutputBreakingChange(typeof(PSObject), ReplacementCmdletOutputTypeName = "PSDeploymentOperation")]
-    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceGroupDeploymentOperation"), OutputType(typeof(PSObject))]
+    [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceGroupDeploymentOperation"), OutputType(typeof(PSDeploymentOperation))]
     public class GetAzureResourceGroupDeploymentOperationCmdlet : ResourceManagerCmdletBase
     {
         /// <summary>
@@ -40,14 +32,6 @@ public class GetAzureResourceGroupDeploymentOperationCmdlet : ResourceManagerCmd
         [ValidateNotNullOrEmpty]
         public string DeploymentName { get; set; }
 
-        /// <summary>
-        /// Gets or sets the subscription id parameter.
-        /// </summary>
-        [CmdletParameterBreakingChange("SubscriptionId", ChangeDescription = "Parameter is being deprecated without being replaced")]
-        [Parameter(Mandatory = false, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true, HelpMessage = "The subscription to use.")]
-        [ValidateNotNullOrEmpty]
-        public Guid? SubscriptionId { get; set; }
-
         /// <summary>
         /// Gets or sets the resource group name parameter.
         /// </summary>
@@ -61,68 +45,12 @@ public class GetAzureResourceGroupDeploymentOperationCmdlet : ResourceManagerCmd
         /// </summary>
         protected override void OnProcessRecord()
         {
+            var deploymentOperations = ResourceManagerSdkClient.ListDeploymentOperationsAtResourceGroup(
+                ResourceGroupName, DeploymentName);
             base.OnProcessRecord();
 
-            if (this.SubscriptionId == null)
-            {
-                this.SubscriptionId = DefaultContext.Subscription.GetId();
-            }
-
-            this.RunCmdlet();
-        }
-
-        /// <summary>
-        /// Contains the cmdlet's execution logic.
-        /// </summary>
-        private void RunCmdlet()
-        {
-            PaginatedResponseHelper.ForEach(
-                getFirstPage: () => this.GetResources(),
-                getNextPage: nextLink => this.GetNextLink<JObject>(nextLink),
-                cancellationToken: this.CancellationToken,
-                action: resources => this.WriteObject(sendToPipeline: resources.CoalesceEnumerable().SelectArray(resource =>
-                    resource.ToPsObject("System.Management.Automation.PSCustomObject#DeploymentOperation")), enumerateCollection: true));
-        }
-
-        /// <summary>
-        /// Queries the ARM cache and returns the cached resource that match the query specified.
-        /// </summary>
-        private async Task<ResponseWithContinuation<JObject[]>> GetResources()
-        {
-            var resourceId = this.GetResourceId();
-
-            var apiVersion = string.IsNullOrWhiteSpace(this.ApiVersion) ? Constants.DeploymentOperationApiVersion : this.ApiVersion;
-
-            return await this
-                .GetResourcesClient()
-                .ListObjectColleciton<JObject>(
-                    resourceCollectionId: resourceId,
-                    apiVersion: apiVersion,
-                    cancellationToken: this.CancellationToken.Value)
-                .ConfigureAwait(continueOnCapturedContext: false);
+            WriteObject(deploymentOperations, true);
         }
 
-        /// <summary>
-        /// Gets the next set of resources using the <paramref name="nextLink"/>
-        /// </summary>
-        /// <param name="nextLink">The next link.</param>
-        private Task<ResponseWithContinuation<TType[]>> GetNextLink<TType>(string nextLink)
-        {
-            return this
-                .GetResourcesClient()
-                .ListNextBatch<TType>(nextLink: nextLink, cancellationToken: this.CancellationToken.Value);
-        }
-
-        /// <summary>
-        /// Gets the resource Id from the supplied PowerShell parameters.
-        /// </summary>
-        protected string GetResourceId()
-        {
-            return ResourceIdUtility.GetResourceId(
-                subscriptionId: this.SubscriptionId,
-                resourceGroupName: this.ResourceGroupName,
-                resourceType: Constants.MicrosoftResourcesDeploymentOperationsType,
-                resourceName: this.DeploymentName);
-        }
     }
-}
+}

src/Resources/ResourceManager/Implementation/ResourceGroups/ExportAzureResourceGroupCmdlet.cs

@@ -33,7 +33,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Captures the specifies resource group as a template and saves it to a file on disk.
     /// </summary>
     [Cmdlet("Export", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceGroup", SupportsShouldProcess = true), OutputType(typeof(PSObject))]
-    public class ExportAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class ExportAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// Adding a hard-coded API version to be used when there is no value provided for 'ApiVersion' parameter.

src/Resources/ResourceManager/Implementation/ResourceGroups/GetAzureResourceGroupCmdlet.cs

@@ -30,7 +30,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Filters resource groups.
     /// </summary>
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceGroup", DefaultParameterSetName = ResourceGroupNameParameterSet), OutputType(typeof(PSResourceGroup))]
-    public class GetAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class GetAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// List resources group by name parameter set.

src/Resources/ResourceManager/Implementation/ResourceGroups/NewAzureResourceGroupCmdlet.cs

@@ -24,7 +24,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
     /// Filters resource groups.
     /// </summary>
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceGroup", SupportsShouldProcess = true), OutputType(typeof(PSResourceGroup))]
-    public class NewAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class NewAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         [Alias("ResourceGroupName")]
         [Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true, HelpMessage = "The resource group name.")]

src/Resources/ResourceManager/Implementation/ResourceGroups/RemoveAzureResourceGroupCmdlet.cs

@@ -25,7 +25,7 @@ namespace Microsoft.Azure.Commands.Resources
     /// Removes a resource group.
     /// </summary>
     [Cmdlet("Remove", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ResourceGroup", SupportsShouldProcess = true, DefaultParameterSetName = ResourceGroupNameParameterSet), OutputType(typeof(bool))]
-    public class RemoveAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithAPiVersion
+    public class RemoveAzureResourceGroupCmdlet : ResourceManagerCmdletBaseWithApiVersion
     {
         /// <summary>
         /// List resources group by name parameter set.