Sdílet prostřednictvím

User class

Balíček:
@azure/cosmos

Slouží ke čtení, nahrazení a odstraňování uživatelů.

Kromě toho můžete přistupovat k oprávněním daného uživatele prostřednictvím user.permission a user.permissions.

Viz Uživatelé vytvářet, upsertovat, dotazovat nebo číst vše.

Vlastnosti

database
id
permissions

Operace pro vytváření, upsertování, dotazování nebo čtení všech operací

Viz client.permission(id) ke čtení, nahrazení nebo odstranění konkrétního oprávnění podle ID.
url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

Metody

delete(RequestOptions)

Odstraňte daný uživatele.

Příklad

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)

Operace čtení, nahrazení nebo odstranění konkrétního oprávnění podle ID

Viz client.permissions vytvoření, přenesení, dotazování nebo čtení všech operací.
read(RequestOptions)

Přečtěte si UserDefinition pro danou uživatele.

Příklad

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)

Nahraďte danou definici Userzadanou UserDefinition.

Příklad

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

Podrobnosti vlastnosti

database 

database: Database

Hodnota vlastnosti

Database

id 

id: string

Hodnota vlastnosti

string

permissions

Operace pro vytváření, upsertování, dotazování nebo čtení všech operací

Viz client.permission(id) ke čtení, nahrazení nebo odstranění konkrétního oprávnění podle ID.

permissions: Permissions

Hodnota vlastnosti

Permissions

url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

delete(RequestOptions)

Odstraňte daný uživatele.

Příklad

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>

Parametry

options
RequestOptions

Návraty

Promise<UserResponse>

permission(string)

Operace čtení, nahrazení nebo odstranění konkrétního oprávnění podle ID

Viz client.permissions vytvoření, přenesení, dotazování nebo čtení všech operací.

function permission(id: string): Permission

Parametry

id

string

Návraty

Permission

read(RequestOptions)

Přečtěte si UserDefinition pro danou uživatele.

Příklad

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>

Parametry

options
RequestOptions

Návraty

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Nahraďte danou definici Userzadanou UserDefinition.

Příklad

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>

Parametry

body
UserDefinition

Zadaná UserDefinition nahradit definici.

options
RequestOptions

Návraty

Promise<UserResponse>