CosmosUser.ReplaceAsync メソッド

  • リファレンス

定義

名前空間:
Azure.Cosmos
アセンブリ:
Azure.Cosmos.dll
パッケージ:
Azure.Cosmos v4.0.0-preview3

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

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>

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

例外

CosmosException

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

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

例

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

適用対象