Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The policyExemptions 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/policyExemptions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Authorization/policyExemptions@2020-07-01-preview' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
description: 'string'
displayName: 'string'
exemptionCategory: 'string'
expiresOn: 'string'
metadata: any(...)
policyAssignmentId: 'string'
policyDefinitionReferenceIds: [
'string'
]
}
}
Property Values
Microsoft.Authorization/policyExemptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Properties for the policy exemption. | PolicyExemptionProperties (required) |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
PolicyExemptionProperties
| Name | Description | Value |
|---|---|---|
| description | The description of the policy exemption. | string |
| displayName | The display name of the policy exemption. | string |
| exemptionCategory | The policy exemption category. Possible values are Waiver and Mitigated. | 'Mitigated' 'Waiver' (required) |
| expiresOn | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. | string |
| metadata | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. | any |
| policyAssignmentId | The ID of the policy assignment that is being exempted. | string (required) |
| policyDefinitionReferenceIds | The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. | string[] |
ARM template resource definition
The policyExemptions 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/policyExemptions resource, add the following JSON to your template.
{
"type": "Microsoft.Authorization/policyExemptions",
"apiVersion": "2020-07-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"exemptionCategory": "string",
"expiresOn": "string",
"metadata": {},
"policyAssignmentId": "string",
"policyDefinitionReferenceIds": [ "string" ]
}
}
Property Values
Microsoft.Authorization/policyExemptions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-07-01-preview' |
| name | The resource name | string (required) |
| properties | Properties for the policy exemption. | PolicyExemptionProperties (required) |
| type | The resource type | 'Microsoft.Authorization/policyExemptions' |
PolicyExemptionProperties
| Name | Description | Value |
|---|---|---|
| description | The description of the policy exemption. | string |
| displayName | The display name of the policy exemption. | string |
| exemptionCategory | The policy exemption category. Possible values are Waiver and Mitigated. | 'Mitigated' 'Waiver' (required) |
| expiresOn | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. | string |
| metadata | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. | any |
| policyAssignmentId | The ID of the policy assignment that is being exempted. | string (required) |
| policyDefinitionReferenceIds | The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. | string[] |
Usage Examples
Terraform (AzAPI provider) resource definition
The policyExemptions 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/policyExemptions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyExemptions@2020-07-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
description = "string"
displayName = "string"
exemptionCategory = "string"
expiresOn = "string"
metadata = ?
policyAssignmentId = "string"
policyDefinitionReferenceIds = [
"string"
]
}
}
}
Property Values
Microsoft.Authorization/policyExemptions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Properties for the policy exemption. | PolicyExemptionProperties (required) |
| type | The resource type | "Microsoft.Authorization/policyExemptions@2020-07-01-preview" |
PolicyExemptionProperties
| Name | Description | Value |
|---|---|---|
| description | The description of the policy exemption. | string |
| displayName | The display name of the policy exemption. | string |
| exemptionCategory | The policy exemption category. Possible values are Waiver and Mitigated. | 'Mitigated' 'Waiver' (required) |
| expiresOn | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. | string |
| metadata | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs. | any |
| policyAssignmentId | The ID of the policy assignment that is being exempted. | string (required) |
| policyDefinitionReferenceIds | The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. | string[] |