Users class

Paket:

@azure/cosmos

Används för att skapa, upsert, fråga och läsa alla användare.

Läs användare för att läsa, ersätta eller ta bort en specifik användare med ID.

Egenskaper

database

Metoder

create(UserDefinition, RequestOptions)	Skapa en databasanvändare med angiven UserDefinition. Exempel 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)	Fråga alla användare.
query<T>(SqlQuerySpec, FeedOptions)	Fråga alla användare. Exempel Fråga användaren med 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)	Läs alla användare.- Exempel Läs alla användare till matrisen. 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)	Anslut en databasanvändare med en angiven UserDefinition. Exempel 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>" });

Egenskapsinformation

database

database: Database

Egenskapsvärde

Database

Metodinformation

create(UserDefinition, RequestOptions)

Skapa en databasanvändare med angiven UserDefinition.

Exempel

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>

Parametrar

body

UserDefinition

Den angivna UserDefinition.

options

RequestOptions

Returer

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

Fråga alla användare.

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

Parametrar

query

SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options

FeedOptions

Returer

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Fråga alla användare.

Exempel

Fråga användaren med 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>

Parametrar

query

SqlQuerySpec

Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec.

options

FeedOptions

Returer

QueryIterator<T>

readAll(FeedOptions)

Läs alla användare.-

Exempel

Läs alla användare till matrisen.

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>

Parametrar

options

FeedOptions

Returer

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

Anslut en databasanvändare med en angiven UserDefinition.

Exempel

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>

Parametrar

body

UserDefinition

Den angivna UserDefinition.

options

RequestOptions

Returer

Promise<UserResponse>