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

Users class

参考

包:: @azure/cosmos

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

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

属性

方法

create(UserDefinition, RequestOptions)	使用指定的 UserDefinition 创建数据库用户。
query(SqlQuerySpec, FeedOptions)	查询所有用户。
query<T>(SqlQuerySpec, FeedOptions)	查询所有用户。
readAll(FeedOptions)	读取所有用户。- 示例将所有用户读到数组。 `const {body: usersList} = await database.users.readAll().fetchAll();`
upsert(UserDefinition, RequestOptions)	使用指定的 UserDefinition 插入数据库用户。

属性详细信息

database

database: Database

属性值

Database

方法详细信息

create(UserDefinition, RequestOptions)

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

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)

查询所有用户。

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

参数

query: SqlQuerySpec

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

options: FeedOptions

QueryIterator<T>

readAll(FeedOptions)

读取所有用户。-

示例

将所有用户读到数组。

const {body: usersList} = await database.users.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<UserDefinition & Resource>

参数

options: FeedOptions

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

使用指定的 UserDefinition 插入数据库用户。

function upsert(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

参数

body: UserDefinition