Skip to content

Azure.Policy.AssignmentDescriptors.md

Latest commit

 

History

History
57 lines (42 loc) · 1.63 KB

Azure.Policy.AssignmentDescriptors.md

File metadata and controls

57 lines (42 loc) · 1.63 KB
Raw
severity Awareness
pillar Operational Excellence
category OE:04 Tools and processes
resource Policy
resourceType Microsoft.Authorization/policyAssignments
online version https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.Policy.AssignmentDescriptors/

Use descriptive policy assignments

SYNOPSIS

Policy assignments should use a display name and description.

DESCRIPTION

Policy assignments can be configured with a display name and description. Use these additional properties to clearly convey the intent of the policy assignment.

RECOMMENDATION

Consider setting a display name and description for each policy assignment.

EXAMPLES

Azure templates

To deploy policy assignments that pass this rule:

  • Set the properties.displayName property with a valid value.
  • Set the properties.description property with a valid value.

For example:

{
    "comments": "Initiative assignment",
    "name": "assignment-001",
    "type": "Microsoft.Authorization/policyAssignments",
    "apiVersion": "2019-06-01",
    "properties": {
        "displayName": "Assignment 001",
        "description": "An example policy assignment.",
        "metadata": {
            "assignedBy": "DevOps pipeline"
        },
        "enforcementMode": "Default"
    }
}

LINKS