Compartilhar via


Trigger class

Operações para ler, substituir ou excluir um gatilho .

Use container.triggers para criar, upsert, consultar ou ler tudo.

Propriedades

container
id
url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

Métodos

delete(RequestOptions)

Exclua o de gatilho dedeterminado.

Exemplo

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)

Leia o TriggerDefinition para o de gatilho dedeterminado.

Exemplo

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)

Substitua o de Gatilho de especificado pelo triggerDefinitionespecificado.

Exemplo

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

Detalhes da propriedade

container

container: Container

Valor da propriedade

id

id: string

Valor da propriedade

string

url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

string url

Valor da propriedade

string

Detalhes do método

delete(RequestOptions)

Exclua o de gatilho dedeterminado.

Exemplo

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>

Parâmetros

options
RequestOptions

Retornos

Promise<TriggerResponse>

read(RequestOptions)

Leia o TriggerDefinition para o de gatilho dedeterminado.

Exemplo

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>

Parâmetros

options
RequestOptions

Retornos

Promise<TriggerResponse>

replace(TriggerDefinition, RequestOptions)

Substitua o de Gatilho de especificado pelo triggerDefinitionespecificado.

Exemplo

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>

Parâmetros

body
TriggerDefinition

O TriggerDefinition especificado para substituir a definição existente.

options
RequestOptions

Retornos

Promise<TriggerResponse>