Package version:

Class Trigger

Operations to read, replace, or delete a Trigger.

Use container.triggers to create, upsert, query, or read all.

Index

Properties

Accessors

Methods

delete read replace

Properties

`Readonly`container

container: Container

The parent Container.

`Readonly`id

id: string

The id of the given Trigger.

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/Trigger/Trigger.ts:27

Methods

delete

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

read

read(options?): Promise<TriggerResponse>
Read the TriggerDefinition for the given Trigger.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<TriggerResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/Trigger/Trigger.ts:45

replace

replace(body, options?): Promise<TriggerResponse>
Replace the given Trigger with the specified TriggerDefinition.
Parameters
- body: TriggerDefinition
  The specified TriggerDefinition to replace the existing definition with.
- Optionaloptions: RequestOptions
Returns Promise<TriggerResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/Trigger/Trigger.ts:71