Share via

Microsoft.Authorization policySetDefinitions 2025-01-01

  • Article

Bicep resource definition

The policySetDefinitions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Authorization/policySetDefinitions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2025-01-01' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any(Azure.Bicep.Types.Concrete.AnyType)
    parameters: {
      {customized property}: {
        allowedValues: [
          any(Azure.Bicep.Types.Concrete.AnyType)
        ]
        defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        schema: any(Azure.Bicep.Types.Concrete.AnyType)
        type: 'string'
      }
    }
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        definitionVersion: 'string'
        groupNames: [
          'string'
        ]
        parameters: {
          {customized property}: {
            value: any(Azure.Bicep.Types.Concrete.AnyType)
          }
        }
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Property values

Microsoft.Authorization/policySetDefinitions

Name Description Value
name The resource name string

Constraints:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (required)
properties The policy set definition properties. PolicySetDefinitionProperties

ParameterDefinitions

Name Description Value

ParameterDefinitionsValue

Name Description Value
allowedValues The allowed values for the parameter. any[]
defaultValue The default value for the parameter if no value is provided. any
metadata General metadata for the parameter. ParameterDefinitionsValueMetadata
schema Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/. any
type The data type of the parameter. 'Array'
'Boolean'
'DateTime'
'Float'
'Integer'
'Object'
'String'

ParameterDefinitionsValueMetadata

Name Description Value
assignPermissions Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope. bool
description The description of the parameter. string
displayName The display name for the parameter. string
strongType Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from. string

ParameterValues

Name Description Value

ParameterValuesValue

Name Description Value
value The value of the parameter. any

PolicyDefinitionGroup

Name Description Value
additionalMetadataId A resource ID of a resource that contains additional metadata about the group. string
category The group's category. string
description The group's description. string
displayName The group's display name. string
name The name of the group. string (required)

PolicyDefinitionReference

Name Description Value
definitionVersion The version of the policy definition to use. string
groupNames The name of the groups that this policy definition reference belongs to. string[]
parameters The parameter values for the referenced policy rule. The keys are the parameter names. ParameterValues
policyDefinitionId The ID of the policy definition or policy set definition. string (required)
policyDefinitionReferenceId A unique id (within the policy set definition) for this policy definition reference. string

PolicySetDefinitionProperties

Name Description Value
description The policy set definition description. string
displayName The display name of the policy set definition. string
metadata The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. any
parameters The policy set definition parameters that can be used in policy definition references. ParameterDefinitions
policyDefinitionGroups The metadata describing groups of policy definition references within the policy set definition. PolicyDefinitionGroup[]
policyDefinitions An array of policy definition references. PolicyDefinitionReference[] (required)
policyType The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. 'BuiltIn'
'Custom'
'NotSpecified'
'Static'
version The policy set definition version in #.#.# format. string
versions A list of available versions for this policy set definition. string[]

ARM template resource definition

The policySetDefinitions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2025-01-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "definitionVersion": "string",
        "groupNames": [ "string" ],
        "parameters": {
          "{customized property}": {
            "value": {}
          }
        },
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

Property values

Microsoft.Authorization/policySetDefinitions

Name Description Value
apiVersion The api version '2025-01-01'
name The resource name string

Constraints:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (required)
properties The policy set definition properties. PolicySetDefinitionProperties
type The resource type 'Microsoft.Authorization/policySetDefinitions'

ParameterDefinitions

Name Description Value

ParameterDefinitionsValue

Name Description Value
allowedValues The allowed values for the parameter. any[]
defaultValue The default value for the parameter if no value is provided. any
metadata General metadata for the parameter. ParameterDefinitionsValueMetadata
schema Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/. any
type The data type of the parameter. 'Array'
'Boolean'
'DateTime'
'Float'
'Integer'
'Object'
'String'

ParameterDefinitionsValueMetadata

Name Description Value
assignPermissions Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope. bool
description The description of the parameter. string
displayName The display name for the parameter. string
strongType Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from. string

ParameterValues

Name Description Value

ParameterValuesValue

Name Description Value
value The value of the parameter. any

PolicyDefinitionGroup

Name Description Value
additionalMetadataId A resource ID of a resource that contains additional metadata about the group. string
category The group's category. string
description The group's description. string
displayName The group's display name. string
name The name of the group. string (required)

PolicyDefinitionReference

Name Description Value
definitionVersion The version of the policy definition to use. string
groupNames The name of the groups that this policy definition reference belongs to. string[]
parameters The parameter values for the referenced policy rule. The keys are the parameter names. ParameterValues
policyDefinitionId The ID of the policy definition or policy set definition. string (required)
policyDefinitionReferenceId A unique id (within the policy set definition) for this policy definition reference. string

PolicySetDefinitionProperties

Name Description Value
description The policy set definition description. string
displayName The display name of the policy set definition. string
metadata The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. any
parameters The policy set definition parameters that can be used in policy definition references. ParameterDefinitions
policyDefinitionGroups The metadata describing groups of policy definition references within the policy set definition. PolicyDefinitionGroup[]
policyDefinitions An array of policy definition references. PolicyDefinitionReference[] (required)
policyType The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. 'BuiltIn'
'Custom'
'NotSpecified'
'Static'
version The policy set definition version in #.#.# format. string
versions A list of available versions for this policy set definition. string[]

Terraform (AzAPI provider) resource definition

The policySetDefinitions resource type can be deployed with operations that target:

  • Tenant* Management groups* Subscription

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Authorization/policySetDefinitions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2025-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          schema = ?
          type = "string"
        }
      }
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          definitionVersion = "string"
          groupNames = [
            "string"
          ]
          parameters = {
            {customized property} = {
              value = ?
            }
          }
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  })
}

Property values

Microsoft.Authorization/policySetDefinitions

Name Description Value
name The resource name string

Constraints:
Pattern = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (required)
properties The policy set definition properties. PolicySetDefinitionProperties
type The resource type "Microsoft.Authorization/policySetDefinitions@2025-01-01"

ParameterDefinitions

Name Description Value

ParameterDefinitionsValue

Name Description Value
allowedValues The allowed values for the parameter. any[]
defaultValue The default value for the parameter if no value is provided. any
metadata General metadata for the parameter. ParameterDefinitionsValueMetadata
schema Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/. any
type The data type of the parameter. 'Array'
'Boolean'
'DateTime'
'Float'
'Integer'
'Object'
'String'

ParameterDefinitionsValueMetadata

Name Description Value
assignPermissions Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope. bool
description The description of the parameter. string
displayName The display name for the parameter. string
strongType Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from. string

ParameterValues

Name Description Value

ParameterValuesValue

Name Description Value
value The value of the parameter. any

PolicyDefinitionGroup

Name Description Value
additionalMetadataId A resource ID of a resource that contains additional metadata about the group. string
category The group's category. string
description The group's description. string
displayName The group's display name. string
name The name of the group. string (required)

PolicyDefinitionReference

Name Description Value
definitionVersion The version of the policy definition to use. string
groupNames The name of the groups that this policy definition reference belongs to. string[]
parameters The parameter values for the referenced policy rule. The keys are the parameter names. ParameterValues
policyDefinitionId The ID of the policy definition or policy set definition. string (required)
policyDefinitionReferenceId A unique id (within the policy set definition) for this policy definition reference. string

PolicySetDefinitionProperties

Name Description Value
description The policy set definition description. string
displayName The display name of the policy set definition. string
metadata The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. any
parameters The policy set definition parameters that can be used in policy definition references. ParameterDefinitions
policyDefinitionGroups The metadata describing groups of policy definition references within the policy set definition. PolicyDefinitionGroup[]
policyDefinitions An array of policy definition references. PolicyDefinitionReference[] (required)
policyType The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. 'BuiltIn'
'Custom'
'NotSpecified'
'Static'
version The policy set definition version in #.#.# format. string
versions A list of available versions for this policy set definition. string[]