AccessReviewScheduleDefinitionProperties Class
- java.
lang. Object - com.
azure. resourcemanager. authorization. fluent. models. AccessReviewScheduleDefinitionProperties
- com.
Implements
public final class AccessReviewScheduleDefinitionProperties
implements JsonSerializable<AccessReviewScheduleDefinitionProperties>
Access Review.
Constructor Summary
| Constructor | Description |
|---|---|
| AccessReviewScheduleDefinitionProperties() |
Creates an instance of Access |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
Access |
assignmentState()
Get the assignment |
| Boolean |
autoApplyDecisionsEnabled()
Get the auto |
|
List<Access |
backupReviewers()
Get the backup |
|
Default |
defaultDecision()
Get the default |
| Boolean |
defaultDecisionEnabled()
Get the default |
| String |
descriptionForAdmins()
Get the description |
| String |
descriptionForReviewers()
Get the description |
| String |
displayName()
Get the display |
|
Offset |
endDate()
Get the end |
| String |
excludeResourceId()
Get the exclude |
| String |
excludeRoleDefinitionId()
Get the exclude |
| Boolean |
expandNestedMemberships()
Get the expand |
|
static
Access |
fromJson(JsonReader jsonReader)
Reads an instance of Access |
| Duration |
inactiveDuration()
Get the inactive |
| Boolean |
includeAccessBelowResource()
Get the include |
| Boolean |
includeInheritedAccess()
Get the include |
| Integer |
instanceDurationInDays()
Get the instance |
|
List<Access |
instances()
Get the instances property: This is the collection of instances returned when one does an expand on it. |
| Integer |
interval()
Get the interval property: The interval for recurrence. |
| Boolean |
justificationRequiredOnApproval()
Get the justification |
| Boolean |
mailNotificationsEnabled()
Get the mail |
| Integer |
numberOfOccurrences()
Get the number |
| String |
principalId()
Get the principal |
| String |
principalName()
Get the principal |
|
Access |
principalType()
Get the principal |
|
Access |
principalTypeScopePrincipalType()
Get the principal |
| Duration |
recommendationLookBackDuration()
Get the recommendation |
| Boolean |
recommendationsEnabled()
Get the recommendations |
| Boolean |
reminderNotificationsEnabled()
Get the reminder |
| String |
resourceId()
Get the resource |
|
List<Access |
reviewers()
Get the reviewers property: This is the collection of reviewers. |
|
Access |
reviewersType()
Get the reviewers |
| String |
roleDefinitionId()
Get the role |
|
Offset |
startDate()
Get the start |
|
Access |
status()
Get the status property: This read-only field specifies the status of an access |
|
Json |
toJson(JsonWriter jsonWriter) |
|
Access |
type()
Get the type property: The recurrence type : weekly, monthly, etc. |
|
Access |
typeRangeType()
Get the type |
| String |
userPrincipalName()
Get the user |
| void |
validate()
Validates the instance. |
|
Access |
withAutoApplyDecisionsEnabled(Boolean autoApplyDecisionsEnabled)
Set the auto |
|
Access |
withBackupReviewers(List<AccessReviewReviewer> backupReviewers)
Set the backup |
|
Access |
withDefaultDecision(DefaultDecisionType defaultDecision)
Set the default |
|
Access |
withDefaultDecisionEnabled(Boolean defaultDecisionEnabled)
Set the default |
|
Access |
withDescriptionForAdmins(String descriptionForAdmins)
Set the description |
|
Access |
withDescriptionForReviewers(String descriptionForReviewers)
Set the description |
|
Access |
withDisplayName(String displayName)
Set the display |
|
Access |
withEndDate(OffsetDateTime endDate)
Set the end |
|
Access |
withInstanceDurationInDays(Integer instanceDurationInDays)
Set the instance |
|
Access |
withInstances(List<AccessReviewInstanceInner> instances)
Set the instances property: This is the collection of instances returned when one does an expand on it. |
|
Access |
withInterval(Integer interval)
Set the interval property: The interval for recurrence. |
|
Access |
withJustificationRequiredOnApproval(Boolean justificationRequiredOnApproval)
Set the justification |
|
Access |
withMailNotificationsEnabled(Boolean mailNotificationsEnabled)
Set the mail |
|
Access |
withNumberOfOccurrences(Integer numberOfOccurrences)
Set the number |
|
Access |
withRecommendationLookBackDuration(Duration recommendationLookBackDuration)
Set the recommendation |
|
Access |
withRecommendationsEnabled(Boolean recommendationsEnabled)
Set the recommendations |
|
Access |
withReminderNotificationsEnabled(Boolean reminderNotificationsEnabled)
Set the reminder |
|
Access |
withReviewers(List<AccessReviewReviewer> reviewers)
Set the reviewers property: This is the collection of reviewers. |
|
Access |
withStartDate(OffsetDateTime startDate)
Set the start |
|
Access |
withType(AccessReviewRecurrencePatternType type)
Set the type property: The recurrence type : weekly, monthly, etc. |
|
Access |
withTypeRangeType(AccessReviewRecurrenceRangeType typeRangeType)
Set the type |
Methods inherited from java.lang.Object
Constructor Details
AccessReviewScheduleDefinitionProperties
public AccessReviewScheduleDefinitionProperties()
Creates an instance of AccessReviewScheduleDefinitionProperties class.
Method Details
assignmentState
public AccessReviewScopeAssignmentState assignmentState()
Get the assignmentState property: The role assignment state eligible/active to review.
Returns:
autoApplyDecisionsEnabled
public Boolean autoApplyDecisionsEnabled()
Get the autoApplyDecisionsEnabled property: 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.
Returns:
backupReviewers
public List<AccessReviewReviewer> backupReviewers()
Get the backupReviewers property: This is the collection of backup reviewers.
Returns:
defaultDecision
public DefaultDecisionType defaultDecision()
Get the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.
Returns:
defaultDecisionEnabled
public Boolean defaultDecisionEnabled()
Get the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
Returns:
descriptionForAdmins
public String descriptionForAdmins()
Get the descriptionForAdmins property: The description provided by the access review creator and visible to admins.
Returns:
descriptionForReviewers
public String descriptionForReviewers()
Get the descriptionForReviewers property: The description provided by the access review creator to be shown to reviewers.
Returns:
displayName
public String displayName()
Get the displayName property: The display name for the schedule definition.
Returns:
endDate
public OffsetDateTime endDate()
Get the endDate property: The DateTime when the review is scheduled to end. Required if type is endDate.
Returns:
excludeResourceId
public String excludeResourceId()
Get the excludeResourceId property: This is used to indicate the resource id(s) to exclude.
Returns:
excludeRoleDefinitionId
public String excludeRoleDefinitionId()
Get the excludeRoleDefinitionId property: This is used to indicate the role definition id(s) to exclude.
Returns:
expandNestedMemberships
public Boolean expandNestedMemberships()
Get the expandNestedMemberships property: Flag to indicate whether to expand nested memberships or not.
Returns:
fromJson
public static AccessReviewScheduleDefinitionProperties fromJson(JsonReader jsonReader)
Reads an instance of AccessReviewScheduleDefinitionProperties from the JsonReader.
Parameters:
Returns:
Throws:
inactiveDuration
public Duration inactiveDuration()
Get the inactiveDuration property: 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)).
Returns:
includeAccessBelowResource
public Boolean includeAccessBelowResource()
Get the includeAccessBelowResource property: Flag to indicate whether to expand nested memberships or not.
Returns:
includeInheritedAccess
public Boolean includeInheritedAccess()
Get the includeInheritedAccess property: Flag to indicate whether to expand nested memberships or not.
Returns:
instanceDurationInDays
public Integer instanceDurationInDays()
Get the instanceDurationInDays property: The duration in days for an instance.
Returns:
instances
public List<AccessReviewInstanceInner> instances()
Get the instances property: This is the collection of instances returned when one does an expand on it.
Returns:
interval
public Integer interval()
Get the interval property: The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
Returns:
justificationRequiredOnApproval
public Boolean justificationRequiredOnApproval()
Get the justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
Returns:
mailNotificationsEnabled
public Boolean mailNotificationsEnabled()
Get the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
Returns:
numberOfOccurrences
public Integer numberOfOccurrences()
Get the numberOfOccurrences property: The number of times to repeat the access review. Required and must be positive if type is numbered.
Returns:
principalId
public String principalId()
Get the principalId property: The identity id.
Returns:
principalName
public String principalName()
Get the principalName property: The identity display name.
Returns:
principalType
public AccessReviewActorIdentityType principalType()
Get the principalType property: The identity type : user/servicePrincipal.
Returns:
principalTypeScopePrincipalType
public AccessReviewScopePrincipalType principalTypeScopePrincipalType()
Get the principalType property: The identity type user/servicePrincipal to review.
Returns:
recommendationLookBackDuration
public Duration recommendationLookBackDuration()
Get the recommendationLookBackDuration property: 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)).
Returns:
recommendationsEnabled
public Boolean recommendationsEnabled()
Get the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.
Returns:
reminderNotificationsEnabled
public Boolean reminderNotificationsEnabled()
Get the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.
Returns:
resourceId
public String resourceId()
Get the resourceId property: ResourceId in which this review is getting created.
Returns:
reviewers
public List<AccessReviewReviewer> reviewers()
Get the reviewers property: This is the collection of reviewers.
Returns:
reviewersType
public AccessReviewScheduleDefinitionReviewersType reviewersType()
Get the reviewersType property: 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.
Returns:
roleDefinitionId
public String roleDefinitionId()
Get the roleDefinitionId property: This is used to indicate the role being reviewed.
Returns:
startDate
public OffsetDateTime startDate()
Get the startDate property: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
Returns:
status
public AccessReviewScheduleDefinitionStatus status()
Get the status property: This read-only field specifies the status of an accessReview.
Returns:
toJson
type
public AccessReviewRecurrencePatternType type()
Get the type property: The recurrence type : weekly, monthly, etc.
Returns:
typeRangeType
public AccessReviewRecurrenceRangeType typeRangeType()
Get the typeRangeType property: The recurrence range type. The possible values are: endDate, noEnd, numbered.
Returns:
userPrincipalName
public String userPrincipalName()
Get the userPrincipalName property: The user principal name(if valid).
Returns:
validate
public void validate()
Validates the instance.
withAutoApplyDecisionsEnabled
public AccessReviewScheduleDefinitionProperties withAutoApplyDecisionsEnabled(Boolean autoApplyDecisionsEnabled)
Set the autoApplyDecisionsEnabled property: 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.
Parameters:
Returns:
withBackupReviewers
public AccessReviewScheduleDefinitionProperties withBackupReviewers(List<AccessReviewReviewer> backupReviewers)
Set the backupReviewers property: This is the collection of backup reviewers.
Parameters:
Returns:
withDefaultDecision
public AccessReviewScheduleDefinitionProperties withDefaultDecision(DefaultDecisionType defaultDecision)
Set the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.
Parameters:
Returns:
withDefaultDecisionEnabled
public AccessReviewScheduleDefinitionProperties withDefaultDecisionEnabled(Boolean defaultDecisionEnabled)
Set the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
Parameters:
Returns:
withDescriptionForAdmins
public AccessReviewScheduleDefinitionProperties withDescriptionForAdmins(String descriptionForAdmins)
Set the descriptionForAdmins property: The description provided by the access review creator and visible to admins.
Parameters:
Returns:
withDescriptionForReviewers
public AccessReviewScheduleDefinitionProperties withDescriptionForReviewers(String descriptionForReviewers)
Set the descriptionForReviewers property: The description provided by the access review creator to be shown to reviewers.
Parameters:
Returns:
withDisplayName
public AccessReviewScheduleDefinitionProperties withDisplayName(String displayName)
Set the displayName property: The display name for the schedule definition.
Parameters:
Returns:
withEndDate
public AccessReviewScheduleDefinitionProperties withEndDate(OffsetDateTime endDate)
Set the endDate property: The DateTime when the review is scheduled to end. Required if type is endDate.
Parameters:
Returns:
withInstanceDurationInDays
public AccessReviewScheduleDefinitionProperties withInstanceDurationInDays(Integer instanceDurationInDays)
Set the instanceDurationInDays property: The duration in days for an instance.
Parameters:
Returns:
withInstances
public AccessReviewScheduleDefinitionProperties withInstances(List<AccessReviewInstanceInner> instances)
Set the instances property: This is the collection of instances returned when one does an expand on it.
Parameters:
Returns:
withInterval
public AccessReviewScheduleDefinitionProperties withInterval(Integer interval)
Set the interval property: The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.
Parameters:
Returns:
withJustificationRequiredOnApproval
public AccessReviewScheduleDefinitionProperties withJustificationRequiredOnApproval(Boolean justificationRequiredOnApproval)
Set the justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
Parameters:
Returns:
withMailNotificationsEnabled
public AccessReviewScheduleDefinitionProperties withMailNotificationsEnabled(Boolean mailNotificationsEnabled)
Set the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
Parameters:
Returns:
withNumberOfOccurrences
public AccessReviewScheduleDefinitionProperties withNumberOfOccurrences(Integer numberOfOccurrences)
Set the numberOfOccurrences property: The number of times to repeat the access review. Required and must be positive if type is numbered.
Parameters:
Returns:
withRecommendationLookBackDuration
public AccessReviewScheduleDefinitionProperties withRecommendationLookBackDuration(Duration recommendationLookBackDuration)
Set the recommendationLookBackDuration property: 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)).
Parameters:
Returns:
withRecommendationsEnabled
public AccessReviewScheduleDefinitionProperties withRecommendationsEnabled(Boolean recommendationsEnabled)
Set the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.
Parameters:
Returns:
withReminderNotificationsEnabled
public AccessReviewScheduleDefinitionProperties withReminderNotificationsEnabled(Boolean reminderNotificationsEnabled)
Set the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.
Parameters:
Returns:
withReviewers
public AccessReviewScheduleDefinitionProperties withReviewers(List<AccessReviewReviewer> reviewers)
Set the reviewers property: This is the collection of reviewers.
Parameters:
Returns:
withStartDate
public AccessReviewScheduleDefinitionProperties withStartDate(OffsetDateTime startDate)
Set the startDate property: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
Parameters:
Returns:
withType
public AccessReviewScheduleDefinitionProperties withType(AccessReviewRecurrencePatternType type)
Set the type property: The recurrence type : weekly, monthly, etc.
Parameters:
Returns:
withTypeRangeType
public AccessReviewScheduleDefinitionProperties withTypeRangeType(AccessReviewRecurrenceRangeType typeRangeType)
Set the typeRangeType property: The recurrence range type. The possible values are: endDate, noEnd, numbered.
Parameters:
Returns: