Users class
Usado para criar, upsert, consultar e ler todos os usuários.
Consulte usuário para ler, substituir ou excluir um usuário específico por ID.
Propriedades
database |
Métodos
create(User |
Criar um usuário de banco de dados com o UserDefinitionespecificado. exemplo
|
query(Sql |
Consultar todos os usuários. |
query<T>(Sql |
Consultar todos os usuários. exemplo Consultar usuário com id.
|
read |
Ler todos os usuários.- exemplo Leia todos os usuários na matriz.
|
upsert(User |
Upsert um usuário de banco de dados com um UserDefinition especificado. exemplo
|
Detalhes da propriedade
database
Detalhes do método
create(UserDefinition, RequestOptions)
Criar um usuário de banco de dados com o 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" });
await database.users.create({ id: "<user-id>" });
function create(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>
Parâmetros
- body
- UserDefinition
O UserDefinitionespecificado.
- options
- RequestOptions
Retornos
Promise<UserResponse>
query(SqlQuerySpec, FeedOptions)
Consultar todos os usuários.
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
Parâmetros
- query
- SqlQuerySpec
Configuração de consulta para a operação. Consulte sqlQuerySpec para obter mais informações sobre como configurar uma consulta.
- options
- FeedOptions
Retornos
QueryIterator<any>
query<T>(SqlQuerySpec, FeedOptions)
Consultar todos os usuários.
exemplo
Consultar usuário com id.
import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
query: `SELECT * FROM root r WHERE r.id = @user`,
parameters: [{ name: "@user", value: "<user-id>" }],
};
const { resources: permisssion } = await database.users.query(querySpec).fetchAll();
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>
Parâmetros
- query
- SqlQuerySpec
Configuração de consulta para a operação. Consulte sqlQuerySpec para obter mais informações sobre como configurar uma consulta.
- options
- FeedOptions
Retornos
readAll(FeedOptions)
Ler todos os usuários.-
exemplo
Leia todos os usuários na matriz.
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 { resources: usersList } = await database.users.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<UserDefinition & Resource>
Parâmetros
- options
- FeedOptions
Retornos
upsert(UserDefinition, RequestOptions)
Upsert um usuário de banco de dados com um UserDefinition especificado.
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.users.upsert({ id: "<user-id>" });
function upsert(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>
Parâmetros
- body
- UserDefinition
O UserDefinitionespecificado.
- options
- RequestOptions
Retornos
Promise<UserResponse>