Permissions class

Pacchetto:

@azure/cosmos

Usare per creare, sostituire, eseguire query e leggere tutte le autorizzazioni.

Vedere Autorizzazione per leggere, sostituire o eliminare un'autorizzazione specifica in base all'ID.

Proprietà

user

Metodi

create(PermissionDefinition, RequestOptions)	Creare un'autorizzazione. Un'autorizzazione rappresenta un'autorizzazione per utente per accedere a una risorsa specifica, ad esempio elemento o contenitore. esempio di 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)	Eseguire query su tutte le autorizzazioni. esempio di Interroga l'autorizzazione con 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)	Eseguire query su tutte le autorizzazioni.
readAll(FeedOptions)	Leggere tutte le autorizzazioni. esempio di Leggere tutte le autorizzazioni per la matrice. 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 un'autorizzazione. Un'autorizzazione rappresenta un'autorizzazione per utente per accedere a una risorsa specifica, ad esempio elemento o contenitore. esempio di 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);

Dettagli proprietà

user

user: User

Valore della proprietà

User

Dettagli metodo

create(PermissionDefinition, RequestOptions)

Creare un'autorizzazione.

Un'autorizzazione rappresenta un'autorizzazione per utente per accedere a una risorsa specifica, ad esempio elemento o contenitore.

esempio di

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>

Parametri

body

PermissionDefinition

Rappresenta il corpo dell'autorizzazione.

options

RequestOptions

Restituisce

Promise<PermissionResponse>

query(SqlQuerySpec, FeedOptions)

Eseguire query su tutte le autorizzazioni.

esempio di

Interroga l'autorizzazione con 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>

Parametri

query

SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec.

options

FeedOptions

Restituisce

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Eseguire query su tutte le autorizzazioni.

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

Parametri

query

SqlQuerySpec

Configurazione della query per l'operazione. Per altre informazioni su come configurare una query, vedere SqlQuerySpec.

options

FeedOptions

Restituisce

QueryIterator<T>

readAll(FeedOptions)

Leggere tutte le autorizzazioni.

esempio di

Leggere tutte le autorizzazioni per la matrice.

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>

Parametri

options

FeedOptions

Restituisce

QueryIterator<PermissionDefinition & Resource>

upsert(PermissionDefinition, RequestOptions)

Upsert un'autorizzazione. Un'autorizzazione rappresenta un'autorizzazione per utente per accedere a una risorsa specifica, ad esempio elemento o contenitore.

esempio di

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>

Parametri

body

PermissionDefinition

options

RequestOptions

Restituisce

Promise<PermissionResponse>