Compartir a través de

Users class

  • Referencia
Paquete:
@azure/cosmos

Se usa para crear, upsert, consultar y leer todos los usuarios.

Consulte usuario para leer, reemplazar o eliminar un usuario específico por identificador.

Propiedades

database

Métodos

create(UserDefinition, RequestOptions)

Cree un usuario de base de datos con el UserDefinition especificado.

de ejemplo de

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>" });
query(SqlQuerySpec, FeedOptions)

Consulta a todos los usuarios.
query<T>(SqlQuerySpec, FeedOptions)

Consulta a todos los usuarios.

de ejemplo de

Consultar usuario con 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();
readAll(FeedOptions)

Leer todos los usuarios.

de ejemplo de

Lee todos los usuarios en la 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();
upsert(UserDefinition, RequestOptions)

Upsert un usuario de base de datos con un UserDefinition especificado.

de ejemplo de

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>" });

Detalles de las propiedades

database 

database: Database

Valor de propiedad

Database

Detalles del método

create(UserDefinition, RequestOptions)

Cree un usuario de base de datos con el UserDefinition especificado.

de ejemplo de

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

El UserDefinition especificado.

options
RequestOptions

Devoluciones

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Consulta a todos los usuarios.

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consulta a todos los usuarios.

de ejemplo de

Consultar usuario con 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

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<T>

readAll(FeedOptions)

Leer todos los usuarios.

de ejemplo de

Lee todos los usuarios en la 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

Devoluciones

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Upsert un usuario de base de datos con un UserDefinition especificado.

de ejemplo de

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

El UserDefinition especificado.

options
RequestOptions

Devoluciones

Promise<UserResponse>