Trigger class

container: Container

Property Value

id: string

Property Value

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

string url

Property Value

Delete the given Trigger.

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 { container } = await database.containers.createIfNotExists({ id: "Test Container" });

await container.scripts.trigger("<trigger-id>").delete();

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

Parameters

Returns

Read the TriggerDefinition for the given Trigger.

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 { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resource: trigger } = await container.scripts.trigger("<trigger-id>").read();

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

Parameters

Returns

Replace the given Trigger with the specified TriggerDefinition.

Example

import { CosmosClient, TriggerDefinition, TriggerType, TriggerOperation } 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 { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const triggerDefinition: TriggerDefinition = {
  id: "sample trigger",
  body: "serverScript() { var x = 10; }",
  triggerType: TriggerType.Pre,
  triggerOperation: TriggerOperation.All,
};

const { resource: trigger } = await container.scripts.triggers.create(triggerDefinition);

trigger.body = "function () { const x = 20; console.log(x); }";
const { resource: replacedTrigger } = await container.scripts.trigger(trigger.id).replace(trigger);

function replace(body: TriggerDefinition, options?: RequestOptions): Promise<TriggerResponse>

Parameters

Returns