CosmosScripts.DeleteUserDefinedFunctionAsync 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 UserDefinedFunctionProperties from the Azure Cosmos DB service as an asynchronous operation.

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

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

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

Parameters

id: String

The id of the user defined function to delete.

requestOptions: RequestOptions

(Optional) The options for the user defined function request RequestOptions

cancellationToken: CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<Response<UserDefinedFunctionProperties>>

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

Examples

This examples gets a reference to an existing user defined function and deletes it.

CosmosScripts scripts = this.container.Scripts;
Response<UserDefinedFunctionProperties> response = await this.container.DeleteUserDefinedFunctionAsync("existingId");

Applies to

Share via