Freigeben über

User class

Paket:
@azure/cosmos

Wird verwendet, um Benutzer zu lesen, zu ersetzen und zu löschen.

Darüber hinaus können Sie über user.permission und user.permissionsauf die Berechtigungen für einen bestimmten Benutzer zugreifen.

Siehe Benutzer zum Erstellen, Upsert, Abfragen oder Lesen aller Benutzer.

Eigenschaften

database
id
permissions

Vorgänge zum Erstellen, Upserting, Abfragen oder Lesen aller Vorgänge.

Siehe client.permission(id), um eine bestimmte Berechtigung nach ID zu lesen, zu ersetzen oder zu löschen.
url

Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

Methoden

delete(RequestOptions)

Löschen Sie die angegebene Benutzer-.

Beispiel

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)

Vorgänge zum Lesen, Ersetzen oder Löschen einer bestimmten Berechtigung nach ID.

Informationen zum Erstellen, Upserting, Abfragen oder Lesen aller Vorgänge finden Sie unter client.permissions.
read(RequestOptions)

Lesen Sie die UserDefinition- für das angegebene User.

Beispiel

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)

Ersetzen Sie die angegebene Benutzerdefinitiondurch die angegebene UserDefinition-.

Beispiel

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

Details zur Eigenschaft

database 

database: Database

Eigenschaftswert

Database

id 

id: string

Eigenschaftswert

string

permissions

Vorgänge zum Erstellen, Upserting, Abfragen oder Lesen aller Vorgänge.

Siehe client.permission(id), um eine bestimmte Berechtigung nach ID zu lesen, zu ersetzen oder zu löschen.

permissions: Permissions

Eigenschaftswert

Permissions

url

Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

string url

Eigenschaftswert

string

Details zur Methode

delete(RequestOptions)

Löschen Sie die angegebene Benutzer-.

Beispiel

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>

Parameter

options
RequestOptions

Gibt zurück

Promise<UserResponse>

permission(string)

Vorgänge zum Lesen, Ersetzen oder Löschen einer bestimmten Berechtigung nach ID.

Informationen zum Erstellen, Upserting, Abfragen oder Lesen aller Vorgänge finden Sie unter client.permissions.

function permission(id: string): Permission

Parameter

id

string

Gibt zurück

Permission

read(RequestOptions)

Lesen Sie die UserDefinition- für das angegebene User.

Beispiel

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>

Parameter

options
RequestOptions

Gibt zurück

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Ersetzen Sie die angegebene Benutzerdefinitiondurch die angegebene UserDefinition-.

Beispiel

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>

Parameter

body
UserDefinition

Die angegebene UserDefinition, um die Definition zu ersetzen.

options
RequestOptions

Gibt zurück

Promise<UserResponse>