Microsoft.Authorization policyExemptions

Bicep resource definition

The policyExemptions 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. See Set scope on extension resources in Bicep.

Valid deployment scopes for the policyExemptions resource are:

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' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    exemptionCategory: 'string'
    expiresOn: 'string'
    metadata: any()
    policyAssignmentId: 'string'
    policyDefinitionReferenceIds: [
      'string'
    ]
  }
}

Property values

policyExemptions

Name Description Value
name The resource name string (required)
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.
properties Properties for the policy exemption. PolicyExemptionProperties (required)

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. For Bicep, you can use the any() function.
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 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. See Set scope on extension resources in ARM templates.

Valid deployment scopes for the policyExemptions resource are:

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",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "exemptionCategory": "string",
    "expiresOn": "string",
    "metadata": {},
    "policyAssignmentId": "string",
    "policyDefinitionReferenceIds": [ "string" ]
  }
}

Property values

policyExemptions

Name Description Value
type The resource type 'Microsoft.Authorization/policyExemptions'
apiVersion The resource api version '2020-07-01-preview'
name The resource name string (required)
scope Use when creating an extension resource at a scope that is different than the deployment scope. Target resource

For JSON, set the value to the full name of the resource to apply the extension resource to.
properties Properties for the policy exemption. PolicyExemptionProperties (required)

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.
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[]

Terraform (AzAPI provider) resource definition

The policyExemptions resource type is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

Valid deployment scopes for the policyExemptions resource are:

  • Resource groups

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 = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      exemptionCategory = "string"
      expiresOn = "string"
      policyAssignmentId = "string"
      policyDefinitionReferenceIds = [
        "string"
      ]
    }
  })
}

Property values

policyExemptions

Name Description Value
type The resource type "Microsoft.Authorization/policyExemptions@2020-07-01-preview"
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)

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.
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[]