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-CliXml ConvertTo-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 t

Toying with audio in powershell

Controlling mute/unmute and the volume on you computer with powershell. Add-Type -TypeDefinition @' using System.Runtime.InteropServices; [Guid("5CDF2C82-841E-4546-9722-0CF74078229A"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] interface IAudioEndpointVolume { // f(), g(), ... are unused COM method slots. Define these if you care int f(); int g(); int h(); int i(); int SetMasterVolumeLevelScalar(float fLevel, System.Guid pguidEventContext); int j(); int GetMasterVolumeLevelScalar(out float pfLevel); int k(); int l(); int m(); int n(); int SetMute([MarshalAs(UnmanagedType.Bool)] bool bMute, System.Guid pguidEventContext); int GetMute(out bool pbMute); } [Guid("D666063F-1587-4E43-81F1-B948E807363F"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] interface IMMDevice { int Activate(ref System.Guid id, int clsCtx, int activationParams, out IAudioEndpointVolume aev); } [Guid("A95664D2-9614-4F35-A746-DE8DB63617E6"), Inte

Something completely different – PoshARM

I needed a project for my Xmas holiday and I needed something remotely work related. Thus the dubious PoshARM PowerShell module was born and brought to life during my Xmas holiday. Simply put it is a module that lets you build – for now – simple Azure Resource Manager (ARM) templates with PowerShell .  The module can also import templates from a file or from the clipboard/string. Your partial template or ready made template can be exported as a PowerShell script. This blog post will walk you through how to use it and the features that is currently implemented.  Update 08.02.2017: The module is now published to the PowerShellGallery ( https://www.powershellgallery.com/packages/posharm ). It is still in beta version, however test coverage have increased and some bugs have been squashed during the testing. Also help is present, however somewhat lacking here and there. Update 18.01.2017: The module is now on GitHub. Here is the link to the repro  ( PoshARM on GitHub ) What