Condividi tramite

User class

Pacchetto:
@azure/cosmos

Usato per leggere, sostituire ed eliminare utenti.

Inoltre, è possibile accedere alle autorizzazioni per un determinato utente tramite user.permission e user.permissions.

Vedere Utenti per creare, upsert, eseguire query o leggere tutto.

Proprietà

database
id
permissions

Operazioni per la creazione, l'upserting, l'esecuzione di query o la lettura di tutte le operazioni.

Vedere client.permission(id) per leggere, sostituire o eliminare un'autorizzazione specifica in base all'ID.
url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

Metodi

delete(RequestOptions)

Eliminare l'utente specificato.

Esempio

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)

Operazioni per leggere, sostituire o eliminare un'autorizzazione specifica in base all'ID.

Vedere client.permissions per la creazione, l'upserting, l'esecuzione di query o la lettura di tutte le operazioni.
read(RequestOptions)

Leggere il UserDefinition per l'utente specificato.

Esempio

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)

Sostituire la definizione di Userspecificata con la UserDefinition specificata.

Esempio

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

Dettagli proprietà

database 

database: Database

Valore della proprietà

Database

id 

id: string

Valore della proprietà

string

permissions

Operazioni per la creazione, l'upserting, l'esecuzione di query o la lettura di tutte le operazioni.

Vedere client.permission(id) per leggere, sostituire o eliminare un'autorizzazione specifica in base all'ID.

permissions: Permissions

Valore della proprietà

Permissions

url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

string url

Valore della proprietà

string

Dettagli metodo

delete(RequestOptions)

Eliminare l'utente specificato.

Esempio

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>

Parametri

options
RequestOptions

Restituisce

Promise<UserResponse>

permission(string)

Operazioni per leggere, sostituire o eliminare un'autorizzazione specifica in base all'ID.

Vedere client.permissions per la creazione, l'upserting, l'esecuzione di query o la lettura di tutte le operazioni.

function permission(id: string): Permission

Parametri

id

string

Restituisce

Permission

read(RequestOptions)

Leggere il UserDefinition per l'utente specificato.

Esempio

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>

Parametri

options
RequestOptions

Restituisce

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Sostituire la definizione di Userspecificata con la UserDefinition specificata.

Esempio

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>

Parametri

body
UserDefinition

Il UserDefinition specificato per sostituire la definizione.

options
RequestOptions

Restituisce

Promise<UserResponse>