你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
CosmosUser.ReplaceAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
UserProperties将 Azure Cosmos 服务中的 作为异步操作替换。
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)
参数
- userProperties
- UserProperties
UserProperties 对象。
- requestOptions
- RequestOptions
(可选) 用户请求的选项 RequestOptions
- cancellationToken
- CancellationToken
(表示请求取消的可选) CancellationToken 。
返回
包含 Task 的 , UserResponse 它包装 UserProperties 包含替换资源记录的 。
例外
此异常可以封装许多不同类型的错误。 若要确定特定错误,请始终查看 StatusCode 属性。 创建用户时可能会获取的一些常见代码包括:
StatusCode | 异常原因 |
---|---|
404 | NotFound - 这意味着尝试读取的资源或父资源不存在。 |
429 | TooManyRequests - 这意味着已超出每秒请求单位数。 请参阅 DocumentClientException.RetryAfter 值,了解在重试此操作之前应等待多长时间。 |
示例
UserProperties userProperties = userReadResponse;
userProperties.Id = "newuser";
UserResponse response = await user.ReplaceUserAsync(userProperties);
UserProperties replacedProperties = response;