Microsoft.Authorization policySetDefinitions 2019-01-01
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@2019-01-01' = {
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
parameters: any(Azure.Bicep.Types.Concrete.AnyType)
policyDefinitions: [
{
parameters: any(Azure.Bicep.Types.Concrete.AnyType)
policyDefinitionId: 'string'
}
]
policyType: 'string'
}
}
Property values
Microsoft.Authorization/policySetDefinitions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | The policy definition properties. | PolicySetDefinitionProperties |
PolicyDefinitionReference
| Name | Description | Value |
|---|---|---|
| parameters | Required if a parameter is used in policy rule. | any |
| policyDefinitionId | The ID of the policy definition or policy set definition. | 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. | any |
| parameters | The policy set definition parameters that can be used in policy definition references. | any |
| policyDefinitions | An array of policy definition references. | PolicyDefinitionReference[] (required) |
| policyType | The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. | 'BuiltIn' 'Custom' 'NotSpecified' |
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": "2019-01-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {},
"policyDefinitions": [
{
"parameters": {},
"policyDefinitionId": "string"
}
],
"policyType": "string"
}
}
Property values
Microsoft.Authorization/policySetDefinitions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-01-01' |
| name | The resource name | string (required) |
| properties | The policy definition properties. | PolicySetDefinitionProperties |
| type | The resource type | 'Microsoft.Authorization/policySetDefinitions' |
PolicyDefinitionReference
| Name | Description | Value |
|---|---|---|
| parameters | Required if a parameter is used in policy rule. | any |
| policyDefinitionId | The ID of the policy definition or policy set definition. | 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. | any |
| parameters | The policy set definition parameters that can be used in policy definition references. | any |
| policyDefinitions | An array of policy definition references. | PolicyDefinitionReference[] (required) |
| policyType | The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. | 'BuiltIn' 'Custom' 'NotSpecified' |
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@2019-01-01"
name = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
metadata = ?
parameters = ?
policyDefinitions = [
{
parameters = ?
policyDefinitionId = "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@2019-01-01" |
PolicyDefinitionReference
| Name | Description | Value |
|---|---|---|
| parameters | Required if a parameter is used in policy rule. | any |
| policyDefinitionId | The ID of the policy definition or policy set definition. | 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. | any |
| parameters | The policy set definition parameters that can be used in policy definition references. | any |
| policyDefinitions | An array of policy definition references. | PolicyDefinitionReference[] (required) |
| policyType | The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. | 'BuiltIn' 'Custom' 'NotSpecified' |