Skip to content

Commit 9a8ed60

Browse files
Merge pull request #214610 from shanhix1/patch-13
Clarify best practices for attestations
2 parents 8a1d85f + a048b17 commit 9a8ed60

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,23 @@ author: timwarner-msft
1111
Attestations are used by Azure Policy to set compliance states of resources or scopes targeted by [manual policies](effects.md#manual-preview). They also allow users to provide additional metadata or link to evidence which accompanies the attested compliance state.
1212

1313
> [!NOTE]
14-
> In preview, Attestations are available only through the Azure Resource Manager (ARM) API.
14+
> In preview, Attestations are available only through the [Azure Resource Manager (ARM) API](/rest/api/policy/attestations).
1515
16-
Below is an example of creating a new attestation resource which sets the compliance state for resources within a desired resource group:
16+
## Best practices
17+
18+
Attestations can be used to set the compliance state of an individual resource for a given manual policy. This means that each applicable resource requires one attestation per manual policy assignment. For ease of management, manual policies should be designed to target the scope which defines the boundary of resources whose compliance state needs to be attested.
19+
20+
For example, suppose an organization divides teams by resource group, and each team is required to attest to development of procedures for handling resources within that resource group. In this scenario, the conditions of the policy rule should specify that type equals `Microsoft.Resources/resourceGroups`. This way, one attestation is required for the resource group, rather than for each individual resource within. Similarly, if the organization deivides teams by subscriptions, the policy rule should target `Microsoft.Resources/subscriptions`.
21+
22+
Typically, the provided evidence should correspond with relevant scopes of the organizational structure. This pattern prevents the need to duplicate evidence across many attestations. Such duplications would make manual policies difficult to manage, and indicate that the policy definition targets the wrong resource(s).
23+
24+
## Example attestation
25+
26+
Below is an example of creating a new attestation resource which sets the compliance state for a resource group targeted by a manual policy assignment:
1727

1828
```http
1929
PUT http://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/attestations/{name}?api-version=2019-10-01
2030
```
21-
Attestations can be used to set the compliance state of an individual resource or a scope. A resource can have one attestation for an individual manual policy assignment.
2231

2332
## Request body
2433

articles/governance/policy/concepts/effects.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -747,10 +747,7 @@ Example: Gatekeeper v2 admission control rule to allow only the specified contai
747747

748748
## Manual (preview)
749749

750-
The new `manual` (preview) effect enables you to define and track your own custom attestation
751-
resources. Unlike other Policy definitions that actively scan for evaluation, the Manual effect
752-
allows for manual changes to the compliance state. To change the compliance for a manual policy,
753-
you'll need to create an attestation for that compliance state.
750+
The new `manual` (preview) effect enables you to self-attest the compliance of resources or scopes. Unlike other policy definitions that actively scan for evaluation, the Manual effect allows for manual changes to the compliance state. To change the compliance of a resource or scope targeted by a manual policy, you'll need to create an [attestation](attestation-structure.md). The [best practice](attestation-structure.md#best-practices) is to design manual policies that target the scope which defines the boundary of resources whose compliance need attesting.
754751

755752
> [!NOTE]
756753
> During Public Preview, support for manual policy is available through various Microsoft Defender

0 commit comments

Comments
 (0)