User class

  • Referência
Pacote:
@azure/cosmos

Usado para ler, substituir e excluir Usuários.

Além disso, você pode acessar as permissões para um determinado usuário por meio de user.permission e user.permissions.

Consulte Usuários para criar, upsert, consultar ou ler tudo.

Propriedades

database
id
permissions

Operações para criar, aumentar, consultar ou ler todas as operações.

Consulte client.permission(id) para ler, substituir ou excluir uma permissão específica por id.
url

Retorna uma URL de referência para o recurso. Usado para vinculação em Permissões.

Métodos

delete(RequestOptions)

Exclua o usuário especificado.
permission(string)

Operações para ler, substituir ou excluir uma permissão específica por id.

Consulte client.permissions para criar, aumentar, consultar ou ler todas as operações.
read(RequestOptions)

Leia o UserDefinition para o usuário especificado.
replace(UserDefinition, RequestOptions)

Substitua a definição de Usuário fornecida pelo UserDefinition especificado.

Detalhes da propriedade

database 

database: Database

Valor da propriedade

Database

id 

id: string

Valor da propriedade

string

permissions

Operações para criar, aumentar, consultar ou ler todas as operações.

Consulte client.permission(id) para ler, substituir ou excluir uma permissão específica por id.

permissions: Permissions

Valor da propriedade

Permissions

url

Retorna uma URL de referência para o recurso. Usado para vinculação em Permissões.

string url

Valor da propriedade

string

Detalhes do método

delete(RequestOptions)

Exclua o usuário especificado.

function delete(options?: RequestOptions): Promise<UserResponse>

Parâmetros

options
RequestOptions

Retornos

Promise<UserResponse>

permission(string)

Operações para ler, substituir ou excluir uma permissão específica por id.

Consulte client.permissions para criar, aumentar, consultar ou ler todas as operações.

function permission(id: string): Permission

Parâmetros

id

string

Retornos

Permission

read(RequestOptions)

Leia o UserDefinition para o usuário especificado.

function read(options?: RequestOptions): Promise<UserResponse>

Parâmetros

options
RequestOptions

Retornos

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Substitua a definição de Usuário fornecida pelo UserDefinition especificado.

function replace(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

Parâmetros

body
UserDefinition

O UserDefinition especificado para substituir a definição.

options
RequestOptions

Retornos

Promise<UserResponse>