DocumentClient.DeleteUserAsync メソッド

定義

名前空間:

Microsoft.Azure.Documents.Client

アセンブリ:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

パッケージ:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

オーバーロード

DeleteUserAsync(String, RequestOptions)	User非同期操作として Azure Cosmos DB サービスから を削除します。
DeleteUserAsync(Uri, RequestOptions)	Azure Cosmos DB サービスから非同期操作としてユーザーを削除します。

DeleteUserAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> DeleteUserAsync (string userLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member DeleteUserAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
override this.DeleteUserAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>

Public Function DeleteUserAsync (userLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

パラメーター

userLink

String

削除する の User リンク。 例: dbs/db_rid/users/user_rid/

options

RequestOptions

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

戻り値

Task<ResourceResponse<User>>

System.Threading.Tasks発行された要求にResourceResponse<TResource>関する情報を格納する を含む 。

実装

DeleteUserAsync(String, RequestOptions)

例外

ArgumentNullException

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

DocumentClientException

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

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

例

//Delete a user using its selfLink property.
//To get the userLink you would have to query for the User object, using CreateUserQuery(), and then refer to its .SelfLink property
await client.DeleteUserAsync(userLink);

こちらもご覧ください

• Permission
• RequestOptions
• ResourceResponse<TResource>
• Task

DeleteUserAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> DeleteUserAsync (Uri userUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member DeleteUserAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
override this.DeleteUserAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>

Public Function DeleteUserAsync (userUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

パラメーター

userUri

Uri

削除するユーザーの URI。

options

RequestOptions

要求の要求オプション。

戻り値

Task<ResourceResponse<User>>

非同期操作のサービス応答を表すタスク オブジェクト。

実装

DeleteUserAsync(Uri, RequestOptions)