Share via

QueueClient.DeleteMessage(String, String, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Storage.Queues
Assembly:
Azure.Storage.Queues.dll
Package:
Azure.Storage.Queues v12.18.0
Package:
Azure.Storage.Queues v12.18.0-beta.2
Source:
QueueClient.cs
Source:
QueueClient.cs

Permanently removes the specified message from its queue.

For more information, see Delete Message.

public virtual Azure.Response DeleteMessage (string messageId, string popReceipt, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteMessage : string * string * System.Threading.CancellationToken -> Azure.Response
override this.DeleteMessage : string * string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteMessage (messageId As String, popReceipt As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Response

Response.

Applies to