User class

database: Database

プロパティ値

id: string

プロパティ値

すべての操作を作成、アップサート、クエリ、読み取るための操作。

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

permissions: Permissions

プロパティ値

リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。

string url

プロパティ値

指定した ユーザーを削除します。

例

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>

パラメーター

戻り値

ID による特定のアクセス許可の読み取り、置換、または削除を行う操作。

すべての操作の作成、アップサート、クエリ、読み取りについては、client.permissions を参照してください。

function permission(id: string): Permission

パラメーター

戻り値

指定された Userの 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>

パラメーター

戻り値

指定した Userの定義を、指定した 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>

パラメーター

戻り値