Skip to content

Commit 3853ddc

Browse files
Merge pull request #287629 from davidsmatlak/ds-policy-updates-remediation-20240930
Removes properties from Policy Remediation
2 parents 00f1b3c + bab9320 commit 3853ddc

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

articles/governance/policy/concepts/remediation-structure.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Details of the policy remediation task structure
33
description: Describes the policy remediation task definition used by Azure Policy to bring resources into compliance.
4-
ms.date: 08/30/2024
4+
ms.date: 09/30/2024
55
ms.topic: conceptual
66
ms.author: kenieva
77
author: kenieva
@@ -18,8 +18,6 @@ Remediation tasks remediate existing resources that aren't compliant. Resources
1818
1919
You use JavaScript Object Notation (JSON) to create a policy remediation task. The policy remediation task contains elements for:
2020

21-
- [display name](#display-name-and-description)
22-
- [description](#display-name-and-description)
2321
- [policy assignment](#policy-assignment-id)
2422
- [policy definitions within an initiative](#policy-definition-id)
2523
- [resource count and parallel deployments](#resource-count-and-parallel-deployments)
@@ -28,17 +26,16 @@ You use JavaScript Object Notation (JSON) to create a policy remediation task. T
2826
- [resource discovery mode](#resource-discovery-mode)
2927
- [provisioning state and deployment summary](#provisioning-state-and-deployment-summary)
3028

31-
3229
For example, the following JSON shows a policy remediation task for policy definition named `requiredTags` a part of an initiative assignment named `resourceShouldBeCompliantInit` with all default settings.
3330

3431
```json
3532
{
36-
"id": "/subscriptions/{subId}/resourceGroups/ExemptRG/providers/Microsoft.PolicyInsights/remediations/remediateNotCompliant",
33+
"id": "/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/remediateNotCompliant",
3734
"apiVersion": "2021-10-01",
3835
"name": "remediateNotCompliant",
3936
"type": "Microsoft.PolicyInsights/remediations",
4037
"properties": {
41-
"policyAssignmentId": "/subscriptions/{mySubscriptionID}/providers/Microsoft.Authorization/policyAssignments/resourceShouldBeCompliantInit",
38+
"policyAssignmentId": "/subscriptions/{subID}/providers/Microsoft.Authorization/policyAssignments/resourceShouldBeCompliantInit",
4239
"policyDefinitionReferenceId": "requiredTags",
4340
"resourceCount": 42,
4441
"parallelDeployments": 6,
@@ -51,10 +48,6 @@ For example, the following JSON shows a policy remediation task for policy defin
5148

5249
Steps on how to trigger a remediation task at [how to remediate non-compliant resources guide](../how-to/remediate-resources.md). These settings can't be changed after the remediation task begins.
5350

54-
## Display name and description
55-
56-
You use `displayName` and `description` to identify the policy remediation task and provide context for its use. `displayName` has a maximum length of _128_ characters and `description` a maximum length of _512_ characters.
57-
5851
## Policy assignment ID
5952

6053
This field must be the full path name of either a policy assignment or an initiative assignment. `policyAssignmentId` is a string and not an array. This property defines which assignment the parent resource hierarchy or individual resource to remediate.

0 commit comments

Comments
 (0)