CosmosUser.DeleteAsync(RequestOptions, CancellationToken) メソッド

  • リファレンス

定義

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

UserProperties非同期操作として Azure Cosmos DB サービスから を削除します。

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

パラメーター

requestOptions
RequestOptions

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

cancellationToken
CancellationToken

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

戻り値

Task<UserResponse>

Task発行された要求にUserResponse関する情報を格納する を含む 。

例外

CosmosException

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

StatusCode例外の理由
404NotFound - 削除しようとしたリソースまたは親リソースが存在しなかったことを意味します。

例

CosmosUser user = this.database.GetUser("userId");
UserResponse response = await user.DeleteUserAsync();

適用対象