Database.CreateUserAsync(String, RequestOptions, CancellationToken) メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.Cosmos
アセンブリ:
Microsoft.Azure.Cosmos.Client.dll
パッケージ:
Microsoft.Azure.Cosmos v3.36.0

Azure Cosmos サービスで非同期操作としてユーザーを作成します。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse> CreateUserAsync (string id, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateUserAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse>
Public MustOverride Function CreateUserAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserResponse)

パラメーター

id
String

Cosmos ユーザー ID

requestOptions
RequestOptions

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

cancellationToken
CancellationToken

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

戻り値

Task<UserResponse>

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

例外

ArgumentNullException

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

CosmosException

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

StatusCode例外の理由
400BadRequest - これは、指定された要求に問題が発生したことを意味します。 新しいユーザーに ID が指定されていない可能性があります。
409競合 - 指定した ID と一致する ID が既に存在する を意味 UserProperties します。

例

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

適用対象