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

User class

包:

@azure/cosmos

用于读取、替换和删除用户。

此外，还可以通过 user.permission 和 user.permissions访问给定用户的权限。

请参阅 要 创建、更新插入、查询或读取全部的用户。

属性

database
id
permissions	用于创建、更新插入、查询或读取所有操作的操作。 请参阅 client.permission(id) 按 ID 读取、替换或删除特定权限。
url	返回资源的引用 URL。 用于在“权限”中链接。

方法

delete(RequestOptions)	删除给定 的用户。
permission(string)	按 ID 读取、替换或删除特定权限的操作。 有关创建、更新插入、查询或读取所有操作，请参阅 client.permissions 。
read(RequestOptions)	读取给定用户的UserDefinition。
replace(UserDefinition, RequestOptions)	将给定 用户的定义替换为指定的 UserDefinition。

属性详细信息

database

database: Database

属性值

Database

id

id: string

属性值

string

permissions

用于创建、更新插入、查询或读取所有操作的操作。

请参阅 client.permission(id) 按 ID 读取、替换或删除特定权限。

permissions: Permissions

属性值

Permissions

url

返回资源的引用 URL。 用于在“权限”中链接。

string url

属性值

string

方法详细信息

delete(RequestOptions)

删除给定 的用户。

function delete(options?: RequestOptions): Promise<UserResponse>

参数

options

RequestOptions

返回

Promise<UserResponse>

permission(string)

按 ID 读取、替换或删除特定权限的操作。

有关创建、更新插入、查询或读取所有操作，请参阅 client.permissions 。

function permission(id: string): Permission

参数

id

string

返回

Permission

read(RequestOptions)

读取给定用户的UserDefinition。

function read(options?: RequestOptions): Promise<UserResponse>

参数

options

RequestOptions

返回

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

将给定 用户的定义替换为指定的 UserDefinition。

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

参数

body

UserDefinition

要替换定义的指定 UserDefinition 。

options

RequestOptions

返回

Promise<UserResponse>