Microsoft.Authorization policyAssignments 2016-12-01
The policyAssignments resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource.
- For Bicep, see Set scope on extension resources in Bicep.
- For JSON, see Set scope on extension resources in ARM templates.
Valid deployment scopes for the policyAssignments resource are:
- Management Group
- Subscription
- Resource Group
For a list of changed properties in each API version, see change log.
Template format
To create a Microsoft.Authorization/policyAssignments resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.Authorization/policyAssignments@2016-12-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
parameters: any()
policyDefinitionId: 'string'
scope: 'string'
}
}
Property values
policyAssignments
Name | Description | Value |
---|---|---|
type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.Authorization/policyAssignments' |
apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2016-12-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. |
scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. For JSON, set the value to the full name of the resource to apply the extension resource to. |
properties | Properties for the policy assignment. | PolicyAssignmentProperties |
PolicyAssignmentProperties
Name | Description | Value |
---|---|---|
description | This message will be part of response in case of policy violation. | string |
displayName | The display name of the policy assignment. | string |
parameters | Required if a parameter is used in policy rule. | For Bicep, you can use the any() function. |
policyDefinitionId | The ID of the policy definition. | string |
scope | The scope for the policy assignment. | string |
Quickstart templates
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Deploy a policy definition and assign to a management group |
This template is a management group level template that will create a policy definition and assign that policy to the target management group. Currently, this template cannot be deployed via the Azure Portal. |
Deploy a Policy Def and Assign to Multiple Mgmt Groups |
This template is a management group level template that will create a policy definition and assign that policy to multiple management groups. |
Assign a built-in policy to an existing resource group |
This template assigns a built-in policy to an existing resource group. |