Skip to content

Add warnings for future breaking changes in Az.Resources policy CRUD cmdlets #22678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mentat9 wants to merge 17 commits into from
Closed

Add warnings for future breaking changes in Az.Resources policy CRUD cmdlets #22678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
cf9aa8b
Get-AzPolicyAlias: optmize common path for single namespace
mentat9 Oct 19, 2021
9f2a97a
Update changelog.
mentat9 Oct 19, 2021
9497613
Refresh from main
mentat9 Oct 26, 2021
457d158
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Nov 20, 2021
2800e5d
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Jan 7, 2022
a02f7bc
Fox for https://github.com/Azure/azure-powershell/issues/15828
mentat9 Jan 8, 2022
688d6e3
Update changelog
mentat9 Jan 8, 2022
ceb40aa
Merge from main
mentat9 Feb 15, 2023
d52ad04
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Feb 17, 2023
7217480
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Feb 24, 2023
1eecaad
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Mar 3, 2023
d33bf7d
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Mar 15, 2023
0760b2d
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Aug 26, 2023
f553db6
Merge branch 'main' of https://github.com/Azure/azure-powershell into…
mentat9 Aug 28, 2023
a563fb8
Add breaking change warnings to Policy CRUD cmdlets.
mentat9 Aug 28, 2023
f8498b1
Minor changelog correction
mentat9 Aug 28, 2023
3f4ca63
Added per-cmdlet information about upcoming changes
mentat9 Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/GetAzurePolicyAssignment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Gets the policy assignment.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyAssignment), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "EnforcementMode", "Metadata", "NonComplianceMessages", "NotScopes", "Parameters", "PolicyDefinitionId", "Scope" })]
[Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicyAssignment", DefaultParameterSetName = PolicyCmdletBase.DefaultParameterSet), OutputType(typeof(PsPolicyAssignment))]
public class GetAzurePolicyAssignmentCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/GetAzurePolicyDefinition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.ErrorResponses;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.Azure.Commands.ResourceManager.Common;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;
Expand All @@ -28,6 +29,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Gets the policy definition.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyDefinition), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "Metadata", "Mode", "Parameters", "PolicyRule", "PolicyType" })]
[Cmdlet(VerbsCommon.Get, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicyDefinition", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet), OutputType(typeof(PsPolicyDefinition))]
public class GetAzurePolicyDefinitionCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/GetAzurePolicyExemption.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
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 Policy;
Expand All @@ -26,6 +27,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Gets the policy exemption.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyExemption), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "ExemptionCategory", "ExpiresOn", "Metadata", "PolicyAssignmentId", "PolicyDefinitionReferenceIds" })]
[Cmdlet(VerbsCommon.Get, AzureRMConstants.AzureRMPrefix + "PolicyExemption", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet), OutputType(typeof(PsPolicyExemption))]
public class GetAzurePolicyExemptionCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/GetAzurePolicySetDefinition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.ErrorResponses;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.Azure.Commands.ResourceManager.Common;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;
Expand All @@ -28,6 +29,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Gets the policy set definition.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicySetDefinition), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "Metadata", "Parameters", "PolicyDefinitionGroups", "PolicyDefinitions", "PolicyType" })]
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicySetDefinition", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet), OutputType(typeof(PsPolicySetDefinition))]
public class GetAzurePolicySetDefinitionCmdlet : PolicyCmdletBase
{
Expand Down
3 changes: 3 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/NewAzurePolicyAssignment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Creates a policy assignment.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyAssignment), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "EnforcementMode", "Metadata", "NonComplianceMessages", "NotScopes", "Parameters", "PolicyDefinitionId", "Scope" })]
[Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicyAssignment", DefaultParameterSetName = PolicyCmdletBase.DefaultParameterSet), OutputType(typeof(PsPolicyAssignment))]
public class NewAzurePolicyAssignmentCmdlet : PolicyCmdletBase, IDynamicParameters
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/NewAzurePolicyDefinition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;
Expand All @@ -27,6 +28,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Creates the new policy definition.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyDefinition), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "Metadata", "Mode", "Parameters", "PolicyRule", "PolicyType" })]
[Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicyDefinition", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet), OutputType(typeof(PsPolicyDefinition))]
public class NewAzurePolicyDefinitionCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/NewAzurePolicyExemption.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.Azure.Commands.ResourceManager.Common;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;

/// <summary>
/// Creates a policy exemption.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyExemption), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "ExemptionCategory", "ExpiresOn", "Metadata", "PolicyAssignmentId", "PolicyDefinitionReferenceIds" })]
[Cmdlet(VerbsCommon.New, AzureRMConstants.AzureRMPrefix + "PolicyExemption", DefaultParameterSetName = PolicyCmdletBase.DefaultParameterSet, SupportsShouldProcess = true), OutputType(typeof(PsPolicyExemption))]
public class NewAzurePolicyExemptionCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/NewAzurePolicySetDefinition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;
Expand All @@ -26,6 +27,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Creates the policy set definition.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicySetDefinition), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "Metadata", "Parameters", "PolicyDefinitionGroups", "PolicyDefinitions", "PolicyType" })]
[Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicySetDefinition", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PsPolicySetDefinition))]
public class NewAzurePolicySetDefinitionCmdlet : PolicyCmdletBase
{
Expand Down
3 changes: 3 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/SetAzurePolicyAssignment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Sets the policy assignment.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyAssignment), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "EnforcementMode", "Metadata", "NonComplianceMessages", "NotScopes", "Parameters", "PolicyDefinitionId", "Scope" })]
[Cmdlet(VerbsCommon.Set, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicyAssignment", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet), OutputType(typeof(PsPolicyAssignment))]
public class SetAzurePolicyAssignmentCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/SetAzurePolicyDefinition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;
Expand All @@ -27,6 +28,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Sets the policy definition.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyDefinition), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "Metadata", "Mode", "Parameters", "PolicyRule", "PolicyType" })]
[Cmdlet(VerbsCommon.Set, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicyDefinition", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet), OutputType(typeof(PsPolicyDefinition))]
public class SetAzurePolicyDefinitionCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/SetAzurePolicyExemption.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.Azure.Commands.ResourceManager.Common;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;
Expand All @@ -27,6 +28,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Sets the policy exemption.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicyExemption), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "ExemptionCategory", "ExpiresOn", "Metadata", "PolicyAssignmentId", "PolicyDefinitionReferenceIds" })]
[Cmdlet(VerbsCommon.Set, AzureRMConstants.AzureRMPrefix + "PolicyExemption", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PsPolicyExemption))]
public class SetAzurePolicyExemptionCmdlet : PolicyCmdletBase
{
Expand Down
4 changes: 4 additions & 0 deletions src/Resources/ResourceManager/Implementation/Policy/SetAzurePolicySetDefinition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Policy;
using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Extensions;
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;

using Newtonsoft.Json.Linq;
using Policy;
Expand All @@ -26,6 +27,9 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
/// <summary>
/// Sets the policy definition.
/// </summary>
[CmdletOutputBreakingChangeWithVersion(
typeof(PsPolicySetDefinition), deprecateByAzVersion: "11.0.0", deprecateByVersion: "7.0.0", DeprecatedOutputProperties = new[] { "Properties" },
NewOutputProperties = new[] { "Description", "DisplayName", "Metadata", "Parameters", "PolicyDefinitionGroups", "PolicyDefinitions", "PolicyType" })]
[Cmdlet(VerbsCommon.Set, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PolicySetDefinition", DefaultParameterSetName = PolicyCmdletBase.NameParameterSet, SupportsShouldProcess = true), OutputType(typeof(PsPolicySetDefinition))]
public class SetAzurePolicySetDefinitionCmdlet : PolicyCmdletBase
{
Expand Down
14 changes: 14 additions & 0 deletions src/Resources/Resources/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,20 @@

## Upcoming Release
* Implemented logic that allows Deployment Stack objects to be piped into Save and Remove Deployment Stack cmdlets.
### `New-AzPolicyAssignment`, `Get-AzPolicyAssignment`, `Set-AzPolicyAssignment`
Copy link
Contributor

@YanaXu YanaXu Aug 30, 2023

Choose a reason for hiding this comment

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

This changelog is not correct. Please update it.

* Policy assignment output type is changed to flatten out the Properties object.
* `Description`, `DisplayName`, `EnforcementMode`, `Metadata`, `NonComplianceMessages`, `NotScopes`, `Parameters`, `PolicyDefinitionId`, and `Scope` properties are moved to the top level.
### `New-AzPolicyExemption`, `Get-AzPolicyExemption`, `Set-AzPolicyExemption`
* Policy exemption output type is changed to flatten out the Properties object.
* `Description`, `DisplayName`, `ExemptionCategory`, `ExpiresOn`, `Metadata`, `PolicyAssignmentId`, and `PolicyDefinitionReferenceIds` properties are moved to the top level.
### `New-AzPolicyDefinition`, `Get-AzPolicyDefinition`, `Set-AzPolicyDefinition`
* Policy definition output type is changed to flatten out the Properties object.
* `Description`, `DisplayName`, `Metadata`, `Mode`, `Parameters`, `PolicyRule`, and `PolicyType` properties are moved to the top level.
### `New-AzPolicySetDefinition`, `Get-AzPolicySetDefinition`, `Set-AzPolicySetDefinition`
* Policy set definition output type is changed to flatten out the Properties object.
* `Description`, `DisplayName`, `Metadata`, `Parameters`, `PolicyDefinitionGroups`, `PolicyDefinitions`, and `PolicyType` properties are moved to the top level.
### `Remove-AzPolicyAssignment`, `Remove-AzPolicyDefinition`, `Remove-AzPolicyExemption`, `Remove-AzPolicySetDefinition`
* Return boolean value is removed unless the -Passthru switch is given.

## Version 6.9.1
* Fixed the warning prompt condition check in New-Az*DeploymentStack cmdlets.
Expand Down