Microsoft.Authorization policySetDefinitions 2019-09-01

Template format

To create a Microsoft.Authorization/policySetDefinitions resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2019-09-01",
  "scope": "string",
  "properties": {
    "policyType": "string",
    "displayName": "string",
    "description": "string",
    "metadata": {},
    "parameters": {},
    "policyDefinitions": [
      {
        "policyDefinitionId": "string",
        "parameters": {},
        "policyDefinitionReferenceId": "string",
        "groupNames": [
          "string"
        ]
      }
    ],
    "policyDefinitionGroups": [
      {
        "name": "string",
        "displayName": "string",
        "category": "string",
        "description": "string",
        "additionalMetadataId": "string"
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Authorization/policySetDefinitions object

Name Type Required Value
name string Yes
type enum Yes Microsoft.Authorization/policySetDefinitions
apiVersion enum Yes 2019-09-01
scope string No Use when specifying a scope that is different than the deployment scope. See Setting scope for extension resources in ARM templates.
properties object Yes The policy definition properties. - PolicySetDefinitionProperties object

PolicySetDefinitionProperties object

Name Type Required Value
policyType enum No The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. - NotSpecified, BuiltIn, Custom, Static
displayName string No The display name of the policy set definition.
description string No The policy set definition description.
metadata object No The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
parameters object No The policy set definition parameters that can be used in policy definition references.
policyDefinitions array Yes An array of policy definition references. - PolicyDefinitionReference object
policyDefinitionGroups array No The metadata describing groups of policy definition references within the policy set definition. - PolicyDefinitionGroup object

PolicyDefinitionReference object

Name Type Required Value
policyDefinitionId string Yes The ID of the policy definition or policy set definition.
parameters object No The parameter values for the referenced policy rule. The keys are the parameter names.
policyDefinitionReferenceId string No A unique id (within the policy set definition) for this policy definition reference.
groupNames array No The name of the groups that this policy definition reference belongs to. - string

PolicyDefinitionGroup object

Name Type Required Value
name string Yes The name of the group.
displayName string No The group's display name.
category string No The group's category.
description string No The group's description.
additionalMetadataId string No A resource ID of a resource that contains additional metadata about the group.