Lua

Azure Service Bus - Delete Message

See more Azure Service Bus Examples

Deletes a message from a queue or subscription.

For more information, see https://docs.microsoft.com/en-us/rest/api/servicebus/unlock-message

Lua

local chilkat = require("chilkat")

-- This requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

-- Make the initial connection.
-- A single REST object, once connected, can be used for many Azure Service Bus REST API calls.
-- The auto-reconnect indicates that if the already-established HTTPS connection is closed,
-- then it will be automatically re-established as needed.
local rest = chilkat.Rest.new()
local bAutoReconnect = true
local success = rest:connect("<yournamespace>.servicebus.windows.net", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- Let's load a previously computed SAS token and use it.
-- See Azure Shared Access Signature for an example to genenerate an Azure SAS token.
local sbToken = chilkat.StringBuilder.new()
sbToken:load_file("qa_data/tokens/serviceBusSas.txt", "utf-8")

-- Tell the REST object to use the Azure Shared Access Signature for authorization.
sbToken:prepend("SharedAccessSignature ")
rest:add_header("Authorization", sbToken:get_as_string())

-- ----------------------------------------------------------------------------------------------
-- The code above this comment could be placed inside a function/subroutine within the application
-- because the connection does not need to be made for every request.  Once the connection is made
-- the app may send many requests..
-- ----------------------------------------------------------------------------------------------

-- To delete a message, we'll need either the SequenceNumber or MessageId.
-- When the message was peek-locked, the SequenceNumber and MessageId of the locked message
-- was returned in the HTTP response header named "BrokerProperties, which contained
-- JSON such as the following:
--
--     {
--       "DeliveryCount": 1,
--       "EnqueuedSequenceNumber": 3000004,
--       "EnqueuedTimeUtc": "Wed, 07 Dec 2016 17:42:48 GMT",
--       "Label": "M3",
--       "LockToken": "6eeee205-e541-4cb6-95fb-4c81da5f6858",
--       "LockedUntilUtc": "Thu, 08 Dec 2016 00:57:32 GMT",
--       "MessageId": "e8028116d63c43f191577f2789b1cca7",
--       "SequenceNumber": 4,
--       "State": "Active",
--       "TimeToLive": 922337193600
--     }
--
--
-- The path for unlocking a message is constructed as follows, depending on
-- whether it is a message on a queue or subscription:
--
-- (for a queue)
-- /{queuePath}/messages/{messageId|sequenceNumber}/{lockToken}
--
-- (for a subscription)
-- /{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}

-- This example will build a path to delete a message contained in a subscription.
local topicName = "gilaMonster"
local subscriptionName = "feedings"
local messageId = "e8028116d63c43f191577f2789b1cca7"
local lockToken = "6eeee205-e541-4cb6-95fb-4c81da5f6858"

-- Build the path..
local sbPath = chilkat.StringBuilder.new()
sbPath:append("/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}")
local numReplaced = sbPath:replace("{topicPath}", topicName)
numReplaced = sbPath:replace("{subscriptionName}", subscriptionName)
numReplaced = sbPath:replace("{messageId|sequenceNumber}", messageId)
numReplaced = sbPath:replace("{lockToken}", lockToken)

-- Add a timeout parameter.
rest:add_query_param("timeout", "20")

-- Use the DELETE HTTP verb to delete the message.
local sbResponseBody = chilkat.StringBuilder.new()
success = rest:full_request_no_body_sb("DELETE", sbPath:get_as_string(), sbResponseBody)
if not success then
    print(rest.last_error_text)
    return
end

print("Response Status Code = " .. rest.response_status_code)

-- Check for a success response.
if rest.response_status_code ~= 200 then
    print(rest.last_request_start_line)
    print(rest.last_request_header)
    print(sbResponseBody:get_as_string())
    print("Failed.")
    return
end

-- If successful, the response body would be empty..
print("Success.")