AccessReviewScheduleDefinitionInner Class

Package:
com.azure.resourcemanager.authorization.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-authorization:2.54.0-beta.1

public final class AccessReviewScheduleDefinitionInner
extends ProxyResource

Access Review Schedule Definition.

Method Summary

Modifier and Type Method and Description
AccessReviewScopeAssignmentState assignmentState()

Get the assignmentState property: The role assignment state eligible/active to review.
Boolean autoApplyDecisionsEnabled()

Get the autoApplyDecisionsEnabled property: Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled.
List<AccessReviewReviewer> backupReviewers()

Get the backupReviewers property: This is the collection of backup reviewers.
DefaultDecisionType defaultDecision()

Get the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.
Boolean defaultDecisionEnabled()

Get the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
String descriptionForAdmins()

Get the descriptionForAdmins property: The description provided by the access review creator and visible to admins.
String descriptionForReviewers()

Get the descriptionForReviewers property: The description provided by the access review creator to be shown to reviewers.
String displayName()

Get the displayName property: The display name for the schedule definition.
OffsetDateTime endDate()

Get the endDate property: The DateTime when the review is scheduled to end.
String excludeResourceId()

Get the excludeResourceId property: This is used to indicate the resource id(s) to exclude.
String excludeRoleDefinitionId()

Get the excludeRoleDefinitionId property: This is used to indicate the role definition id(s) to exclude.
Boolean expandNestedMemberships()

Get the expandNestedMemberships property: Flag to indicate whether to expand nested memberships or not.
static AccessReviewScheduleDefinitionInner fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewScheduleDefinitionInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
Duration inactiveDuration()

Get the inactiveDuration property: Duration users are inactive for.
Boolean includeAccessBelowResource()

Get the includeAccessBelowResource property: Flag to indicate whether to expand nested memberships or not.
Boolean includeInheritedAccess()

Get the includeInheritedAccess property: Flag to indicate whether to expand nested memberships or not.
Integer instanceDurationInDays()

Get the instanceDurationInDays property: The duration in days for an instance.
List<AccessReviewInstanceInner> 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 justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
Boolean mailNotificationsEnabled()

Get the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
String name()

Get the name property: The name of the resource.
Integer numberOfOccurrences()

Get the numberOfOccurrences property: The number of times to repeat the access review.
String principalId()

Get the principalId property: The identity id.
String principalName()

Get the principalName property: The identity display name.
AccessReviewActorIdentityType principalType()

Get the principalType property: The identity type : user/servicePrincipal.
AccessReviewScopePrincipalType principalTypeScopePrincipalType()

Get the principalTypeScopePrincipalType property: The identity type user/servicePrincipal to review.
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.
Boolean recommendationsEnabled()

Get the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.
Boolean reminderNotificationsEnabled()

Get the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.
String resourceId()

Get the resourceId property: ResourceId in which this review is getting created.
List<AccessReviewReviewer> reviewers()

Get the reviewers property: This is the collection of reviewers.
AccessReviewScheduleDefinitionReviewersType reviewersType()

Get the reviewersType property: This field specifies the type of reviewers for a review.
String roleDefinitionId()

Get the roleDefinitionId property: This is used to indicate the role being reviewed.
OffsetDateTime startDate()

Get the startDate property: The DateTime when the review is scheduled to be start.
AccessReviewScheduleDefinitionStatus status()

Get the status property: This read-only field specifies the status of an accessReview.
SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
AccessReviewRecurrencePatternType typePropertiesType()

Get the type property: The recurrence type : weekly, monthly, etc.
AccessReviewRecurrenceRangeType typeRangeType()

Get the typeRangeType property: The recurrence range type.
String userPrincipalName()

Get the userPrincipalName property: The user principal name(if valid).
void validate()

Validates the instance.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

assignmentState

public AccessReviewScopeAssignmentState assignmentState()

Get the assignmentState property: The role assignment state eligible/active to review.

Returns:

the assignmentState value.

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:

the autoApplyDecisionsEnabled value.

backupReviewers

public List<AccessReviewReviewer> backupReviewers()

Get the backupReviewers property: This is the collection of backup reviewers.

Returns:

the backupReviewers value.

defaultDecision

public DefaultDecisionType defaultDecision()

Get the defaultDecision property: This specifies the behavior for the autoReview feature when an access review completes.

Returns:

the defaultDecision value.

defaultDecisionEnabled

public Boolean defaultDecisionEnabled()

Get the defaultDecisionEnabled property: Flag to indicate whether reviewers are required to provide a justification when reviewing access.

Returns:

the defaultDecisionEnabled value.

descriptionForAdmins

public String descriptionForAdmins()

Get the descriptionForAdmins property: The description provided by the access review creator and visible to admins.

Returns:

the descriptionForAdmins value.

descriptionForReviewers

public String descriptionForReviewers()

Get the descriptionForReviewers property: The description provided by the access review creator to be shown to reviewers.

Returns:

the descriptionForReviewers value.

displayName

public String displayName()

Get the displayName property: The display name for the schedule definition.

Returns:

the displayName value.

endDate

public OffsetDateTime endDate()

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

Returns:

the endDate value.

excludeResourceId

public String excludeResourceId()

Get the excludeResourceId property: This is used to indicate the resource id(s) to exclude.

Returns:

the excludeResourceId value.

excludeRoleDefinitionId

public String excludeRoleDefinitionId()

Get the excludeRoleDefinitionId property: This is used to indicate the role definition id(s) to exclude.

Returns:

the excludeRoleDefinitionId value.

expandNestedMemberships

public Boolean expandNestedMemberships()

Get the expandNestedMemberships property: Flag to indicate whether to expand nested memberships or not.

Returns:

the expandNestedMemberships value.

fromJson

public static AccessReviewScheduleDefinitionInner fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewScheduleDefinitionInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AccessReviewScheduleDefinitionInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

AccessReviewScheduleDefinitionInner.id()

Returns:

the id value.

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:

the inactiveDuration value.

includeAccessBelowResource

public Boolean includeAccessBelowResource()

Get the includeAccessBelowResource property: Flag to indicate whether to expand nested memberships or not.

Returns:

the includeAccessBelowResource value.

includeInheritedAccess

public Boolean includeInheritedAccess()

Get the includeInheritedAccess property: Flag to indicate whether to expand nested memberships or not.

Returns:

the includeInheritedAccess value.

instanceDurationInDays

public Integer instanceDurationInDays()

Get the instanceDurationInDays property: The duration in days for an instance.

Returns:

the instanceDurationInDays value.

instances

public List<AccessReviewInstanceInner> instances()

Get the instances property: This is the collection of instances returned when one does an expand on it.

Returns:

the instances value.

interval

public Integer interval()

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

Returns:

the interval value.

justificationRequiredOnApproval

public Boolean justificationRequiredOnApproval()

Get the justificationRequiredOnApproval property: Flag to indicate whether the reviewer is required to pass justification when recording a decision.

Returns:

the justificationRequiredOnApproval value.

mailNotificationsEnabled

public Boolean mailNotificationsEnabled()

Get the mailNotificationsEnabled property: Flag to indicate whether sending mails to reviewers and the review creator is enabled.

Returns:

the mailNotificationsEnabled value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

AccessReviewScheduleDefinitionInner.name()

Returns:

the name value.

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:

the numberOfOccurrences value.

principalId

public String principalId()

Get the principalId property: The identity id.

Returns:

the principalId value.

principalName

public String principalName()

Get the principalName property: The identity display name.

Returns:

the principalName value.

principalType

public AccessReviewActorIdentityType principalType()

Get the principalType property: The identity type : user/servicePrincipal.

Returns:

the principalType value.

principalTypeScopePrincipalType

public AccessReviewScopePrincipalType principalTypeScopePrincipalType()

Get the principalTypeScopePrincipalType property: The identity type user/servicePrincipal to review.

Returns:

the principalTypeScopePrincipalType value.

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:

the recommendationLookBackDuration value.

recommendationsEnabled

public Boolean recommendationsEnabled()

Get the recommendationsEnabled property: Flag to indicate whether showing recommendations to reviewers is enabled.

Returns:

the recommendationsEnabled value.

reminderNotificationsEnabled

public Boolean reminderNotificationsEnabled()

Get the reminderNotificationsEnabled property: Flag to indicate whether sending reminder emails to reviewers are enabled.

Returns:

the reminderNotificationsEnabled value.

resourceId

public String resourceId()

Get the resourceId property: ResourceId in which this review is getting created.

Returns:

the resourceId value.

reviewers

public List<AccessReviewReviewer> reviewers()

Get the reviewers property: This is the collection of reviewers.

Returns:

the reviewers value.

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:

the reviewersType value.

roleDefinitionId

public String roleDefinitionId()

Get the roleDefinitionId property: This is used to indicate the role being reviewed.

Returns:

the roleDefinitionId value.

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:

the startDate value.

status

public AccessReviewScheduleDefinitionStatus status()

Get the status property: This read-only field specifies the status of an accessReview.

Returns:

the status value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AccessReviewScheduleDefinitionInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

AccessReviewScheduleDefinitionInner.type()

Returns:

the type value.

typePropertiesType

public AccessReviewRecurrencePatternType typePropertiesType()

Get the type property: The recurrence type : weekly, monthly, etc.

Returns:

the type value.

typeRangeType

public AccessReviewRecurrenceRangeType typeRangeType()

Get the typeRangeType property: The recurrence range type. The possible values are: endDate, noEnd, numbered.

Returns:

the typeRangeType value.

userPrincipalName

public String userPrincipalName()

Get the userPrincipalName property: The user principal name(if valid).

Returns:

the userPrincipalName value.

validate

public void validate()

Validates the instance.

Applies to