Scripts.DeleteStoredProcedureAsync Method

Definition

Namespace:

Microsoft.Azure.Cosmos.Scripts

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

Scripts.cs

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

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

abstract member DeleteStoredProcedureAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.StoredProcedureResponse>

Public MustOverride Function DeleteStoredProcedureAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StoredProcedureResponse)

Parameters

id

String

The identifier of the Stored Procedure to delete.

requestOptions

RequestOptions

(Optional) The options for the stored procedure request.

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<StoredProcedureResponse>

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

Exceptions

ArgumentNullException

If id are not set.

CosmosException

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

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

Scripts scripts = this.container.Scripts;
StoredProcedureResponse response = await scripts.DeleteStoredProcedureAsync("taxUdfId");