Skip to content

Conversation

@atomassi
Copy link
Contributor

@atomassi atomassi commented Jan 16, 2026

Issue: #29058
PR with the breaking change: #29060

Description

This PR adds breaking change preannouncements for the PSRoleDefinition type restructuring in Az.Resources 10.0.0 / Az 16.0.0.

The breaking change involves:

  • Removing flattened properties (Actions, NotActions, DataActions, NotDataActions, Condition, ConditionVersion) from PSRoleDefinition
  • Replacing them with a Permissions array containing permission objects with these properties

Affected cmdlets:

Cmdlet Changes
Get-AzRoleDefinition Output type change
New-AzRoleDefinition Input format (-InputFile JSON, -Role parameter) and output type change
Set-AzRoleDefinition Input format (-InputFile JSON, -Role parameter) and output type change
Remove-AzRoleDefinition -InputObject parameter type and -PassThru output change

Example output

PS C:\Users\atomassilli\repos\azure-powershell> pwsh -NoProfile -Command "Import-Module './artifacts/Debug/Az.Accounts/Az.Accounts.psd1' -Force; Import-Module './artifacts/Debug/Az.Resources/Az.Resources.psd1' -Force; Get-AzRoleDefinition -Name 'Reader' 2>&1"
WARNING: Upcoming breaking changes in the cmdlet 'Get-AzRoleDefinition' :
The output type PSRoleDefinition is changing. The flattened properties 'Actions', 'NotActions', 'DataActions', 'NotDataActions', 'Condition', and 'ConditionVersion' are being removed. Use 'Permissions[n].Actions', 'Permissions[n].DataActions', etc. instead to access the full permission structure with per-permission conditions.
- The change is expected to take effect in Az version : '16.0.0'
- The change is expected to take effect in Az.Resources version : '10.0.0'
Note : Go to https://aka.ms/azps-changewarnings for steps to suppress this breaking change warning, and other information on breaking changes in Azure PowerShell.

Name             : Reader
Id               : acdd72a7-3385-48ef-bd42-f606fba81ae7
IsCustom         : False
Description      : View all resources, but does not allow you to make any changes.
Actions          : {*/read}
NotActions       : {}
DataActions      : {}
NotDataActions   : {}
AssignableScopes : {/}
Condition        : 
ConditionVersion : 

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense. ✅
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction - N/A (no cmdlet API change, only preannouncement attributes)
  • SHOULD have proper test coverage for changes in pull request. - N/A (preannouncement only)
  • SHOULD NOT adjust version of module manually in pull request ✅

Copilot AI review requested due to automatic review settings January 16, 2026 15:17
@azure-client-tools-bot-prd
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

@atomassi atomassi added Resource Authorization AzRole* in Az.Resources Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change labels Jan 16, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds breaking change preannouncements for PSRoleDefinition type restructuring in Az.Resources 10.0.0 (Az 16.0.0). The breaking change involves replacing flattened permission properties with a structured Permissions array.

Changes:

  • Added GenericBreakingChangeWithVersion attributes to four role definition cmdlets to notify users about upcoming type changes
  • Updated ChangeLog.md with detailed information about the breaking changes and affected cmdlets

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
GetAzureRoleDefinitionCommand.cs Added breaking change attribute for output type changes
NewAzureRoleDefinitionCommand.cs Added breaking change attribute for input format and output type changes
SetAzureRoleDefinitionCommand.cs Added breaking change attribute for input format and output type changes
RemoveAzureRoleDefinitionCommand.cs Added breaking change attribute for -InputObject parameter and -PassThru output changes
ChangeLog.md Added entry documenting the breaking change preannouncement with affected cmdlets

@isra-fel
Copy link
Member

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@atomassi atomassi force-pushed the dev/atomassilli/deprecation branch from 33dbc22 to e3d2075 Compare January 16, 2026 16:29
@isra-fel
Copy link
Member

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change Resource Authorization AzRole* in Az.Resources

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants