Skip to content

Use descriptive policies#

Operational Excellence · Policy · Azure.Policy.Descriptors

Policy and initiative definitions should use a display name, description, and category.

Description#

Policy and initiative definitions can be configured with a display name, description, and category. Use these additional properties to clearly convey the purpose when creating custom definitions.

Recommendation#

Consider setting a display name, description and category for each policy and initiatives definition.

Examples#

Azure templates#

To deploy initiative and policy definitions that pass this rule:

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

For example:

{
    "comments": "Initiative definition",
    "name": "initiative-001",
    "type": "Microsoft.Authorization/policySetDefinitions",
    "apiVersion": "2019-06-01",
    "properties": {
        "policyType": "Custom",
        "displayName": "Initiative 001",
        "description": "An example initiative.",
        "metadata": {
            "category": "Security"
        },
        "policyDefinitions": []
    }
}

Last update: 2021-09-24