AccessReviewScope Class

Package:

com.azure.resourcemanager.authorization.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-authorization:2.54.0-beta.1

• java.lang.Object
• • com.azure.resourcemanager.authorization.fluent.models.AccessReviewScope

Implements

JsonSerializable<AccessReviewScope>

public final class AccessReviewScope
implements JsonSerializable<AccessReviewScope>

Descriptor for what needs to be reviewed.

Constructor Summary

Constructor	Description
AccessReviewScope()	Creates an instance of AccessReviewScope class.

Method Summary

Modifier and Type	Method and Description
AccessReviewScopeAssignmentState	assignmentState() Get the assignmentState property: The role assignment state eligible/active to review.
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 AccessReviewScope	fromJson(JsonReader jsonReader) Reads an instance of AccessReviewScope from the JsonReader.
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.
AccessReviewScopePrincipalType	principalType() Get the principalType property: The identity type user/servicePrincipal to review.
String	resourceId() Get the resourceId property: ResourceId in which this review is getting created.
String	roleDefinitionId() Get the roleDefinitionId property: This is used to indicate the role being reviewed.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
AccessReviewScope	withExcludeResourceId(String excludeResourceId) Set the excludeResourceId property: This is used to indicate the resource id(s) to exclude.
AccessReviewScope	withExcludeRoleDefinitionId(String excludeRoleDefinitionId) Set the excludeRoleDefinitionId property: This is used to indicate the role definition id(s) to exclude.
AccessReviewScope	withExpandNestedMemberships(Boolean expandNestedMemberships) Set the expandNestedMemberships property: Flag to indicate whether to expand nested memberships or not.
AccessReviewScope	withInactiveDuration(Duration inactiveDuration) Set the inactiveDuration property: Duration users are inactive for.
AccessReviewScope	withIncludeAccessBelowResource(Boolean includeAccessBelowResource) Set the includeAccessBelowResource property: Flag to indicate whether to expand nested memberships or not.
AccessReviewScope	withIncludeInheritedAccess(Boolean includeInheritedAccess) Set the includeInheritedAccess property: Flag to indicate whether to expand nested memberships or not.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AccessReviewScope

public AccessReviewScope()

Creates an instance of AccessReviewScope class.

Method Details

assignmentState

public AccessReviewScopeAssignmentState assignmentState()

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

Returns:

the assignmentState 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 AccessReviewScope fromJson(JsonReader jsonReader)

Reads an instance of AccessReviewScope from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the AccessReviewScope.

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.

principalType

public AccessReviewScopePrincipalType principalType()

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

Returns:

the principalType value.

resourceId

public String resourceId()

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

Returns:

the resourceId value.

roleDefinitionId

public String roleDefinitionId()

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

Returns:

the roleDefinitionId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withExcludeResourceId

public AccessReviewScope withExcludeResourceId(String excludeResourceId)

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

Parameters:

excludeResourceId - the excludeResourceId value to set.

Returns:

the AccessReviewScope object itself.

withExcludeRoleDefinitionId

public AccessReviewScope withExcludeRoleDefinitionId(String excludeRoleDefinitionId)

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

Parameters:

excludeRoleDefinitionId - the excludeRoleDefinitionId value to set.

Returns:

the AccessReviewScope object itself.

withExpandNestedMemberships

public AccessReviewScope withExpandNestedMemberships(Boolean expandNestedMemberships)

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

Parameters:

expandNestedMemberships - the expandNestedMemberships value to set.

Returns:

the AccessReviewScope object itself.

withInactiveDuration

public AccessReviewScope withInactiveDuration(Duration inactiveDuration)

Set 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)).

Parameters:

inactiveDuration - the inactiveDuration value to set.

Returns:

the AccessReviewScope object itself.

withIncludeAccessBelowResource

public AccessReviewScope withIncludeAccessBelowResource(Boolean includeAccessBelowResource)

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

Parameters:

includeAccessBelowResource - the includeAccessBelowResource value to set.

Returns:

the AccessReviewScope object itself.

withIncludeInheritedAccess

public AccessReviewScope withIncludeInheritedAccess(Boolean includeInheritedAccess)

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

Parameters:

includeInheritedAccess - the includeInheritedAccess value to set.

Returns:

the AccessReviewScope object itself.