Users class

Paquet:

@azure/cosmos

Utilisé pour créer, upsert, interroger et lire tous les utilisateurs.

Consultez 'utilisateur pour lire, remplacer ou supprimer un utilisateur spécifique par ID.

Propriétés

database

Méthodes

create(UserDefinition, RequestOptions)	Créez un utilisateur de base de données avec le UserDefinition spécifié. exemple 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)	Interrogez tous les utilisateurs.
query<T>(SqlQuerySpec, FeedOptions)	Interrogez tous les utilisateurs. exemple de Interroger l’utilisateur avec l’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)	Lire tous les utilisateurs.- exemple de Lisez tous les utilisateurs dans le tableau. 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 utilisateur de base de données avec un UserDefinition spécifié. exemple 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>" });

Détails de la propriété

database

database: Database

Valeur de propriété

Database

Détails de la méthode

create(UserDefinition, RequestOptions)

Créez un utilisateur de base de données avec le UserDefinition spécifié.

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

Paramètres

body

UserDefinition

Le UserDefinition spécifié.

options

RequestOptions

Retours

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Interrogez tous les utilisateurs.

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

Paramètres

query

SqlQuerySpec

Configuration de requête pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec.

options

FeedOptions

Retours

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Interrogez tous les utilisateurs.

exemple de

Interroger l’utilisateur avec l’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>

Paramètres

query

SqlQuerySpec

Configuration de requête pour l’opération. Pour plus d’informations sur la configuration d’une requête, consultez SqlQuerySpec.

options

FeedOptions

Retours

QueryIterator<T>

readAll(FeedOptions)

Lire tous les utilisateurs.-

exemple de

Lisez tous les utilisateurs dans le tableau.

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>

Paramètres

options

FeedOptions

Retours

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Upsert un utilisateur de base de données avec un UserDefinition spécifié.

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

Paramètres

body

UserDefinition

Le UserDefinition spécifié.

options

RequestOptions

Retours

Promise<UserResponse>