SqlRoleDefinitionCreateUpdateParameters Class

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

Inheritance

Model

SqlRoleDefinitionCreateUpdateParameters

Constructor

SqlRoleDefinitionCreateUpdateParameters(*, role_name: Optional[str] = None, type: Optional[Union[str, _models.RoleDefinitionType]] = None, assignable_scopes: Optional[List[str]] = None, permissions: Optional[List[_models.Permission]] = None, **kwargs)

Variables

role_name

str

A user-friendly name for the Role Definition. Must be unique for the database account.

type

str or RoleDefinitionType

Indicates whether the Role Definition was built-in or user created. Known values are: "BuiltInRole", "CustomRole".

assignable_scopes

list[str]

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.

permissions

list[Permission]

The set of operations allowed through this Role Definition.