Scripts.ReadUserDefinedFunctionAsync 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 UserDefinedFunctionProperties from the Azure Cosmos DB service as an asynchronous operation.

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

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

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

Parameters

id

String

The id of the user defined function to read

requestOptions

RequestOptions

(Optional) The options for the user defined function request.

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<UserDefinedFunctionResponse>

A Task containing a UserDefinedFunctionResponse which wraps a UserDefinedFunctionProperties containing the read resource record.

Exceptions

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 user defined function.

Scripts scripts = this.container.Scripts;
UserDefinedFunctionResponse response = await scripts.ReadUserDefinedFunctionAsync("ExistingId");
UserDefinedFunctionProperties udfProperties = response;