Поделиться через

User class

Пакет:
@azure/cosmos

Используется для чтения, замены и удаления пользователей.

Кроме того, вы можете получить доступ к разрешениям для данного пользователя с помощью user.permission и user.permissions.

См. пользователи, чтобы создать, upsert, query или прочитать все.

Свойства

database
id
permissions

Операции для создания, upserting, запроса или чтения всех операций.

См. client.permission(id) для чтения, замены или удаления определенного разрешения по идентификатору.
url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

Методы

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

await database.user("<user-id>").delete();
permission(string)

Операции чтения, замены или удаления определенного разрешения по идентификатору.

См. client.permissions для создания, переключения, запроса или чтения всех операций.
read(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();
replace(UserDefinition, 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();
user.id = "<new user id>";

await database.user("<user-id>").replace(user);

Сведения о свойстве

database 

database: Database

Значение свойства

Database

id 

id: string

Значение свойства

string

permissions

Операции для создания, upserting, запроса или чтения всех операций.

См. client.permission(id) для чтения, замены или удаления определенного разрешения по идентификатору.

permissions: Permissions

Значение свойства

Permissions

url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

string url

Значение свойства

string

Сведения о методе

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

await database.user("<user-id>").delete();

function delete(options?: RequestOptions): Promise<UserResponse>

Параметры

options
RequestOptions

Возвращаемое значение

Promise<UserResponse>

permission(string)

Операции чтения, замены или удаления определенного разрешения по идентификатору.

См. client.permissions для создания, переключения, запроса или чтения всех операций.

function permission(id: string): Permission

Параметры

id

string

Возвращаемое значение

Permission

read(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();

function read(options?: RequestOptions): Promise<UserResponse>

Параметры

options
RequestOptions

Возвращаемое значение

Promise<UserResponse>

replace(UserDefinition, 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();
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>