Permissions class

Pakket:

@azure/cosmos

Gebruik dit om alle machtigingen te maken, te vervangen, te doorzoeken en te lezen.

Zie machtiging om een specifieke machtiging per id te lezen, vervangen of verwijderen.

Eigenschappen

user

Methoden

create(PermissionDefinition, RequestOptions)	Maak een machtiging. Een machtiging vertegenwoordigt een machtiging per gebruiker voor toegang tot een specifieke resource, bijvoorbeeld item of container. voorbeeld van 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)	Voer een query uit op alle machtigingen. voorbeeld van Query machtiging met 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)	Voer een query uit op alle machtigingen.
readAll(FeedOptions)	Alle machtigingen lezen. voorbeeld van Alle machtigingen voor matrix lezen. 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 een machtiging. Een machtiging vertegenwoordigt een machtiging per gebruiker voor toegang tot een specifieke resource, bijvoorbeeld item of container. voorbeeld van 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);

Eigenschapdetails

user

user: User

Waarde van eigenschap

User

Methodedetails

create(PermissionDefinition, RequestOptions)

Maak een machtiging.

Een machtiging vertegenwoordigt een machtiging per gebruiker voor toegang tot een specifieke resource, bijvoorbeeld item of container.

voorbeeld van

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>

Parameters

body

PermissionDefinition

Vertegenwoordigt de hoofdtekst van de machtiging.

options

RequestOptions

Retouren

Promise<PermissionResponse>

query(SqlQuerySpec, FeedOptions)

Voer een query uit op alle machtigingen.

voorbeeld van

Query machtiging met 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>

Parameters

query

SqlQuerySpec

Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.

options

FeedOptions

Retouren

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Voer een query uit op alle machtigingen.

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

Parameters

query

SqlQuerySpec

Queryconfiguratie voor de bewerking. Zie SqlQuerySpec- voor meer informatie over het configureren van een query.

options

FeedOptions

Retouren

QueryIterator<T>

readAll(FeedOptions)

Alle machtigingen lezen.

voorbeeld van

Alle machtigingen voor matrix lezen.

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>

Parameters

options

FeedOptions

Retouren

QueryIterator<PermissionDefinition & Resource>

upsert(PermissionDefinition, RequestOptions)

Upsert een machtiging. Een machtiging vertegenwoordigt een machtiging per gebruiker voor toegang tot een specifieke resource, bijvoorbeeld item of container.

voorbeeld van

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>

Parameters

body

PermissionDefinition

options

RequestOptions

Retouren

Promise<PermissionResponse>