Dela via

User class

Paket:
@azure/cosmos

Används för att läsa, ersätta och ta bort användare.

Dessutom kan du komma åt behörigheterna för en viss användare via user.permission och user.permissions.

Se Användare för att skapa, upsert, fråga eller läsa alla.

Egenskaper

database
id
permissions

Åtgärder för att skapa, utöka, köra frågor mot eller läsa alla åtgärder.

Se client.permission(id) för att läsa, ersätta eller ta bort en specifik behörighet med ID.
url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

Metoder

delete(RequestOptions)

Ta bort angiven användare.

Exempel

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)

Åtgärder för att läsa, ersätta eller ta bort en specifik behörighet med ID.

Se client.permissions för att skapa, utöka, fråga eller läsa alla åtgärder.
read(RequestOptions)

Läs UserDefinition- för den angivna user.

Exempel

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)

Ersätt den angivna user's definition med den angivna UserDefinition.

Exempel

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

Egenskapsinformation

database 

database: Database

Egenskapsvärde

Database

id 

id: string

Egenskapsvärde

string

permissions

Åtgärder för att skapa, utöka, köra frågor mot eller läsa alla åtgärder.

Se client.permission(id) för att läsa, ersätta eller ta bort en specifik behörighet med ID.

permissions: Permissions

Egenskapsvärde

Permissions

url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

string url

Egenskapsvärde

string

Metodinformation

delete(RequestOptions)

Ta bort angiven användare.

Exempel

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>

Parametrar

options
RequestOptions

Returer

Promise<UserResponse>

permission(string)

Åtgärder för att läsa, ersätta eller ta bort en specifik behörighet med ID.

Se client.permissions för att skapa, utöka, fråga eller läsa alla åtgärder.

function permission(id: string): Permission

Parametrar

id

string

Returer

Permission

read(RequestOptions)

Läs UserDefinition- för den angivna user.

Exempel

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>

Parametrar

options
RequestOptions

Returer

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Ersätt den angivna user's definition med den angivna UserDefinition.

Exempel

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>

Parametrar

body
UserDefinition

Den angivna UserDefinition för att ersätta definitionen.

options
RequestOptions

Returer

Promise<UserResponse>