MongoRoleDefinitionCreateUpdateParameters Class

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

Constructor

MongoRoleDefinitionCreateUpdateParameters(*, role_name: str | None = None, type: str | _models.MongoRoleDefinitionType | None = None, database_name: str | None = None, privileges: list['_models.Privilege'] | None = None, roles: list['_models.Role'] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
role_name	str A user-friendly name for the Role Definition. Must be unique for the database account. Default value: None
type	str or MongoRoleDefinitionType Indicates whether the Role Definition was built-in or user created. Known values are: "BuiltInRole" and "CustomRole". Default value: None
database_name	str The database name for which access is being granted for this Role Definition. Default value: None
privileges	list[Privilege] 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. Default value: None
roles	list[Role] The set of roles inherited by this Role Definition. Default value: None

Variables

Name	Description
role_name	str A user-friendly name for the Role Definition. Must be unique for the database account.
type	str or MongoRoleDefinitionType Indicates whether the Role Definition was built-in or user created. Known values are: "BuiltInRole" and "CustomRole".
database_name	str The database name for which access is being granted for this Role Definition.
privileges	list[Privilege] 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.
roles	list[Role] The set of roles inherited by this Role Definition.