Microsoft.Authorization policySetDefinitions 2020-03-01

• Latest
• 2025-01-01
• 2024-05-01
• 2023-04-01
• 2021-06-01
• 2020-09-01
• 2020-03-01
• 2019-09-01
• 2019-06-01
• 2019-01-01
• 2018-05-01
• 2018-03-01
• 2017-06-01-preview

Bicep resource definition

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

• Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands

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@2020-03-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: {
          description: 'string'
          displayName: 'string'
        }
        type: 'string'
      }
    }
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {
          {customized property}: {
            value: any(Azure.Bicep.Types.Concrete.AnyType)
          }
        }
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
  }
}

Property values

Microsoft.Authorization/policySetDefinitions

Name	Description	Value
name	The resource name	string (required)
properties	The policy 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
type	The data type of the parameter.	'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String'

ParameterDefinitionsValueMetadata

Name	Description	Value
description	The description of the parameter.	string
displayName	The display name for the parameter.	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
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 definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.	'BuiltIn' 'Custom' 'NotSpecified' 'Static'

ARM template resource definition

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

• Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands

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": "2020-03-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "description": "string",
          "displayName": "string"
        },
        "type": "string"
      }
    },
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "groupNames": [ "string" ],
        "parameters": {
          "{customized property}": {
            "value": {}
          }
        },
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string"
  }
}

Property values

Microsoft.Authorization/policySetDefinitions

Name	Description	Value
apiVersion	The api version	'2020-03-01'
name	The resource name	string (required)
properties	The policy 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
type	The data type of the parameter.	'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String'

ParameterDefinitionsValueMetadata

Name	Description	Value
description	The description of the parameter.	string
displayName	The display name for the parameter.	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
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 definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.	'BuiltIn' 'Custom' 'NotSpecified' 'Static'

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@2020-03-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            description = "string"
            displayName = "string"
          }
          type = "string"
        }
      }
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          groupNames = [
            "string"
          ]
          parameters = {
            {customized property} = {
              value = ?
            }
          }
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
    }
  })
}

Property values

Microsoft.Authorization/policySetDefinitions

Name	Description	Value
name	The resource name	string (required)
properties	The policy definition properties.	PolicySetDefinitionProperties
type	The resource type	"Microsoft.Authorization/policySetDefinitions@2020-03-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
type	The data type of the parameter.	'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String'

ParameterDefinitionsValueMetadata

Name	Description	Value
description	The description of the parameter.	string
displayName	The display name for the parameter.	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
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 definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.	'BuiltIn' 'Custom' 'NotSpecified' 'Static'