Aracılığıyla paylaş

User class

Paket:
@azure/cosmos

Kullanıcıları okumak, değiştirmek ve silmek için kullanılır.

Ayrıca, user.permission ve user.permissionsaracılığıyla belirli bir kullanıcının izinlerine erişebilirsiniz.

Bkz. Kullanıcılar oluşturma, yükseltme, sorgulama veya tümünü okuma.

Özellikler

database
id
permissions

Tüm işlemleri oluşturma, yükseltme, sorgulama veya okuma işlemleri.

Belirli bir kimliğe göre izni okumak, değiştirmek veya silmek için bkz. client.permission(id).
url

Kaynağa bir başvuru URL'si döndürür. İzinler'de bağlantı için kullanılır.

Yöntemler

delete(RequestOptions)

Verilen Kullanıcısilin.

Örnek

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)

Kimliğe göre belirli bir İzni okuma, değiştirme veya silme işlemleri.

Tüm işlemleri oluşturmak, yükseltmek, sorgulamak veya okumak için bkz. client.permissions.
read(RequestOptions)

Verilen Useriçin UserDefinition okuyun.

Örnek

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)

Verilen Kullanıcı'nin tanımını belirtilen UserDefinitionile değiştirin.

Örnek

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

Özellik Ayrıntıları

database 

database: Database

Özellik Değeri

Database

id 

id: string

Özellik Değeri

string

permissions

Tüm işlemleri oluşturma, yükseltme, sorgulama veya okuma işlemleri.

Belirli bir kimliğe göre izni okumak, değiştirmek veya silmek için bkz. client.permission(id).

permissions: Permissions

Özellik Değeri

Permissions

url

Kaynağa bir başvuru URL'si döndürür. İzinler'de bağlantı için kullanılır.

string url

Özellik Değeri

string

Yöntem Ayrıntıları

delete(RequestOptions)

Verilen Kullanıcısilin.

Örnek

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>

Parametreler

options
RequestOptions

Döndürülenler

Promise<UserResponse>

permission(string)

Kimliğe göre belirli bir İzni okuma, değiştirme veya silme işlemleri.

Tüm işlemleri oluşturmak, yükseltmek, sorgulamak veya okumak için bkz. client.permissions.

function permission(id: string): Permission

Parametreler

id

string

Döndürülenler

Permission

read(RequestOptions)

Verilen Useriçin UserDefinition okuyun.

Örnek

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>

Parametreler

options
RequestOptions

Döndürülenler

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

Verilen Kullanıcı'nin tanımını belirtilen UserDefinitionile değiştirin.

Örnek

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>

Parametreler

body
UserDefinition

Belirtilen UserDefinition tanımı değiştirmek için.

options
RequestOptions

Döndürülenler

Promise<UserResponse>