다음을 통해 공유

User class

패키지:
@azure/cosmos

사용자를 읽고, 바꾸고, 삭제하는 데 사용됩니다.

또한 user.permission 및 user.permissions통해 지정된 사용자에 대한 권한에 액세스할 수 있습니다.

사용자 참조하여 모든 항목 만들기, upsert, 쿼리 또는 읽기를 참조하세요.

속성

database
id
permissions

모든 작업을 만들거나, 업서팅하거나, 쿼리하거나, 읽기 위한 작업입니다.

id별로 특정 사용 권한을 읽거나 바꾸거나 삭제하려면 client.permission(id) 참조하세요.
url

리소스에 대한 참조 URL을 반환합니다. 사용 권한에서 연결에 사용됩니다.

메서드

delete(RequestOptions)

지정된 User삭제합니다.

예시

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();
permission(string)

ID별로 특정 사용 권한을 읽거나 바꾸거나 삭제하는 작업입니다.

모든 작업을 만들거나, 업서팅하거나, 쿼리하거나, 읽는 client.permissions 참조하세요.
read(RequestOptions)

지정된 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();
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);

속성 세부 정보

database 

database: Database

속성 값

Database

id 

id: string

속성 값

string

permissions

모든 작업을 만들거나, 업서팅하거나, 쿼리하거나, 읽기 위한 작업입니다.

id별로 특정 사용 권한을 읽거나 바꾸거나 삭제하려면 client.permission(id) 참조하세요.

permissions: Permissions

속성 값

Permissions

url

리소스에 대한 참조 URL을 반환합니다. 사용 권한에서 연결에 사용됩니다.

string url

속성 값

string

메서드 세부 정보

delete(RequestOptions)

지정된 User삭제합니다.

예시

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

반환

Permission

read(RequestOptions)

지정된 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>

매개 변수

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>