Open
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds CmdletOutputBreakingChangeWithVersion attributes to nine PolicyInsights cmdlets to notify users about upcoming output type changes planned for Az version 16.0.0 / module version 2.0.0. These notices inform users about deprecated and new output properties, replacement output type names, and behavioral changes (such as new NoWait switch parameters for remediation cmdlets).
Changes:
- Added
CmdletOutputBreakingChangeWithVersionattributes to all affected Attestation cmdlets (Get,New,Set) - Added
CmdletOutputBreakingChangeWithVersionattributes to all Remediation cmdlets (Get,Start,Stop) and general Policy cmdlets (GetAzureRmPolicyEvent,GetAzureRmPolicyState,GetAzureRmPolicyStateSummary,GetAzPolicyMetadata) - Reorganized
usingdirectives in each file to follow a consistent ordering (Microsoft namespaces first, then System namespaces)
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
GetAzureRmPolicyAttestation.cs |
Added breaking change notice for PSAttestation output type changes (SystemData deprecated, new flattened SystemData properties) |
NewAzureRmPolicyAttestation.cs |
Added same breaking change notice as Get/Set for attestation output type changes |
SetAzureRmPolicyAttestation.cs |
Added same breaking change notice as Get/New for attestation output type changes |
GetAzureRmPolicyRemediation.cs |
Added breaking change notice for PSRemediation output type; deprecated Filters, DeploymentSummary, FailureThreshold, ParallelDeployments; added new flattened properties |
StartAzureRmPolicyRemediation.cs |
Added breaking change notice for PSRemediation output type with same property changes, plus behavioral change (new NoWait parameter) |
StopAzureRmPolicyRemediation.cs |
Added breaking change notice for bool output type with ReplacementCmdletOutputTypeName = "Remediation" and a new NoWait parameter description |
GetAzureRmPolicyEvent.cs |
Added breaking change notice for PolicyEvent output type with property renames; contains a typo ("Vales" instead of "Values") |
GetAzureRmPolicyState.cs |
Added breaking change notice for PolicyState output type with property renames |
GetAzureRmPolicyStateSummary.cs |
Added breaking change notice for PolicyStateSummary output type with property renames |
GetAzPolicyMetadata.cs |
Added breaking change notice for PSPolicyMetadata output type with a new ResourceGroupName property |
src/PolicyInsights/PolicyInsights/Cmdlets/GetAzureRmPolicyEvent.cs
Outdated
Show resolved
Hide resolved
src/PolicyInsights/PolicyInsights/Cmdlets/Remediation/StopAzureRmPolicyRemediation.cs
Show resolved
Hide resolved
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
Collaborator
|
Hi @dunnryan Please update the changelog accordingly https://github.com/dunnryan/azure-powershell/blob/main/src/PolicyInsights/PolicyInsights/ChangeLog.md |
|
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adding a breaking change notice for the PolicyInsights cmdlets.
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.