通过

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

Permission class

  • 参考
包:
@azure/cosmos

用于按 ID 读取、替换或删除给定 权限。

请参阅 权限 来创建、更新插入、查询或读取所有权限。

属性

id
url

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

方法

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" });
const user = database.user("<user-id>");

await user.permission("<permission-id>").delete();
read(RequestOptions)

读取给定 权限的 PermissionDefinition。

示例

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 user = database.user("<user-id>");

const { resource: permission } = await user.permission("<permission-id>").read();
replace(PermissionDefinition, RequestOptions)

将给定 权限 替换为指定的 PermissionDefinition。

示例

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 user = database.user("<user-id>");
const { resource: permission } = await user.permission("<permission-id>").read();
permission.resource = "<new-resource-url>";

await user.permission("<permission-id>").replace(permission);

属性详细信息

id 

id: string

属性值

string

url

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

string url

属性值

string

user 

user: User

属性值

User

方法详细信息

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" });
const user = database.user("<user-id>");

await user.permission("<permission-id>").delete();

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

参数

options
RequestOptions

返回

Promise<PermissionResponse>

read(RequestOptions)

读取给定 权限的 PermissionDefinition。

示例

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 user = database.user("<user-id>");

const { resource: permission } = await user.permission("<permission-id>").read();

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

参数

options
RequestOptions

返回

Promise<PermissionResponse>

replace(PermissionDefinition, RequestOptions)

将给定 权限 替换为指定的 PermissionDefinition。

示例

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 user = database.user("<user-id>");
const { resource: permission } = await user.permission("<permission-id>").read();
permission.resource = "<new-resource-url>";

await user.permission("<permission-id>").replace(permission);

function replace(body: PermissionDefinition, options?: RequestOptions): Promise<PermissionResponse>

参数

body
PermissionDefinition

指定的 PermissionDefinition。

options
RequestOptions

返回

Promise<PermissionResponse>