Delen via

User class

Pakket:
@azure/cosmos

Wordt gebruikt om gebruikers te lezen, te vervangen en te verwijderen.

Daarnaast hebt u toegang tot de machtigingen voor een bepaalde gebruiker via user.permission en user.permissions.

Zie gebruikers om alles te maken, upsert, op te vragen of te lezen.

Eigenschappen

database
id
permissions

Bewerkingen voor het maken, upserten, opvragen of lezen van alle bewerkingen.

Zie client.permission(id) om een specifieke machtiging per id te lezen, vervangen of verwijderen.
url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

Methoden

delete(RequestOptions)

Verwijder de opgegeven Gebruiker.

Voorbeeld

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)

Bewerkingen voor het lezen, vervangen of verwijderen van een specifieke machtiging op id.

Zie client.permissions voor het maken, upserten, opvragen of lezen van alle bewerkingen.
read(RequestOptions)

Lees de UserDefinition- voor de opgegeven User.

Voorbeeld

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)

Vervang de opgegeven definitie van Userdoor de opgegeven UserDefinition-.

Voorbeeld

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

Eigenschapdetails

database 

database: Database

Waarde van eigenschap

Database

id 

id: string

Waarde van eigenschap

string

permissions

Bewerkingen voor het maken, upserten, opvragen of lezen van alle bewerkingen.

Zie client.permission(id) om een specifieke machtiging per id te lezen, vervangen of verwijderen.

permissions: Permissions

Waarde van eigenschap

Permissions

url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

string url

Waarde van eigenschap

string

Methodedetails

delete(RequestOptions)

Verwijder de opgegeven Gebruiker.

Voorbeeld

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>

Parameters

options
RequestOptions

Retouren

Promise<UserResponse>

permission(string)

Bewerkingen voor het lezen, vervangen of verwijderen van een specifieke machtiging op id.

Zie client.permissions voor het maken, upserten, opvragen of lezen van alle bewerkingen.

function permission(id: string): Permission

Parameters

id

string

Retouren

Permission

read(RequestOptions)

Lees de UserDefinition- voor de opgegeven User.

Voorbeeld

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>

Parameters

options
RequestOptions

Retouren

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Vervang de opgegeven definitie van Userdoor de opgegeven UserDefinition-.

Voorbeeld

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>

Parameters

body
UserDefinition

De opgegeven UserDefinition- om de definitie te vervangen.

options
RequestOptions

Retouren

Promise<UserResponse>