Sdílet prostřednictvím

Container.DeleteAllItemsByPartitionKeyStreamAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.45.0

Deletes all items in the Container with the specified PartitionKey value. Starts an asynchronous Cosmos DB background operation which deletes all items in the Container with the specified value. The asynchronous Cosmos DB background operation runs using a percentage of user RUs.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage> DeleteAllItemsByPartitionKeyStreamAsync (Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAllItemsByPartitionKeyStreamAsync : Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>
override this.DeleteAllItemsByPartitionKeyStreamAsync : Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>
Public Overridable Function DeleteAllItemsByPartitionKeyStreamAsync (partitionKey As PartitionKey, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)

Parameters

partitionKey
PartitionKey

The PartitionKey of the items to be deleted.

requestOptions
RequestOptions

(Optional) The options for the Partition Key Delete request.

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<ResponseMessage>

A Task containing a ResponseMessage.

Applies to