Scripts.ReplaceStoredProcedureAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos.Scripts

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.45.0

Source:: Scripts.cs

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.

Replaces a StoredProcedureProperties in the Azure Cosmos service as an asynchronous operation.

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

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

Public MustOverride Function ReplaceStoredProcedureAsync (storedProcedureProperties As StoredProcedureProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StoredProcedureResponse)

Parameters

storedProcedureProperties: StoredProcedureProperties

The Stored Procedure to replace

requestOptions: RequestOptions

(Optional) The options for the stored procedure request.

cancellationToken: CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<StoredProcedureResponse>

A Task containing a StoredProcedureProperties.

Exceptions

ArgumentNullException

If storedProcedureProperties is 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 replaces an existing stored procedure.

//Updated body
string body = @"function AddTax() {
    var item = getContext().getRequest().getBody();

    // Validate/calculate the tax.
    item.tax = item.cost* .15;

    // Update the request -- this is what is going to be inserted.
    getContext().getRequest().setBody(item);
}";

Scripts scripts = this.container.Scripts;
StoredProcedureResponse response = await scripts.ReplaceStoredProcedureAsync(new StoredProcedureProperties("testTriggerId", body));

Applies to

Share via