Partilhar 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 via user.permission e user.permissions.

Consulte Usuários criar, atualizar, consultar ou ler tudo.

Propriedades

database
id
permissions

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

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

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

Métodos

delete(RequestOptions)

Exclua o fornecido Usuário.

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 por id específica.

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

Leia o UserDefinition para o de usuáriofornecido.

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 de do Userpelo especificado UserDefinition.

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 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.

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

permissions: Permissions

Valor de Propriedade

Permissions

url

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

string url

Valor de Propriedade

string

Detalhes de Método

delete(RequestOptions)

Exclua o fornecido Usuário.

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

Devoluções

Promise<UserResponse>

permission(string)

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

Consulte 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 o UserDefinition para o de usuáriofornecido.

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

Devoluções

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Substitua a definição de do Userpelo especificado UserDefinition.

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 especificado UserDefinition para substituir a definição.

options
RequestOptions

Devoluções

Promise<UserResponse>