DocumentClient.DeleteUserDefinedFunctionAsync Method

Definition

Namespace:

Microsoft.Azure.Documents.Client

Assemblies:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Overloads

DeleteUserDefinedFunctionAsync(String, RequestOptions)	Delete a UserDefinedFunction from the Azure Cosmos DB service as an asynchronous operation.
DeleteUserDefinedFunctionAsync(Uri, RequestOptions)	Delete a user defined function as an asynchronous operation from the Azure Cosmos DB service.

DeleteUserDefinedFunctionAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> DeleteUserDefinedFunctionAsync (string functionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member DeleteUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.DeleteUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>

Public Function DeleteUserDefinedFunctionAsync (functionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

Parameters

functionLink

String

The link of the UserDefinedFunction to delete. E.g. dbs/db_rid/colls/col_rid/udfs/udf_rid/

options

RequestOptions

(Optional) The request options for the request.

Returns

Task<ResourceResponse<UserDefinedFunction>>

A System.Threading.Tasks containing a ResourceResponse<TResource> which will contain information about the request issued.

Implements

DeleteUserDefinedFunctionAsync(String, RequestOptions)

Exceptions

ArgumentNullException

If functionLink is not set.

DocumentClientException

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:

StatusCode	Reason for exception
404	NotFound - This means the resource you tried to delete did not exist.

Examples

//Delete a user defined function using its selfLink property.
//To get the functionLink you would have to query for the User Defined Function, using CreateUserDefinedFunctionQuery(),  and then refer to its .SelfLink property
await client.DeleteUserDefinedFunctionAsync(functionLink);

See also

• ResourceResponse<TResource>
• Task
• UserDefinedFunction
• RequestOptions

DeleteUserDefinedFunctionAsync(Uri, RequestOptions)

Delete a user defined function as an asynchronous operation from the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> DeleteUserDefinedFunctionAsync (Uri functionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member DeleteUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.DeleteUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>

Public Function DeleteUserDefinedFunctionAsync (functionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

Parameters

functionUri

Uri

the URI of the user defined function to delete.

options

RequestOptions

The request options for the request.

Returns

Task<ResourceResponse<UserDefinedFunction>>

The task object representing the service response for the asynchronous operation.

Implements

DeleteUserDefinedFunctionAsync(Uri, RequestOptions)