Permission class

id: string

Property Value

Returns a reference URL to the resource. Used for linking in Permissions.

string url

Property Value

user: User

Property Value

Delete the given Permission.

Example

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 user = database.user("<user-id>");

await user.permission("<permission-id>").delete();

function delete(options?: RequestOptions): Promise<PermissionResponse>

Parameters

Returns

Read the PermissionDefinition of the given Permission.

Example

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 user = database.user("<user-id>");

const { resource: permission } = await user.permission("<permission-id>").read();

function read(options?: RequestOptions): Promise<PermissionResponse>

Parameters

Returns

Replace the given Permission with the specified PermissionDefinition.

Example

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 user = database.user("<user-id>");
const { resource: permission } = await user.permission("<permission-id>").read();
permission.resource = "<new-resource-url>";

await user.permission("<permission-id>").replace(permission);

function replace(body: PermissionDefinition, options?: RequestOptions): Promise<PermissionResponse>

Parameters

Returns