CosmosScripts.ReadStoredProcedureAsync Method
Definition
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.
Reads a StoredProcedureProperties from the Azure Cosmos service as an asynchronous operation.
public abstract System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.StoredProcedureProperties>> ReadStoredProcedureAsync (string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadStoredProcedureAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.StoredProcedureProperties>>Public MustOverride Function ReadStoredProcedureAsync (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 read.
- requestOptions
- RequestOptions
(Optional) The options for the stored procedure request StoredProcedureRequestOptions
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
A Task containing a StoredProcedureProperties.
Exceptions
If id is 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:
| 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.
CosmosScripts scripts = this.container.Scripts;
Response<StoredProcedureProperties> storedProcedure = await scripts.ReadStoredProcedureAsync("ExistingId");
