Scripts.ReadStoredProcedureAsync Method

Definition

Namespace:

Microsoft.Azure.Cosmos.Scripts

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

Scripts.cs

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

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

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

Public MustOverride Function ReadStoredProcedureAsync (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 read.

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 id 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 read did not exist.
429	TooManyRequests - This means you have exceeded the number of request units per second. Consult the DocumentClientException.RetryAfter value to see how long you should wait before retrying this operation.

Examples

This reads an existing stored procedure.

Scripts scripts = this.container.Scripts;
StoredProcedureResponse storedProcedure = await scripts.ReadStoredProcedureAsync("ExistingId");