次の方法で共有

Permissions class

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

すべてのアクセス許可の作成、置換、クエリ、読み取りに使用します。

ID による特定のアクセス許可の読み取り、置換、または削除については、「アクセス許可の」を参照してください。

プロパティ

user

メソッド

create(PermissionDefinition, RequestOptions)

アクセス許可を作成します。

アクセス許可は、特定のリソース (アイテムやコンテナーなど) にアクセスするためのユーザーごとのアクセス許可を表します。

例

import { CosmosClient, PermissionDefinition, PermissionMode } 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 } = await database.users.create({ id: "<user-id>" });

const permissionDefinition: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};
await user.permissions.create(permissionDefinition);
query(SqlQuerySpec, FeedOptions)

すべてのアクセス許可に対してクエリを実行します。

例

ID を使用したクエリ権限。

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @permission`,
  parameters: [{ name: "@permission", value: "<permission-id>" }],
};
const { resources: permisssion } = await database
  .user("<user-id>")
  .permissions.query(querySpec)
  .fetchAll();
query<T>(SqlQuerySpec, FeedOptions)

すべてのアクセス許可に対してクエリを実行します。
readAll(FeedOptions)

すべてのアクセス許可を読み取る。

例

配列に対するすべてのアクセス許可を読み取る。

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 { resources: permissionList } = await database.user("user1").permissions.readAll().fetchAll();
upsert(PermissionDefinition, RequestOptions)

権限をアップサートします。 アクセス許可は、特定のリソース (アイテムやコンテナーなど) にアクセスするためのユーザーごとのアクセス許可を表します。

例

import { CosmosClient, PermissionDefinition, PermissionMode } 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 permissionDefinitionToUpsert: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};

await user.permissions.upsert(permissionDefinitionToUpsert);

プロパティの詳細

user 

user: User

プロパティ値

User

メソッドの詳細

create(PermissionDefinition, RequestOptions)

アクセス許可を作成します。

アクセス許可は、特定のリソース (アイテムやコンテナーなど) にアクセスするためのユーザーごとのアクセス許可を表します。

例

import { CosmosClient, PermissionDefinition, PermissionMode } 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 } = await database.users.create({ id: "<user-id>" });

const permissionDefinition: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};
await user.permissions.create(permissionDefinition);

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

パラメーター

body
PermissionDefinition

アクセス許可の本文を表します。

options
RequestOptions

戻り値

Promise<PermissionResponse>

query(SqlQuerySpec, FeedOptions)

すべてのアクセス許可に対してクエリを実行します。

例

ID を使用したクエリ権限。

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @permission`,
  parameters: [{ name: "@permission", value: "<permission-id>" }],
};
const { resources: permisssion } = await database
  .user("<user-id>")
  .permissions.query(querySpec)
  .fetchAll();

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)

すべてのアクセス許可を読み取る。

例

配列に対するすべてのアクセス許可を読み取る。

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 { resources: permissionList } = await database.user("user1").permissions.readAll().fetchAll();

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

パラメーター

options
FeedOptions

戻り値

QueryIterator<PermissionDefinition & Resource>

upsert(PermissionDefinition, RequestOptions)

権限をアップサートします。 アクセス許可は、特定のリソース (アイテムやコンテナーなど) にアクセスするためのユーザーごとのアクセス許可を表します。

例

import { CosmosClient, PermissionDefinition, PermissionMode } 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 permissionDefinitionToUpsert: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};

await user.permissions.upsert(permissionDefinitionToUpsert);

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

パラメーター

body
PermissionDefinition
options
RequestOptions

戻り値

Promise<PermissionResponse>