User.ReplaceAsync(UserProperties, RequestOptions, CancellationToken) メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

Azure Cosmos サービスの を UserProperties 非同期操作として置き換えます。

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)

パラメーター

userProperties

UserProperties

UserProperties オブジェクト。

requestOptions

RequestOptions

(省略可能)ユーザー要求のオプション。

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<UserResponse>

Task置換リソース レコードをUserResponse含む をUserPropertiesラップする を含む 。

例外

CosmosException

この例外により、さまざまな種類のエラーがカプセル化される可能性があります。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ユーザーの作成時に取得できる一般的なコードは次のとおりです。

StatusCode	例外の理由
404	NotFound - 読み取ろうとしたリソースまたは親リソースが存在しなかったことを意味します。
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter 値を調べ、この操作を再試行するまでの待機時間を確認します。

例

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