Microsoft.Authorization policyDefinitions template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.Authorization/policyDefinitions",
  "apiVersion": "2018-05-01",
  "properties": {
    "policyType": "string",
    "mode": "string",
    "displayName": "string",
    "description": "string",
    "policyRule": {},
    "metadata": {},
    "parameters": {}
  }
}

Property values

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

Microsoft.Authorization/policyDefinitions object

Name Type Required Value
name string Yes
type enum Yes Microsoft.Authorization/policyDefinitions
apiVersion enum Yes 2018-05-01
properties object Yes The policy definition properties. - PolicyDefinitionProperties object

PolicyDefinitionProperties object

Name Type Required Value
policyType enum No The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. - NotSpecified, BuiltIn, Custom
mode enum No The policy definition mode. Possible values are NotSpecified, Indexed, and All. - NotSpecified, Indexed, All
displayName string No The display name of the policy definition.
description string No The policy definition description.
policyRule object No The policy rule.
metadata object No The policy definition metadata.
parameters object No Required if a parameter is used in policy rule.