User.ReadAsync(RequestOptions, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

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

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: User.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.

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

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse> ReadAsync (Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse>

Public MustOverride Function ReadAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserResponse)

Parameters

requestOptions: RequestOptions

(Optional) The options for the user request.

cancellationToken: CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<UserResponse>

A Task containing a UserResponse which wraps a UserProperties containing the read resource record.

Examples

User user = this.database.GetUser("userId");
UserProperties userProperties = await user.ReadUserAsync();

Applies to

Share via