User class
属性
database | |
id | |
permissions | 用于创建、更新插入、查询或读取所有作的作。 请参阅 |
url | 返回资源的引用 URL。 用于在权限中链接。 |
方法
delete(Request |
删除给定 用户。 示例
|
permission(string) | 按 ID 读取、替换或删除特定权限的作。 请参阅 |
read(Request |
读取给定 用户的 UserDefinition。 示例
|
replace(User |
将给定 用户的定义替换为指定的 UserDefinition。 示例
|
属性详细信息
database
id
id: string
属性值
string
permissions
用于创建、更新插入、查询或读取所有作的作。
请参阅 client.permission(id)
,按 ID 读取、替换或删除特定权限。
permissions: Permissions
属性值
url
返回资源的引用 URL。 用于在权限中链接。
string url
属性值
string
方法详细信息
delete(RequestOptions)
删除给定 用户。
示例
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.user("<user-id>").delete();
function delete(options?: RequestOptions): Promise<UserResponse>
参数
- options
- RequestOptions
返回
Promise<UserResponse>
permission(string)
按 ID 读取、替换或删除特定权限的作。
请参阅 client.permissions
,了解如何创建、更新插入、查询或读取所有作。
function permission(id: string): Permission
参数
- id
-
string
返回
read(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" });
const { resource: user } = await database.user("<user-id>").read();
function read(options?: RequestOptions): Promise<UserResponse>
参数
- options
- RequestOptions
返回
Promise<UserResponse>
replace(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" });
const { resource: user } = await database.user("<user-id>").read();
user.id = "<new user id>";
await database.user("<user-id>").replace(user);
function replace(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>
参数
- body
- UserDefinition
要替换定义的指定 UserDefinition。
- options
- RequestOptions
返回
Promise<UserResponse>