Share via


CosmosScripts.DeleteStoredProcedureAsync Method

Definition

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

public abstract System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.StoredProcedureProperties>> DeleteStoredProcedureAsync (string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteStoredProcedureAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.StoredProcedureProperties>>
Public MustOverride Function DeleteStoredProcedureAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of StoredProcedureProperties))

Parameters

id
String

The identifier of the Stored Procedure to delete.

requestOptions
RequestOptions

(Optional) The options for the stored procedure request StoredProcedureRequestOptions

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

A Task containing a Response which will contain the response to the request issued.

Exceptions

If id are not set.

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:

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

Examples

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

CosmosScripts scripts = this.container.Scripts;
Response<StoredProcedureProperties> response = await scripts.DeleteStoredProcedureAsync("taxUdfId");

Applies to