Package com.azure.resourcemanager.cosmos.models

Class SqlRoleDefinitionCreateUpdateParameters

  • public final class SqlRoleDefinitionCreateUpdateParameters
extends Object
    Parameters to create and update an Azure Cosmos DB SQL Role Definition.

    • Constructor Detail

      • SqlRoleDefinitionCreateUpdateParameters

        public SqlRoleDefinitionCreateUpdateParameters()

    • Method Detail

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

      • type

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

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

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

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

      • permissions

        public List<Permission> permissions()
        Get the permissions property: The set of operations allowed through this Role Definition.
        Returns:
        the permissions value.

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

      • validate

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