(PowerShell) Azure Service Bus - Read Queued Message

See more Azure Service Bus Examples

Demonstrates read a message from an Azure Service Bus Queue. The message is received and removed from the queue.

For more information, see https://docs.microsoft.com/en-us/rest/api/servicebus/receive-and-delete-message-destructive-read

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# Note: Requires Chilkat v9.5.0.65 or greater.

# 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.
$rest = New-Object Chilkat.Rest
$bAutoReconnect = $true
$success = $rest.Connect("<yournamespace>.servicebus.windows.net",443,$true,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# ----------------------------------------------------------------------------------------------
# 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..
# ----------------------------------------------------------------------------------------------

# Receive and delete a message from a queue named "gila";
$queueName = "gila"

# 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.
$sbToken = New-Object Chilkat.StringBuilder
$sbToken.LoadFile("qa_data/tokens/serviceBusSas.txt","utf-8")

# Tell the REST object to use the Azure Shared Access Signature for authorization.
$sbToken.Prepend("SharedAccessSignature ")
$rest.AddHeader("Authorization",$sbToken.GetAsString())

# Build the path..
$sbPath = New-Object Chilkat.StringBuilder
$sbPath.Append("/")
$sbPath.Append($queueName)
$sbPath.Append("/messages/head")

# Add timeout and api-version query parameters.
$rest.AddQueryParam("timeout","20")
$rest.AddQueryParam("api-version","2013-08")

# Use the DELETE HTTP verb to read the message at the head of the queue and remove it.
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("DELETE",$sbPath.GetAsString(),$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$("Response Status Code = " + $rest.ResponseStatusCode)

# Check for a success response.
if ($rest.ResponseStatusCode -ne 200) {
    $($rest.LastRequestStartLine)
    $($rest.LastRequestHeader)
    $($sbResponseBody.GetAsString())
    $("Failed.")
    exit
}

# If successful, the message is the contents of the response body.
$message = $sbResponseBody.GetAsString()
$("Dequeued message: " + $message)

$("Success.")