Partager via


Trigger class

Opérations de lecture, de remplacement ou de suppression d’un déclencheur .

Utilisez container.triggers pour créer, upsert, interroger ou lire tout.

Propriétés

container
id
url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

Méthodes

delete(RequestOptions)

Supprimez le déclencheur donné.

Exemple

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();
read(RequestOptions)

Lisez le triggerDefinition pour le déclencheur dedonné.

Exemple

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();
replace(TriggerDefinition, RequestOptions)

Remplacez le déclencheur spécifié par le TriggerDefinitionspécifié.

Exemple

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);

Détails de la propriété

container

container: Container

Valeur de propriété

id

id: string

Valeur de propriété

string

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

string url

Valeur de propriété

string

Détails de la méthode

delete(RequestOptions)

Supprimez le déclencheur donné.

Exemple

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>

Paramètres

options
RequestOptions

Retours

Promise<TriggerResponse>

read(RequestOptions)

Lisez le triggerDefinition pour le déclencheur dedonné.

Exemple

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>

Paramètres

options
RequestOptions

Retours

Promise<TriggerResponse>

replace(TriggerDefinition, RequestOptions)

Remplacez le déclencheur spécifié par le TriggerDefinitionspécifié.

Exemple

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>

Paramètres

body
TriggerDefinition

Le TriggerDefinition spécifié pour remplacer la définition existante par.

options
RequestOptions

Retours

Promise<TriggerResponse>