SqlRoleDefinitionGetResults interface

Package:

@azure/arm-cosmosdb

An Azure Cosmos DB SQL Role Definition.

Extends

ARMProxyResource

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.
typePropertiesType	Indicates whether the Role Definition was built-in or user created.

Inherited Properties

id	The unique resource identifier of the database account. NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the database account. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of Azure resource. NOTE: This property will not be serialized. It can only be populated by the server.

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

Permission[]

roleName

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

roleName?: string

Property Value

string

typePropertiesType

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

typePropertiesType?: RoleDefinitionType

Property Value

RoleDefinitionType

Inherited Property Details

id

The unique resource identifier of the database account. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ARMProxyResource.id

name

The name of the database account. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ARMProxyResource.name

type

The type of Azure resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ARMProxyResource.type