IDocumentClient.ExecuteStoredProcedureAsync Method

Definition

Overloads

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure Cosmos DB service.

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure Cosmos DB service.

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Executes a stored procedure against a partitioned collection as an asynchronous operation in the Azure Cosmos DB service, specifiying a target partition.

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure Cosmos DB service.

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, params object[] procedureParams);
abstract member ExecuteStoredProcedureAsync : string * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Type Parameters

TValue

The type of the stored procedure's return value.

Parameters

storedProcedureLink
System.String

The link to the stored procedure to execute.

procedureParams
System.Object[]

(Optional) An array of dynamic objects representing the parameters for the stored procedure.

Returns

System.Threading.Tasks.Task<StoredProcedureResponse<TValue>>

The task object representing the service response for the asynchronous operation which would contain any response set in the stored procedure.

Exceptions

System.ArgumentNullException

If storedProcedureLink is not set.

Applies to

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, params object[] procedureParams);
abstract member ExecuteStoredProcedureAsync : Uri * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Type Parameters

TValue

The type of the stored procedure's return value.

Parameters

storedProcedureUri
System.Uri

The URI of the stored procedure to be executed.

procedureParams
System.Object[]

The parameters for the stored procedure execution.

Returns

System.Threading.Tasks.Task<StoredProcedureResponse<TValue>>

The task object representing the service response for the asynchronous operation.

Applies to

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Executes a stored procedure against a partitioned collection as an asynchronous operation in the Azure Cosmos DB service, specifiying a target partition.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options, params object[] procedureParams);
abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Type Parameters

TValue

The type of the stored procedure's return value.

Parameters

storedProcedureLink
System.String

The link to the stored procedure to execute.

options
RequestOptions

(Optional) The RequestOptionsfor this request.

procedureParams
System.Object[]

(Optional) An array of dynamic objects representing the parameters for the stored procedure.

Returns

System.Threading.Tasks.Task<StoredProcedureResponse<TValue>>

The task object representing the service response for the asynchronous operation which would contain any response set in the stored procedure.

Exceptions

System.ArgumentNullException

If storedProcedureLink is not set.

Applies to

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options, params object[] procedureParams);
abstract member ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Type Parameters

TValue

The type of the stored procedure's return value.

Parameters

storedProcedureUri
System.Uri

The URI of the stored procedure to be executed.

options
RequestOptions

(Optional) The RequestOptions for the request.

procedureParams
System.Object[]

The parameters for the stored procedure execution.

Returns

System.Threading.Tasks.Task<StoredProcedureResponse<TValue>>

The task object representing the service response for the asynchronous operation.

Applies to