CosmosDatabase.UpsertUserAsync メソッド

定義

名前空間:

Azure.Cosmos

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

ユーザーを Azure Cosmos サービスの非同期操作としてアップサートします。

public abstract System.Threading.Tasks.Task<Azure.Cosmos.UserResponse> UpsertUserAsync (string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpsertUserAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.UserResponse>

Public MustOverride Function UpsertUserAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserResponse)

パラメーター

id

String

Cosmos ユーザー ID。

requestOptions

RequestOptions

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

cancellationToken

CancellationToken

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

戻り値

Task<UserResponse>

Task読み取りリソース レコードをUserResponse含む をUserPropertiesラップする を含む 。

例外

ArgumentNullException

が設定されていない場合 id 。

CosmosException

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

StatusCode	例外の理由
400	BadRequest - これは、指定された要求に何らかの問題が発生したことを意味します。 新しいユーザーに ID が指定されていない可能性があります。

例

UserResponse response = await this.cosmosDatabase.UpsertUserAsync(Guid.NewGuid().ToString());