SqlRoleDefinitionCreateUpdateParameters interface

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

Properties

assignableScopes

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

The set of operations allowed through this Role Definition.

roleName

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

type

Indicates whether the Role Definition was built-in or user created.

Property Details

assignableScopes

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.

assignableScopes?: string[]

Property Value

string[]

permissions

The set of operations allowed through this Role Definition.

permissions?: Permission[]

Property Value

roleName

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

roleName?: string

Property Value

string

type

Indicates whether the Role Definition was built-in or user created.

type?: RoleDefinitionType

Property Value