Freigeben über


Permissions class

Dient zum Erstellen, Ersetzen, Abfragen und Lesen aller Berechtigungen.

Weitere Informationen finden Sie unter Berechtigungs- zum Lesen, Ersetzen oder Löschen einer bestimmten Berechtigung nach ID.

Eigenschaften

user

Methoden

create(PermissionDefinition, RequestOptions)

Erstellen Sie eine Berechtigung.

Eine Berechtigung stellt eine Benutzerberechtigung für den Zugriff auf eine bestimmte Ressource dar, z. B. Element oder Container.

Beispiel

import { CosmosClient, PermissionDefinition, PermissionMode } 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 { user } = await database.users.create({ id: "<user-id>" });

const permissionDefinition: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};
await user.permissions.create(permissionDefinition);
query(SqlQuerySpec, FeedOptions)

Abfragen aller Berechtigungen.

Beispiel

Abfrageberechtigung mit id.

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @permission`,
  parameters: [{ name: "@permission", value: "<permission-id>" }],
};
const { resources: permisssion } = await database
  .user("<user-id>")
  .permissions.query(querySpec)
  .fetchAll();
query<T>(SqlQuerySpec, FeedOptions)

Abfragen aller Berechtigungen.

readAll(FeedOptions)

Alle Berechtigungen lesen.

Beispiel

Alle Berechtigungen für Array lesen.

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 { resources: permissionList } = await database.user("user1").permissions.readAll().fetchAll();
upsert(PermissionDefinition, RequestOptions)

Upsert eine Berechtigung. Eine Berechtigung stellt eine Benutzerberechtigung für den Zugriff auf eine bestimmte Ressource dar, z. B. Element oder Container.

Beispiel

import { CosmosClient, PermissionDefinition, PermissionMode } 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 user = database.user("<user-id>");
const permissionDefinitionToUpsert: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};

await user.permissions.upsert(permissionDefinitionToUpsert);

Details zur Eigenschaft

user

user: User

Eigenschaftswert

Details zur Methode

create(PermissionDefinition, RequestOptions)

Erstellen Sie eine Berechtigung.

Eine Berechtigung stellt eine Benutzerberechtigung für den Zugriff auf eine bestimmte Ressource dar, z. B. Element oder Container.

Beispiel

import { CosmosClient, PermissionDefinition, PermissionMode } 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 { user } = await database.users.create({ id: "<user-id>" });

const permissionDefinition: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};
await user.permissions.create(permissionDefinition);
function create(body: PermissionDefinition, options?: RequestOptions): Promise<PermissionResponse>

Parameter

body
PermissionDefinition

Stellt den Textkörper der Berechtigung dar.

options
RequestOptions

Gibt zurück

query(SqlQuerySpec, FeedOptions)

Abfragen aller Berechtigungen.

Beispiel

Abfrageberechtigung mit id.

import { CosmosClient, SqlQuerySpec } 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 querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @permission`,
  parameters: [{ name: "@permission", value: "<permission-id>" }],
};
const { resources: permisssion } = await database
  .user("<user-id>")
  .permissions.query(querySpec)
  .fetchAll();
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parameter

query
SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options
FeedOptions

Gibt zurück

query<T>(SqlQuerySpec, FeedOptions)

Abfragen aller Berechtigungen.

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parameter

query
SqlQuerySpec

Abfragekonfiguration für den Vorgang. Weitere Informationen zum Konfigurieren einer Abfrage finden Sie unter SqlQuerySpec-.

options
FeedOptions

Gibt zurück

readAll(FeedOptions)

Alle Berechtigungen lesen.

Beispiel

Alle Berechtigungen für Array lesen.

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 { resources: permissionList } = await database.user("user1").permissions.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<PermissionDefinition & Resource>

Parameter

options
FeedOptions

Gibt zurück

upsert(PermissionDefinition, RequestOptions)

Upsert eine Berechtigung. Eine Berechtigung stellt eine Benutzerberechtigung für den Zugriff auf eine bestimmte Ressource dar, z. B. Element oder Container.

Beispiel

import { CosmosClient, PermissionDefinition, PermissionMode } 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 user = database.user("<user-id>");
const permissionDefinitionToUpsert: PermissionDefinition = {
  id: "<permission-id>",
  permissionMode: PermissionMode.Read,
  resource: "<resource-url>",
};

await user.permissions.upsert(permissionDefinitionToUpsert);
function upsert(body: PermissionDefinition, options?: RequestOptions): Promise<PermissionResponse>

Parameter

options
RequestOptions

Gibt zurück