Condividi tramite


User.ReplaceAsync(UserProperties, RequestOptions, CancellationToken) Method

Definition

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

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse> ReplaceAsync (Microsoft.Azure.Cosmos.UserProperties userProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReplaceAsync : Microsoft.Azure.Cosmos.UserProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse>
Public MustOverride Function ReplaceAsync (userProperties As UserProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserResponse)

Parameters

userProperties
UserProperties

The UserProperties object.

requestOptions
RequestOptions

(Optional) The options for the user request.

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

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

Examples

UserProperties userProperties = userReadResponse;
userProperties.Id = "newuser";
UserResponse response = await user.ReplaceUserAsync(userProperties);
UserProperties replacedProperties = response;

Applies to