Merge pull request #5676 from darshanhs90/preview2

add breaking change instructions for Get-AzureRmRoleDefinition

Author: Maddie Clayton

src/ResourceManager/Resources/Commands.Resources/RoleDefinitions/GetAzureRoleDefinitionCommand.cs

@@ -48,14 +48,17 @@ public class GetAzureRoleDefinitionCommand : ResourcesBaseCmdlet
 
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.RoleDefinitionName, HelpMessage = "If specified, displays the the roles at and below scope.")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.RoleDefinitionCustom, HelpMessage = "If specified, displays the the roles at and below scope.")]
+        [Obsolete("Get-AzureRmRoleDefinition: The parameter \"AtScopeAndBelow\" is being removed in an upcoming breaking change release.")]
         public SwitchParameter AtScopeAndBelow { get; set; }
 
         public override void ExecuteCmdlet()
         {
             FilterRoleDefinitionOptions options = new FilterRoleDefinitionOptions
             {
                 CustomOnly = Custom.IsPresent ? true : false,
+                #pragma warning disable 0618
                 ScopeAndBelow = AtScopeAndBelow.IsPresent ? true : false,
+                #pragma warning restore 0618
                 Scope = Scope,
                 ResourceIdentifier = new ResourceIdentifier
                 {

src/ResourceManager/Resources/documentation/upcoming-breaking-changes.md

@@ -25,4 +25,18 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes
+# Upcoming Breaking Changes
+
+The following cmdlets were affected this release:
+
+**Get-AzureRmRoleDefinition**
+- Parameter "AtScopeAndBelow" is being removed.
+
+```powershell
+
+# Old
+# Get-AzureRmRoleDefinition [other required parameters] -AtScopeAndBelow
+
+# New
+# Get-AzureRmRoleDefinition [other required parameters]
+```