Permissions class

Balíček:

@azure/cosmos

Slouží k vytváření, nahrazování, dotazování a čtení všech oprávnění.

Viz Oprávnění ke čtení, nahrazení nebo odstranění konkrétního oprávnění podle ID.

Vlastnosti

user

Metody

create(PermissionDefinition, RequestOptions)	Vytvořte oprávnění. Oprávnění představuje oprávnění pro jednotlivé uživatele pro přístup ke konkrétnímu prostředku, například k položce nebo kontejneru. příklad 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)	Zadejte dotaz na všechna oprávnění. příklad Oprávnění k dotazu s 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)	Zadejte dotaz na všechna oprávnění.
readAll(FeedOptions)	Číst všechna oprávnění příklad Číst všechna oprávnění k poli 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 a oprávnění. Oprávnění představuje oprávnění pro jednotlivé uživatele pro přístup ke konkrétnímu prostředku, například k položce nebo kontejneru. příklad 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);

Podrobnosti vlastnosti

user

user: User

Hodnota vlastnosti

User

Podrobnosti metody

create(PermissionDefinition, RequestOptions)

Vytvořte oprávnění.

Oprávnění představuje oprávnění pro jednotlivé uživatele pro přístup ke konkrétnímu prostředku, například k položce nebo kontejneru.

příklad

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>

Parametry

body

PermissionDefinition

Představuje tělo oprávnění.

options

RequestOptions

Návraty

Promise<PermissionResponse>

query(SqlQuerySpec, FeedOptions)

Zadejte dotaz na všechna oprávnění.

příklad

Oprávnění k dotazu s 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>

Parametry

query

SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options

FeedOptions

Návraty

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Zadejte dotaz na všechna oprávnění.

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

Parametry

query

SqlQuerySpec

Konfigurace dotazu pro operaci. Další informace o konfiguraci dotazu najdete v tématu sqlQuerySpec.

options

FeedOptions

Návraty

QueryIterator<T>

readAll(FeedOptions)

Číst všechna oprávnění

příklad

Číst všechna oprávnění k poli

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>

Parametry

options

FeedOptions

Návraty

QueryIterator<PermissionDefinition & Resource>

upsert(PermissionDefinition, RequestOptions)

Upsert a oprávnění. Oprávnění představuje oprávnění pro jednotlivé uživatele pro přístup ke konkrétnímu prostředku, například k položce nebo kontejneru.

příklad

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>

Parametry

body

PermissionDefinition

options

RequestOptions

Návraty

Promise<PermissionResponse>