Permission class

Package:

@azure/cosmos

Use to read, replace, or delete a given Permission by id.

See Permissions to create, upsert, query, or read all Permissions.

Properties

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

Methods

delete(RequestOptions)	Delete the given Permission.
read(RequestOptions)	Read the PermissionDefinition of the given Permission.
replace(PermissionDefinition, RequestOptions)	Replace the given Permission with the specified PermissionDefinition.

Property Details

id

id: string

Property Value

string

url

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

string url

Property Value

string

user

user: User

Property Value

User

Method Details

delete(RequestOptions)

Delete the given Permission.

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

Parameters

options

RequestOptions

Returns

Promise<PermissionResponse>

read(RequestOptions)

Read the PermissionDefinition of the given Permission.

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

Parameters

options

RequestOptions

Returns

Promise<PermissionResponse>

replace(PermissionDefinition, RequestOptions)

Replace the given Permission with the specified PermissionDefinition.

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

Parameters

body

PermissionDefinition

The specified PermissionDefinition.

options

RequestOptions

Returns

Promise<PermissionResponse>