Compartir a través de

Permissions class

  • Referencia
Paquete:
@azure/cosmos

Use para crear, reemplazar, consultar y leer todos los permisos.

Consulte Permiso para leer, reemplazar o eliminar un permiso específico por identificador.

Propiedades

user

Métodos

create(PermissionDefinition, RequestOptions)

Cree un permiso.

Un permiso representa un permiso por usuario para acceder a un recurso específico, por ejemplo, elemento o contenedor.

de ejemplo de

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)

Consulta de todos los permisos.

de ejemplo de

Permiso de consulta 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)

Consulta de todos los permisos.
readAll(FeedOptions)

Leer todos los permisos.

de ejemplo de

Lee todos los permisos de la matriz.

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 permiso. Un permiso representa un permiso por usuario para acceder a un recurso específico, por ejemplo, elemento o contenedor.

de ejemplo de

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

Detalles de las propiedades

user 

user: User

Valor de propiedad

User

Detalles del método

create(PermissionDefinition, RequestOptions)

Cree un permiso.

Un permiso representa un permiso por usuario para acceder a un recurso específico, por ejemplo, elemento o contenedor.

de ejemplo de

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>

Parámetros

body
PermissionDefinition

Representa el cuerpo del permiso.

options
RequestOptions

Devoluciones

Promise<PermissionResponse>

query(SqlQuerySpec, FeedOptions)

Consulta de todos los permisos.

de ejemplo de

Permiso de consulta 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>

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consulta de todos los permisos.

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

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Devoluciones

QueryIterator<T>

readAll(FeedOptions)

Leer todos los permisos.

de ejemplo de

Lee todos los permisos de la matriz.

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>

Parámetros

options
FeedOptions

Devoluciones

QueryIterator<PermissionDefinition & Resource>

upsert(PermissionDefinition, RequestOptions)

Upsert un permiso. Un permiso representa un permiso por usuario para acceder a un recurso específico, por ejemplo, elemento o contenedor.

de ejemplo de

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>

Parámetros

body
PermissionDefinition
options
RequestOptions

Devoluciones

Promise<PermissionResponse>