你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Users class

参考

包:: @azure/cosmos

用于创建、更新插入、查询和读取所有用户。

请参阅用户，按 ID 读取、替换或删除特定用户。

属性

方法

create(UserDefinition, RequestOptions)	使用指定的 UserDefinition创建数据库用户。示例 `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)	查询所有用户。
query<T>(SqlQuerySpec, FeedOptions)	查询所有用户。示例查询 id 为 user 的 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)	读取所有用户。- 示例读取所有用户以数组。 `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)	更新具有指定 UserDefinition的数据库用户。示例 `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>" });`

属性详细信息

database

database: Database

属性值

Database

方法详细信息

create(UserDefinition, RequestOptions)

使用指定的 UserDefinition创建数据库用户。

示例

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>

参数

body: UserDefinition

指定的 UserDefinition。

options: RequestOptions

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

查询所有用户。

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

参数

query: SqlQuerySpec

作的查询配置。有关如何配置查询的详细信息，请参阅 SqlQuerySpec。

options: FeedOptions

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

查询所有用户。

示例

查询 id 为 user 的 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>

参数

query: SqlQuerySpec

作的查询配置。有关如何配置查询的详细信息，请参阅 SqlQuerySpec。

options: FeedOptions

QueryIterator<T>

readAll(FeedOptions)

读取所有用户。-

示例

读取所有用户以数组。

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>

参数

options: FeedOptions

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

更新具有指定 UserDefinition的数据库用户。

示例

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>

参数

body: UserDefinition