Users class

패키지:

@azure/cosmos

모든 사용자를 만들고, 업서트하고, 쿼리하고, 읽는 데 사용됩니다.

id별로 특정 사용자를 읽거나 바꾸거나 삭제하려면 사용자 참조하세요.

속성

database

메서드

create(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" }); await database.users.create({ id: "<user-id>" });
query(SqlQuerySpec, FeedOptions)	모든 사용자를 쿼리합니다.
query<T>(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 = @user`, parameters: [{ name: "@user", value: "<user-id>" }], }; const { resources: permisssion } = await database.users.query(querySpec).fetchAll();
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: usersList } = await database.users.readAll().fetchAll();
upsert(UserDefinition, RequestOptions)	지정한 UserDefinition사용하여 데이터베이스 사용자를 Upsert합니다. 예제 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.users.upsert({ id: "<user-id>" });

속성 세부 정보

database

database: Database

속성 값

Database

메서드 세부 정보

create(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" });

await database.users.create({ id: "<user-id>" });

function create(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

매개 변수

body

UserDefinition

지정한 UserDefinition.

options

RequestOptions

반환

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

모든 사용자를 쿼리합니다.

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

매개 변수

query

SqlQuerySpec

작업에 대한 쿼리 구성입니다. 쿼리를 구성하는 방법에 대한 자세한 내용은 SqlQuerySpec 참조하세요.

options

FeedOptions

반환

QueryIterator<any>

query<T>(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 = @user`,
  parameters: [{ name: "@user", value: "<user-id>" }],
};
const { resources: permisssion } = await database.users.query(querySpec).fetchAll();

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: usersList } = await database.users.readAll().fetchAll();

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

매개 변수

options

FeedOptions

반환

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

지정한 UserDefinition사용하여 데이터베이스 사용자를 Upsert합니다.

예제

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.users.upsert({ id: "<user-id>" });

function upsert(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

매개 변수

body

UserDefinition

지정한 UserDefinition.

options

RequestOptions

반환

Promise<UserResponse>