Compartilhar via

User class

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 criação, upserting, consulta ou leitura de 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 vincular em Permissões.

Métodos

delete(RequestOptions)

Exclua o de Usuário doespecificado.

Exemplo

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

await database.user("<user-id>").delete();
permission(string)

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

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

Leia o UserDefinition para o de usuário dedeterminado.

Exemplo

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { resource: user } = await database.user("<user-id>").read();
replace(UserDefinition, RequestOptions)

Substitua a definição do usuário pelo UserDefinitionespecificado.

Exemplo

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { resource: user } = await database.user("<user-id>").read();
user.id = "<new user id>";

await database.user("<user-id>").replace(user);

Detalhes da propriedade

database 

database: Database

Valor da propriedade

Database

id 

id: string

Valor da propriedade

string

permissions

Operações para criação, upserting, consulta ou leitura de 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 vincular em Permissões.

string url

Valor da propriedade

string

Detalhes do método

delete(RequestOptions)

Exclua o de Usuário doespecificado.

Exemplo

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

await database.user("<user-id>").delete();

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, fazer upserting, 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 de usuário dedeterminado.

Exemplo

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { resource: user } = await database.user("<user-id>").read();

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

Parâmetros

options
RequestOptions

Retornos

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Substitua a definição do usuário pelo UserDefinitionespecificado.

Exemplo

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { resource: user } = await database.user("<user-id>").read();
user.id = "<new user id>";

await database.user("<user-id>").replace(user);

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>