AccessReviewScheduleSettings interface

Package:

@azure/arm-authorization

Settings of an Access Review.

Properties

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.
defaultDecision	This specifies the behavior for the autoReview feature when an access review completes.
defaultDecisionEnabled	Flag to indicate whether reviewers are required to provide a justification when reviewing access.
endDate	The DateTime when the review is scheduled to end. Required if type is endDate
instanceDurationInDays	The duration in days for an instance.
interval	The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
justificationRequiredOnApproval	Flag to indicate whether the reviewer is required to pass justification when recording a decision.
mailNotificationsEnabled	Flag to indicate whether sending mails to reviewers and the review creator is enabled.
numberOfOccurrences	The number of times to repeat the access review. Required and must be positive if type is numbered.
recommendationLookBackDuration	Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))
recommendationsEnabled	Flag to indicate whether showing recommendations to reviewers is enabled.
reminderNotificationsEnabled	Flag to indicate whether sending reminder emails to reviewers are enabled.
startDate	The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
typeRecurrencePatternType	The recurrence type : weekly, monthly, etc.
typeRecurrenceRangeType	The recurrence range type. The possible values are: endDate, noEnd, numbered.

Property Details

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.

autoApplyDecisionsEnabled?: boolean

Property Value

boolean

defaultDecision

This specifies the behavior for the autoReview feature when an access review completes.

defaultDecision?: string

Property Value

string

defaultDecisionEnabled

Flag to indicate whether reviewers are required to provide a justification when reviewing access.

defaultDecisionEnabled?: boolean

Property Value

boolean

endDate

The DateTime when the review is scheduled to end. Required if type is endDate

endDate?: Date

Property Value

Date

instanceDurationInDays

The duration in days for an instance.

instanceDurationInDays?: number

Property Value

number

interval

The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.

interval?: number

Property Value

number

justificationRequiredOnApproval

Flag to indicate whether the reviewer is required to pass justification when recording a decision.

justificationRequiredOnApproval?: boolean

Property Value

boolean

mailNotificationsEnabled

Flag to indicate whether sending mails to reviewers and the review creator is enabled.

mailNotificationsEnabled?: boolean

Property Value

boolean

numberOfOccurrences

The number of times to repeat the access review. Required and must be positive if type is numbered.

numberOfOccurrences?: number

Property Value

number

recommendationLookBackDuration

Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))

recommendationLookBackDuration?: string

Property Value

string

recommendationsEnabled

Flag to indicate whether showing recommendations to reviewers is enabled.

recommendationsEnabled?: boolean

Property Value

boolean

reminderNotificationsEnabled

Flag to indicate whether sending reminder emails to reviewers are enabled.

reminderNotificationsEnabled?: boolean

Property Value

boolean

startDate

The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.

startDate?: Date

Property Value

Date

typeRecurrencePatternType

The recurrence type : weekly, monthly, etc.

typeRecurrencePatternType?: string

Property Value

string

typeRecurrenceRangeType

The recurrence range type. The possible values are: endDate, noEnd, numbered.

typeRecurrenceRangeType?: string

Property Value

string