Microsoft.Authorization policySetDefinitions

  • مقالة
  • قراءة خلال 2 دقائق

The policySetDefinitions resource type can be deployed to: Management groups,.

To learn about management group deployments, see Bicep or ARM template

Template format

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

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2021-06-01' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    parameters: {}
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {}
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
  }
}

Property values

policySetDefinitions

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.Authorization/policySetDefinitions'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2021-06-01'
name The resource name string (required)

Character limit: 1-128 display name

1-64 resource name

1-24 resource name at management group scope

Valid characters:
Display name can contain any characters.

Resource name can't use:
<>*%&:\?.+/ or control characters.

Can't end with period or space.
properties The policy set definition properties. PolicySetDefinitionProperties

PolicySetDefinitionProperties

Name Description Value
description The policy set definition description. string
displayName The display name of the policy set definition. string
metadata Any object For Bicep, you can use the any() function.
parameters The parameter definitions for parameters used in the policy. The keys are the parameter names. object
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'

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 policy rule. The keys are the parameter names. object
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