CosmosUser.ReplaceAsync 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.
Replace a UserProperties from the Azure Cosmos service as an asynchronous operation.
public abstract System.Threading.Tasks.Task<Azure.Cosmos.UserResponse> ReplaceAsync (Azure.Cosmos.UserProperties userProperties, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceAsync : Azure.Cosmos.UserProperties * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<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 RequestOptions
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
A Task containing a UserResponse which wraps a UserProperties containing the replace resource record.
Exceptions
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 user are:
| StatusCode | Reason for exception |
|---|---|
| 404 | NotFound - This means the resource or parent 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
UserProperties userProperties = userReadResponse;
userProperties.Id = "newuser";
UserResponse response = await user.ReplaceUserAsync(userProperties);
UserProperties replacedProperties = response;
