次の方法で共有

Permission class

  • リファレンス
パッケージ:
@azure/cosmos

特定の Permission を 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)

特定の Permissionの 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)

指定した Permission を、指定した 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)

特定の Permissionの 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)

指定した Permission を、指定した 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>