MongoUserDefinitionGetResults interface

An Azure Cosmos DB User Definition

Extends

Properties

customData

A custom definition for the USer Definition.

databaseName

The database name for which access is being granted for this User Definition.

mechanisms

The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.

password

The password for User Definition. Response does not contain user password.

roles

The set of roles inherited by the User Definition.

userName

The user name for User Definition.

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

customData

A custom definition for the USer Definition.

customData?: string

Property Value

string

databaseName

The database name for which access is being granted for this User Definition.

databaseName?: string

Property Value

string

mechanisms

The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.

mechanisms?: string

Property Value

string

password

The password for User Definition. Response does not contain user password.

password?: string

Property Value

string

roles

The set of roles inherited by the User Definition.

roles?: Role[]

Property Value

Role[]

userName

The user name for User Definition.

userName?: string

Property Value

string

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