CosmosScripts.DeleteTriggerAsync Method

Reference

Definition

Namespace:: Azure.Cosmos.Scripts

Assembly:: Azure.Cosmos.dll

Package:: Azure.Cosmos v4.0.0-preview3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Delete a TriggerProperties from the Azure Cosmos service as an asynchronous operation.

public abstract System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.TriggerProperties>> DeleteTriggerAsync (string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteTriggerAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.TriggerProperties>>

Public MustOverride Function DeleteTriggerAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TriggerProperties))

Parameters

id: String

The id of the trigger to delete.

requestOptions: RequestOptions

(Optional) The options for the trigger request RequestOptions

cancellationToken: CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<Response<TriggerProperties>>

A Task containing a Response<T> which wraps a TriggerProperties which will contain information about the request issued.

Examples

This examples gets a reference to an existing trigger and deletes it.

Scripts scripts = this.container.Scripts;
Response<TriggerProperties> response = await scripts.DeleteTriggerAsync("existingId");

Applies to

Share via