Container.DeleteItemStreamAsync メソッド

定義

名前空間:

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.ResponseMessage> DeleteItemStreamAsync (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteItemStreamAsync : string * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>

Public MustOverride Function DeleteItemStreamAsync (id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)

パラメーター

id

String

Cosmos アイテム ID

partitionKey

PartitionKey

項目のパーティション キー。

requestOptions

ItemRequestOptions

(省略可能)アイテム要求のオプション。

cancellationToken

CancellationToken

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

戻り値

Task<ResponseMessage>

Task削除リソース レコードをResponseMessage含む をStreamラップする を含む 。

例

Cosmos からアイテムを削除する

using(ResponseMessage response = await this.container.DeleteItemStreamAsync("itemId", new PartitionKey("itemPartitionKey")))
{
    if (!response.IsSuccessStatusCode)
    {
        //Handle and log exception
        return;
    }
}

注釈

Stream 操作は、クライアント側の例外でのみをスローします。 これは、パフォーマンスを向上させ、例外をスローするオーバーヘッドを防ぐためです。 操作が失敗した場合は、応答の HTTP 状態コードを確認してチェックします。