User class

Pacote:

@azure/cosmos

Utilizado para ler, substituir e eliminar Utilizadores.

Além disso, pode aceder às permissões de um determinado utilizador através user.permission de e user.permissions.

Consulte Utilizadores para criar, atualizar, consultar ou ler tudo.

Propriedades

database
id
permissions	Operações para criar, atualizar, consultar ou ler todas as operações. Veja client.permission(id) ler, substituir ou eliminar uma Permissão específica por ID.
url	Devolve um URL de referência ao recurso. Utilizado para ligar em Permissões.

Métodos

delete(RequestOptions)	Elimine o Utilizador especificado.
permission(string)	Operações para ler, substituir ou eliminar uma Permissão específica por ID. Veja client.permissions para criar, atualizar, consultar ou ler todas as operações.
read(RequestOptions)	Leia UserDefinition para o Utilizador especificado.
replace(UserDefinition, RequestOptions)	Substitua a definição do Utilizador especificada pela UserDefinition especificada.

Detalhes de Propriedade

database

database: Database

Valor de Propriedade

Database

id

id: string

Valor de Propriedade

string

permissions

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

Veja client.permission(id) ler, substituir ou eliminar uma Permissão específica por ID.

permissions: Permissions

Valor de Propriedade

Permissions

url

Devolve um URL de referência ao recurso. Utilizado para ligar em Permissões.

string url

Valor de Propriedade

string

Detalhes de Método

delete(RequestOptions)

Elimine o Utilizador especificado.

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

Parâmetros

options

RequestOptions

Devoluções

Promise<UserResponse>

permission(string)

Operações para ler, substituir ou eliminar uma Permissão específica por ID.

Veja client.permissions para criar, atualizar, consultar ou ler todas as operações.

function permission(id: string): Permission

Parâmetros

id

string

Devoluções

Permission

read(RequestOptions)

Leia UserDefinition para o Utilizador especificado.

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

Parâmetros

options

RequestOptions

Devoluções

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Substitua a definição do Utilizador especificada pela UserDefinition especificada.

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

Parâmetros

body

UserDefinition

O UserDefinition especificado para substituir a definição.

options

RequestOptions

Devoluções

Promise<UserResponse>