AccessReviewScheduleDefinition interface
Access Review Schedule Definition.
Properties
| assignment |
The role assignment state eligible/active to review NOTE: This property will not be serialized. It can only be populated by the server. |
| auto |
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. |
| backup |
This is the collection of backup reviewers. |
| default |
This specifies the behavior for the autoReview feature when an access review completes. |
| default |
Flag to indicate whether reviewers are required to provide a justification when reviewing access. |
| description |
The description provided by the access review creator and visible to admins. |
| description |
The description provided by the access review creator to be shown to reviewers. |
| display |
The display name for the schedule definition. |
| end |
The DateTime when the review is scheduled to end. Required if type is endDate |
| exclude |
This is used to indicate the resource id(s) to exclude |
| exclude |
This is used to indicate the role definition id(s) to exclude |
| expand |
Flag to indicate whether to expand nested memberships or not. |
| id | The access review schedule definition id. NOTE: This property will not be serialized. It can only be populated by the server. |
| inactive |
Duration users are inactive for. 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)) |
| include |
Flag to indicate whether to expand nested memberships or not. |
| include |
Flag to indicate whether to expand nested memberships or not. |
| instance |
The duration in days for an instance. |
| instances | This is the collection of instances returned when one does an expand on it. |
| interval | The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly. |
| justification |
Flag to indicate whether the reviewer is required to pass justification when recording a decision. |
| mail |
Flag to indicate whether sending mails to reviewers and the review creator is enabled. |
| name | The access review schedule definition unique id. NOTE: This property will not be serialized. It can only be populated by the server. |
| number |
The number of times to repeat the access review. Required and must be positive if type is numbered. |
| principal |
The identity id NOTE: This property will not be serialized. It can only be populated by the server. |
| principal |
The identity display name NOTE: This property will not be serialized. It can only be populated by the server. |
| principal |
The identity type : user/servicePrincipal NOTE: This property will not be serialized. It can only be populated by the server. |
| principal |
The identity type user/servicePrincipal to review NOTE: This property will not be serialized. It can only be populated by the server. |
| recommendation |
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)) |
| recommendations |
Flag to indicate whether showing recommendations to reviewers is enabled. |
| reminder |
Flag to indicate whether sending reminder emails to reviewers are enabled. |
| resource |
ResourceId in which this review is getting created NOTE: This property will not be serialized. It can only be populated by the server. |
| reviewers | This is the collection of reviewers. |
| reviewers |
This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. NOTE: This property will not be serialized. It can only be populated by the server. |
| role |
This is used to indicate the role being reviewed NOTE: This property will not be serialized. It can only be populated by the server. |
| start |
The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. |
| status | This read-only field specifies the status of an accessReview. NOTE: This property will not be serialized. It can only be populated by the server. |
| type | The resource type. NOTE: This property will not be serialized. It can only be populated by the server. |
| type |
The recurrence type : weekly, monthly, etc. |
| type |
The recurrence range type. The possible values are: endDate, noEnd, numbered. |
| user |
The user principal name(if valid) NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
assignmentState
The role assignment state eligible/active to review NOTE: This property will not be serialized. It can only be populated by the server.
assignmentState?: stringProperty Value
string
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?: booleanProperty Value
boolean
backupReviewers
This is the collection of backup reviewers.
backupReviewers?: AccessReviewReviewer[]Property Value
defaultDecision
This specifies the behavior for the autoReview feature when an access review completes.
defaultDecision?: stringProperty Value
string
defaultDecisionEnabled
Flag to indicate whether reviewers are required to provide a justification when reviewing access.
defaultDecisionEnabled?: booleanProperty Value
boolean
descriptionForAdmins
The description provided by the access review creator and visible to admins.
descriptionForAdmins?: stringProperty Value
string
descriptionForReviewers
The description provided by the access review creator to be shown to reviewers.
descriptionForReviewers?: stringProperty Value
string
displayName
The display name for the schedule definition.
displayName?: stringProperty Value
string
endDate
The DateTime when the review is scheduled to end. Required if type is endDate
endDate?: DateProperty Value
Date
excludeResourceId
This is used to indicate the resource id(s) to exclude
excludeResourceId?: stringProperty Value
string
excludeRoleDefinitionId
This is used to indicate the role definition id(s) to exclude
excludeRoleDefinitionId?: stringProperty Value
string
expandNestedMemberships
Flag to indicate whether to expand nested memberships or not.
expandNestedMemberships?: booleanProperty Value
boolean
id
The access review schedule definition id. NOTE: This property will not be serialized. It can only be populated by the server.
id?: stringProperty Value
string
inactiveDuration
Duration users are inactive for. 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))
inactiveDuration?: stringProperty Value
string
includeAccessBelowResource
Flag to indicate whether to expand nested memberships or not.
includeAccessBelowResource?: booleanProperty Value
boolean
includeInheritedAccess
Flag to indicate whether to expand nested memberships or not.
includeInheritedAccess?: booleanProperty Value
boolean
instanceDurationInDays
The duration in days for an instance.
instanceDurationInDays?: numberProperty Value
number
instances
This is the collection of instances returned when one does an expand on it.
instances?: AccessReviewInstance[]Property Value
interval
The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
interval?: numberProperty Value
number
justificationRequiredOnApproval
Flag to indicate whether the reviewer is required to pass justification when recording a decision.
justificationRequiredOnApproval?: booleanProperty Value
boolean
mailNotificationsEnabled
Flag to indicate whether sending mails to reviewers and the review creator is enabled.
mailNotificationsEnabled?: booleanProperty Value
boolean
name
The access review schedule definition unique id. NOTE: This property will not be serialized. It can only be populated by the server.
name?: stringProperty Value
string
numberOfOccurrences
The number of times to repeat the access review. Required and must be positive if type is numbered.
numberOfOccurrences?: numberProperty Value
number
principalId
The identity id NOTE: This property will not be serialized. It can only be populated by the server.
principalId?: stringProperty Value
string
principalName
The identity display name NOTE: This property will not be serialized. It can only be populated by the server.
principalName?: stringProperty Value
string
principalTypePropertiesCreatedByPrincipalType
The identity type : user/servicePrincipal NOTE: This property will not be serialized. It can only be populated by the server.
principalTypePropertiesCreatedByPrincipalType?: stringProperty Value
string
principalTypePropertiesScopePrincipalType
The identity type user/servicePrincipal to review NOTE: This property will not be serialized. It can only be populated by the server.
principalTypePropertiesScopePrincipalType?: stringProperty Value
string
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?: stringProperty Value
string
recommendationsEnabled
Flag to indicate whether showing recommendations to reviewers is enabled.
recommendationsEnabled?: booleanProperty Value
boolean
reminderNotificationsEnabled
Flag to indicate whether sending reminder emails to reviewers are enabled.
reminderNotificationsEnabled?: booleanProperty Value
boolean
resourceId
ResourceId in which this review is getting created NOTE: This property will not be serialized. It can only be populated by the server.
resourceId?: stringProperty Value
string
reviewers
This is the collection of reviewers.
reviewers?: AccessReviewReviewer[]Property Value
reviewersType
This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. NOTE: This property will not be serialized. It can only be populated by the server.
reviewersType?: stringProperty Value
string
roleDefinitionId
This is used to indicate the role being reviewed NOTE: This property will not be serialized. It can only be populated by the server.
roleDefinitionId?: stringProperty Value
string
startDate
The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
startDate?: DateProperty Value
Date
status
This read-only field specifies the status of an accessReview. NOTE: This property will not be serialized. It can only be populated by the server.
status?: stringProperty Value
string
type
The resource type. NOTE: This property will not be serialized. It can only be populated by the server.
type?: stringProperty Value
string
typePropertiesSettingsRecurrencePatternType
The recurrence type : weekly, monthly, etc.
typePropertiesSettingsRecurrencePatternType?: stringProperty Value
string
typePropertiesSettingsRecurrenceRangeType
The recurrence range type. The possible values are: endDate, noEnd, numbered.
typePropertiesSettingsRecurrenceRangeType?: stringProperty Value
string
userPrincipalName
The user principal name(if valid) NOTE: This property will not be serialized. It can only be populated by the server.
userPrincipalName?: stringProperty Value
string
