Skip to main content

PowerBus–Sending and receiving ServiceBus messages from powershell


I have been working on implementing ServiceBus using powershell. There is to my knowledge no modules/scripts available to communicate with ServiceBus from powershell. There is a Azure powershell module on Git that enables you to create/manage Queues/namespaces, however not to send/receive messages. Let’s just jump right in and test it.





Requrements:


  1. Create a Queue on Azure and recceive the connection Information (connectionstring) (http://azure.microsoft.com/en-us/documentation/articles/service-bus-dotnet-how-to-use-queues/)
  2. Download/clone the PowerBus repository on bitbucket (https://bitbucket.org/torgro/powerbus/wiki/Home)
  3. Unblock the downloaded zip file (unblock-file –path c:\temp\PowerBus.zip)
  4. Copy the module to one of your module paths
  5. Import-Module –Name PowerBus

How to use



After importing these commands will be available for you:

image

Get-BusMessage and Send-BusMessage are used for receiving and sending messages to the Queue. These functions need to know your connection string (ConnectionString) and the name of the Queue (QueueNameString.

image

You can provide those as parameters to the functions or you can add those 2 parameters with the Set-BusDefaults:

image

So if I run this: 
Set-BusDefaults -BusConnectionstring "Endpoint=sb://yourqueue.servicebus.windows.net/;SharedAccessKeyName=rootKey;SharedAccessKey=eLOdFasdaKJoiOIJhiuhO98hoihjLKH” -QueueName "testqueue"

This will add a couple of defaults to the PSDefaultParameterValues automatic variable at the module scope which will add the connection string and queuename as parameters when you call Get-BusMessage or Send-BusMessage. You can retrieve the current connection string and queue name with the Get-BusDefaults function.

image

So with the connection string set and the queue name added, we can start to send messages to the queue with Send-BusMessage:

image

We can retrieve the message with the Get-BusMessage command

image

The ServiceBus queue implements the FIFO principle (first in, first out). To de-queue messages, use the switch parameter dequeue. Default is peek mode when you run Get-BusMessage without the switch parameter. As you can see in the screenshot above, I first run Get-BusMessage to peek at the message, run it with the dequeue switch and finally try to get the message again with Get-BusMessage which returns $null (no messages in the queue).

Cheers

Tore

Comments

Popular posts from this blog

Serialize data with PowerShell

Currently I am working on a big new module. In this module, I need to persist data to disk and reprocess them at some point even if the module/PowerShell session was closed. I needed to serialize objects and save them to disk. It needed to be very efficient to be able to support a high volume of objects. Hence I decided to turn this serializer into a module called HashData.



Other Serializing methods

In PowerShell we have several possibilities to serialize objects. There are two cmdlets you can use which are built in:
Export-CliXmlConvertTo-JSON
Both are excellent options if you do not care about the size of the file. In my case I needed something lean and mean in terms of the size on disk for the serialized object. Lets do some tests to compare the different types:


(Hashdata.Object.ps1)

You might be curious why I do not use the Export-CliXML cmdlet and just use the [System.Management.Automation.PSSerializer]::Serialize static method. The static method will generate the same xml, however we …

Build your local powershell module repository - ProGet

So Windows Powershell Blog released a blog a couple of days ago (link). Not too long after, a discussion emerged about it being to complicated to setup. Even though the required software is open source (nugetgalleryserver), it looks like you need to have Visual Studio Installed to compile it. I looked into doing it without visual stuidio, however I have been unable to come up with a solution. I even tweeted about it since I am not an developer. Maybe someone how is familiar with “msbuild” could do a post on how to do it without VS.

Anyhow one of my twitter-friends (@sstranger) came to the rescue and pointed me in the direction of ProGet, hence the title of this post. ProGet comes in 2 different licensing modes
Free (reduced functionality)Enterprise (paid version with extra features)The good news is that the free version supports hosting a local PowershellGet repository which was my intention anyway. So off we go and create a Configration that can install ProGet for us. This is the conf…

Monitoring Orchestrator runbook events from Operations Manager

Today I will follow up on my colleague’s post Mr ITblog (Knut Huglen) about monitoring Orchestrator Runbook events.  He has build a nice double up SNMP loopback feature that does self monitoring in Orchestrator resulting in entries written to a special Windows Eventlog. Now we need to raise alerts in SCOM when one of his runbooks fails or sends a platform event, who knows there could be trouble lurking in his paradise.

We are not going to do anything fancy, however these are the steps we will be focusing on today:
Create a Management Pack for our customizations Create rules that collects the events from the orchestrator serverOff we go then and fire up the SCOM console and a powershell window. First we create a MP, I am going to use powershell to do this, however you may use the SCOM console as well (Administration – ManagementPacks – Action: Create Management Pack):



Import the Management Pack into SCOM and move on to the Authoring section in the SCOM console. Create a new rule:



Give the…