Microsoft.Authorization accessReviewScheduleDefinitions 2021-03-01-preview

The accessReviewScheduleDefinitions resource type can be deployed to: Subscriptions.

To learn about subscription deployments, see Bicep or ARM template

Template format

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

resource symbolicname 'Microsoft.Authorization/accessReviewScheduleDefinitions@2021-03-01-preview' = {
  name: 'string'
  backupReviewers: [
    {
      principalId: 'string'
    }
  ]
  descriptionForAdmins: 'string'
  descriptionForReviewers: 'string'
  displayName: 'string'
  instances: [
    {
      properties: {
        endDateTime: 'string'
        startDateTime: 'string'
      }
    }
  ]
  reviewers: [
    {
      principalId: 'string'
    }
  ]
  settings: {
    autoApplyDecisionsEnabled: bool
    defaultDecision: 'string'
    defaultDecisionEnabled: bool
    instanceDurationInDays: int
    justificationRequiredOnApproval: bool
    mailNotificationsEnabled: bool
    recommendationsEnabled: bool
    recurrence: {
      pattern: {
        interval: int
        type: 'string'
      }
      range: {
        endDate: 'string'
        numberOfOccurrences: int
        startDate: 'string'
        type: 'string'
      }
    }
    reminderNotificationsEnabled: bool
  }
}

Property values

accessReviewScheduleDefinitions

Name Description Value
type The resource type

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

For Bicep, set this value in the resource declaration.
'2021-03-01-preview'
name The resource name string (required)
backupReviewers This is the collection of backup reviewers. AccessReviewReviewer[]
descriptionForAdmins The description provided by the access review creator and visible to admins. string
descriptionForReviewers The description provided by the access review creator to be shown to reviewers. string
displayName The display name for the schedule definition. string
instances This is the collection of instances returned when one does an expand on it. AccessReviewInstance[]
reviewers This is the collection of reviewers. AccessReviewReviewer[]
settings Settings of an Access Review. AccessReviewScheduleSettings

AccessReviewReviewer

Name Description Value
principalId The id of the reviewer(user/servicePrincipal) string

AccessReviewInstance

Name Description Value
properties Access Review Instance properties. AccessReviewInstanceProperties

AccessReviewInstanceProperties

Name Description Value
endDateTime The DateTime when the review instance is scheduled to end. string
startDateTime The DateTime when the review instance is scheduled to be start. string

AccessReviewScheduleSettings

Name Description Value
autoApplyDecisionsEnabled Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review. bool
defaultDecision This specifies the behavior for the autoReview feature when an access review completes. 'Approve'
'Deny'
'Recommendation'
defaultDecisionEnabled Flag to indicate whether reviewers are required to provide a justification when reviewing access. bool
instanceDurationInDays The duration in days for an instance. int
justificationRequiredOnApproval Flag to indicate whether the reviewer is required to pass justification when recording a decision. bool
mailNotificationsEnabled Flag to indicate whether sending mails to reviewers and the review creator is enabled. bool
recommendationsEnabled Flag to indicate whether showing recommendations to reviewers is enabled. bool
recurrence Recurrence Settings of an Access Review Schedule Definition. AccessReviewRecurrenceSettings
reminderNotificationsEnabled Flag to indicate whether sending reminder emails to reviewers are enabled. bool

AccessReviewRecurrenceSettings

Name Description Value
pattern Recurrence Pattern of an Access Review Schedule Definition. AccessReviewRecurrencePattern
range Recurrence Range of an Access Review Schedule Definition. AccessReviewRecurrenceRange

AccessReviewRecurrencePattern

Name Description Value
interval The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. int
type The recurrence type : weekly, monthly, etc. 'absoluteMonthly'
'weekly'

AccessReviewRecurrenceRange

Name Description Value
endDate The DateTime when the review is scheduled to end. Required if type is endDate string
numberOfOccurrences The number of times to repeat the access review. Required and must be positive if type is numbered. int
startDate The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. string
type The recurrence range type. The possible values are: endDate, noEnd, numbered. 'endDate'
'noEnd'
'numbered'