Permissions class

Pacote:

@azure/cosmos

Use para criar, substituir, consultar e ler todas as Permissões.

Consulte de permissão para ler, substituir ou excluir uma permissão específica por id.

Propriedades

user

Métodos

create(PermissionDefinition, RequestOptions)	Crie uma permissão. Uma permissão representa uma Permissão por Usuário para acessar um recurso específico, por exemplo, Item ou Contêiner. Exemplo 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)	Consulte todas as permissões. Exemplo Permissão de consulta com 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)	Consulte todas as permissões.
readAll(FeedOptions)	Leia todas as permissões. Exemplo Leia todas as permissões para 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 uma permissão. Uma permissão representa uma Permissão por Usuário para acessar um recurso específico, por exemplo, Item ou Contêiner. Exemplo 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);

Detalhes de Propriedade

user

user: User

Valor de Propriedade

User

Detalhes de Método

create(PermissionDefinition, RequestOptions)

Crie uma permissão.

Uma permissão representa uma Permissão por Usuário para acessar um recurso específico, por exemplo, Item ou Contêiner.

Exemplo

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 o corpo da permissão.

options

RequestOptions

Devoluções

Promise<PermissionResponse>

query(SqlQuerySpec, FeedOptions)

Consulte todas as permissões.

Exemplo

Permissão de consulta com 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

Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options

FeedOptions

Devoluções

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Consulte todas as permissões.

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

Parâmetros

query

SqlQuerySpec

Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options

FeedOptions

Devoluções

QueryIterator<T>

readAll(FeedOptions)

Leia todas as permissões.

Exemplo

Leia todas as permissões para 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

Devoluções

QueryIterator<PermissionDefinition & Resource>

upsert(PermissionDefinition, RequestOptions)

Upsert uma permissão. Uma permissão representa uma Permissão por Usuário para acessar um recurso específico, por exemplo, Item ou Contêiner.

Exemplo

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

Devoluções

Promise<PermissionResponse>