Package version:

Class Permission

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

See

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

Index

Properties

Accessors

Methods

delete read replace

Properties

`Readonly`id

id: string

The id of the given Permission.

`Readonly`user

user: User

The parent User.

Accessors

url

get url(): string
Returns a reference URL to the resource. Used for linking in Permissions.

Returns string
- Defined in sdk/cosmosdb/cosmos/src/client/Permission/Permission.ts:28

Methods

delete

delete(options?): Promise<PermissionResponse>
Delete the given Permission.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<PermissionResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/Permission/Permission.ts:104

read

read(options?): Promise<PermissionResponse>
Read the PermissionDefinition of the given Permission.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<PermissionResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/Permission/Permission.ts:45

replace

replace(body, options?): Promise<PermissionResponse>
Replace the given Permission with the specified PermissionDefinition.
Parameters
- body: PermissionDefinition
  The specified PermissionDefinition.
- Optionaloptions: RequestOptions
Returns Promise<PermissionResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/Permission/Permission.ts:71