SqlRoleDefinitionCreateUpdateParameters Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.54.1

• java.lang.Object
• • com.azure.resourcemanager.cosmos.models.SqlRoleDefinitionCreateUpdateParameters

Implements

JsonSerializable<SqlRoleDefinitionCreateUpdateParameters>

public final class SqlRoleDefinitionCreateUpdateParameters
implements JsonSerializable<SqlRoleDefinitionCreateUpdateParameters>

Parameters to create and update an Azure Cosmos DB SQL Role Definition.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
List<String>	assignableScopes() Get the assignableScopes property: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition.
static SqlRoleDefinitionCreateUpdateParameters	fromJson(JsonReader jsonReader) Reads an instance of SqlRoleDefinitionCreateUpdateParameters from the JsonReader.
List<Permission>	permissions() Get the permissions property: The set of operations allowed through this Role Definition.
String	roleName() Get the roleName property: A user-friendly name for the Role Definition.
JsonWriter	toJson(JsonWriter jsonWriter)
RoleDefinitionType	type() Get the type property: Indicates whether the Role Definition was built-in or user created.
void	validate() Validates the instance.
SqlRoleDefinitionCreateUpdateParameters	withAssignableScopes(List<String> assignableScopes) Set the assignableScopes property: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition.
SqlRoleDefinitionCreateUpdateParameters	withPermissions(List<Permission> permissions) Set the permissions property: The set of operations allowed through this Role Definition.
SqlRoleDefinitionCreateUpdateParameters	withRoleName(String roleName) Set the roleName property: A user-friendly name for the Role Definition.
SqlRoleDefinitionCreateUpdateParameters	withType(RoleDefinitionType type) Set the type property: Indicates whether the Role Definition was built-in or user created.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlRoleDefinitionCreateUpdateParameters

public SqlRoleDefinitionCreateUpdateParameters()

Creates an instance of SqlRoleDefinitionCreateUpdateParameters class.

Method Details

assignableScopes

public List<String> assignableScopes()

Get the assignableScopes property: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.

Returns:

the assignableScopes value.

fromJson

public static SqlRoleDefinitionCreateUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of SqlRoleDefinitionCreateUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SqlRoleDefinitionCreateUpdateParameters 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 SqlRoleDefinitionCreateUpdateParameters.

permissions

public List<Permission> permissions()

Get the permissions property: The set of operations allowed through this Role Definition.

Returns:

the permissions value.

roleName

public String roleName()

Get the roleName property: A user-friendly name for the Role Definition. Must be unique for the database account.

Returns:

the roleName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public RoleDefinitionType type()

Get the type property: Indicates whether the Role Definition was built-in or user created.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAssignableScopes

public SqlRoleDefinitionCreateUpdateParameters withAssignableScopes(List<String> assignableScopes)

Set the assignableScopes property: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.

Parameters:

assignableScopes - the assignableScopes value to set.

Returns:

the SqlRoleDefinitionCreateUpdateParameters object itself.

withPermissions

public SqlRoleDefinitionCreateUpdateParameters withPermissions(List<Permission> permissions)

Set the permissions property: The set of operations allowed through this Role Definition.

Parameters:

permissions - the permissions value to set.

Returns:

the SqlRoleDefinitionCreateUpdateParameters object itself.

withRoleName

public SqlRoleDefinitionCreateUpdateParameters withRoleName(String roleName)

Set the roleName property: A user-friendly name for the Role Definition. Must be unique for the database account.

Parameters:

roleName - the roleName value to set.

Returns:

the SqlRoleDefinitionCreateUpdateParameters object itself.

withType

public SqlRoleDefinitionCreateUpdateParameters withType(RoleDefinitionType type)

Set the type property: Indicates whether the Role Definition was built-in or user created.

Parameters:

type - the type value to set.

Returns:

the SqlRoleDefinitionCreateUpdateParameters object itself.