Permissions class
Use para criar, substituir, consultar e ler todas as Permissões.
Consulte Permissão para ler, substituir ou excluir uma permissão específica por ID.
Propriedades
user |
Métodos
create(Permission |
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
|
query(Sql |
Consultar todas as permissões. exemplo Permissão de consulta com id.
|
query<T>(Sql |
Consultar todas as permissões. |
read |
Leia todas as permissões. exemplo Leia todas as permissões para matriz.
|
upsert(Permission |
Insira 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
|
Detalhes da propriedade
user
Detalhes do 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
Retornos
Promise<PermissionResponse>
query(SqlQuerySpec, FeedOptions)
Consultar 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
Retornos
QueryIterator<any>
query<T>(SqlQuerySpec, FeedOptions)
Consultar 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
Retornos
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
Retornos
upsert(PermissionDefinition, RequestOptions)
Insira 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
Retornos
Promise<PermissionResponse>