Arguments

Name	Description	Default
queueName R	Name of the queue
machine	Target machine	.
isPrivate	Is a private queue	True

SQL Call

exec msmq.CreateQueue 'myqueuename'

Http Call

/bsc/msmq/createqueue

Output Columns

Boolean Result

True/false indicator if queue was created successfully.

Arguments

Name	Description	Default
queueName R	Name of the queue
machine	Target machine	.
isPrivate	Is a private queue	True

SQL Call

exec msmq.DeleteQueue 'myqueuename'

Http Call

/bsc/msmq/deletequeue

Output Columns

Boolean Result

True/false indicator if queue was deleted successfully.

Arguments

Name	Description	Default
queueName R	Name of the queue
label	Optional label to use when checking the queue
machine	Target machine	.
isPrivate	Is a private queue	True

SQL Call

exec msmq.IsEmpty 'myqueuename'

Http Call

/bsc/msmq/isempty

Output Columns

Boolean IsEmpty

True/false indicating if a message is available for reading

Arguments

Name	Description	Default
machine	Target machine	.
type	"Public", "Private", or "All".	All
label	Only queues with this label
category	An optional Guid that represents the queue category (Message Queuing type identifier), which allows an application to categorize its queues.

SQL Call

exec msmq.ListQueues
SELECT * FROM msmq.Queues WHERE type = 'private'

Http Call

/bsc/msmq/listqueues

Output Columns

Object Id	Queue identifier
String MachineName	The name of the machine on which queue is defined.
String QueueName	The name that identifies the queue referenced.
String Path	The path on the machine of the queue.
String Label	The label for the message queue.
String Category	The category assigned to the queue.
Int64 MaxQueueSize	The maximum size, in kilobytes, of the queue. The Message Queuing default specifies that no limit exists.
Int64 MaximumJournalSize	The maximum size, in kilobytes, of the journal queue. The Message Queuing default specifies that no limit exists.
String MulticastAddress	The multicast address of the queue.
Boolean CanRead	true (1) if the MessageQueue exists and the application can read from it; otherwise, false (0).
Boolean CanWrite	true (1) if the MessageQueue exists and the application can write to it; otherwise, false (0).
Boolean Transactional	true (1) if the queue accepts only messages sent as part of a transaction; otherwise, false (0).
DateTime CreateTime	The date and time at which the queue was created.
DateTime LastModifyTime	Indicates when the queue properties were last modified.

Arguments

Name	Description	Default
queueName R	Name of the queue
timeout	Number of seconds to wait before returning	5
label	Optional label to use when reading the queue
machine	Target machine	.
isPrivate	Is a private queue	True

SQL Call

exec msmq.PeekMessage 'myqueuename'
SELECT * FROM msmq.PeekMessage WHERE queuename = 'myqueuename'

Http Call

/bsc/msmq/peekmessage

Output Columns

String Label
DateTime ArrivedOn
String Id
String CorrelationId
String MessageType
String Priority
String ResponseQueue
DateTime SentTime
String Body
Object Extension

Arguments

Name	Description	Default
queueName R	Name of the queue
machine	Target machine	.
isPrivate	Is a private queue	True

SQL Call

exec msmq.QueueExists 'myqueuename'

Http Call

/bsc/msmq/queueexists

Output Columns

Boolean Result

True/false indicator of queue existence

Arguments

Name	Description	Default
queueName R	Name of the queue
label	Optional label to use when reading the queue
timeout	Number of seconds to wait before returning	5
machine	Target machine	.
isPrivate	Is a private queue	True

SQL Call

exec msmq.ReadMessage 'myqueuename'
SELECT * FROM msmq.nextmessage WHERE queuename = 'myqueuename'

Http Call

/bsc/msmq/readmessage

Output Columns

String Label
DateTime ArrivedOn
String Id
String CorrelationId
String MessageType
String Priority
String ResponseQueue
DateTime SentTime
String Body
Object Extension

Arguments

Name	Description	Default
queueName R	Name of the queue
label	Optional label to use when writing the message
message R	String content to write to the queue
machine	Target machine	.
isPrivate	Is a private queue	True

SQL Call

exec msmq.WriteMessage 'myqueuename', null, 'This is a test'

Http Call

/bsc/msmq/writemessage

Output Columns

This call does not return data.