QueueClient.DeleteMessageAsync(String, String, CancellationToken) Method

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.20.1

Source:

QueueClient.cs

Permanently removes the specified message from its queue.

For more information, see Delete Message.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteMessageAsync (string messageId, string popReceipt, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteMessageAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteMessageAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteMessageAsync (messageId As String, popReceipt As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

messageId

String

ID of the message to delete.

popReceipt

String

Required. A valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.

cancellationToken

CancellationToken

Optional CancellationToken.

Returns

Task<Response>

Response.