Package com.azure.resourcemanager.cosmos.models

Class MongoRoleDefinitionCreateUpdateParameters

java.lang.Object
com.azure.resourcemanager.cosmos.models.MongoRoleDefinitionCreateUpdateParameters
public final class MongoRoleDefinitionCreateUpdateParameters extends Object
Parameters to create and update an Azure Cosmos DB Mongo Role Definition.

  • Constructor Details

    • MongoRoleDefinitionCreateUpdateParameters

      public MongoRoleDefinitionCreateUpdateParameters()
      Creates an instance of MongoRoleDefinitionCreateUpdateParameters class.

  • Method Details

    • 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.

    • withRoleName

      public MongoRoleDefinitionCreateUpdateParameters 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 MongoRoleDefinitionCreateUpdateParameters object itself.

    • type

      public MongoRoleDefinitionType type()
      Get the type property: Indicates whether the Role Definition was built-in or user created.
      Returns:
      the type value.

    • withType

      public MongoRoleDefinitionCreateUpdateParameters withType(MongoRoleDefinitionType 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 MongoRoleDefinitionCreateUpdateParameters object itself.

    • databaseName

      public String databaseName()
      Get the databaseName property: The database name for which access is being granted for this Role Definition.
      Returns:
      the databaseName value.

    • withDatabaseName

      public MongoRoleDefinitionCreateUpdateParameters withDatabaseName(String databaseName)
      Set the databaseName property: The database name for which access is being granted for this Role Definition.
      Parameters:
      databaseName - the databaseName value to set.
      Returns:
      the MongoRoleDefinitionCreateUpdateParameters object itself.

    • privileges

      public List<Privilege> privileges()
      Get the privileges property: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
      Returns:
      the privileges value.

    • withPrivileges

      public MongoRoleDefinitionCreateUpdateParameters withPrivileges(List<Privilege> privileges)
      Set the privileges property: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
      Parameters:
      privileges - the privileges value to set.
      Returns:
      the MongoRoleDefinitionCreateUpdateParameters object itself.

    • roles

      public List<Role> roles()
      Get the roles property: The set of roles inherited by this Role Definition.
      Returns:
      the roles value.

    • withRoles

      public MongoRoleDefinitionCreateUpdateParameters withRoles(List<Role> roles)
      Set the roles property: The set of roles inherited by this Role Definition.
      Parameters:
      roles - the roles value to set.
      Returns:
      the MongoRoleDefinitionCreateUpdateParameters object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.