Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Bing Search
    Couchbase
    CSV
    DB (RDBMS)
    Dropbox
    Files
    Flight Aware
    FTP
    GoogleDrive
    GoogleSearch
    GoogleSheet
    Geonames
    HttpEndpoint (REST)
    Insteon
    Loggly
    MailChimp
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    Slack
    SQL Server
    SQLX
    Sudoku
    Threading
    Twilio
    Twitter
    VellemanDMX
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/azurebus




Azure Bus


This adapter allows you to connect, manage, and interact with the Azure Bus (queues and topics).


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String busnamespace The service bus namespace
String name The name of the ACS account
String key The access key for the namespace
Int32 retries Number of retries in case of cloud connection failure 3

Handlers



AbandonQueueMessage Abandons a message in a lock state. details 

Arguments

Name Description Default
name R The name of the queue
lockId R The lock id of the message

SQL Call

exec bsc.AzureBus.AbandonQueueMessage 'testqueue', 'lockid'


Http Call

/bsc/azurebus/abandonqueuemessage

Output Columns

This call does not return data.

AbandonSubMessage Abandons a message in a lock state in a subscription. details 

Arguments

Name Description Default
topicName R The name of the topic
subname R The name of the subscription
lockId R The lock id of the message

SQL Call

exec bsc.AzureBus.AbandonSubMessage 'testqueue', 'mysubscription', 'lockid'


Http Call

/bsc/azurebus/abandonsubmessage

Output Columns

This call does not return data.

AddQueueAccessPolicy Adds a Service Bus queue Shared Access Policy details 

Arguments

Name Description Default
name R The name of the queue to update
policyName R The name of the policy
permissions R Comma-separated list of permissions (listen, send, manage) listen
primaryKey The primary access key (send null to generate one)
secondaryKey The secondary access key (send null to generate one)

SQL Call

exec bsc.AzureBus.AddQueueAccessPolicy 'myqueue', 'devaccount', 'listen,send'


Http Call

/bsc/azurebus/addqueueaccesspolicy

Output Columns

This call does not return data.

CompleteQueueMessage Completes a message in a lock state. details 

Arguments

Name Description Default
name R The name of the queue
lockId R The lock id of the message

SQL Call

exec bsc.AzureBus.CompleteQueueMessage 'testqueue', 'lockid'


Http Call

/bsc/azurebus/completequeuemessage

Output Columns

This call does not return data.

CompleteSubMessage Completes a message in a lock state in a subscription. details 

Arguments

Name Description Default
topicName R The name of the topic
subname R The name of the subscription
lockId R The lock id of the message

SQL Call

exec bsc.AzureBus.CompleteSubMessage 'testtopic', 'mysubscription', 'lockid'


Http Call

/bsc/azurebus/completesubmessage

Output Columns

This call does not return data.

CreateQueue Creates a new Service Bus queue details 

Arguments

Name Description Default
name R The name of the queue to create
ttlMsg Time to live (sec) for messages in a queue 60
ttlLock Time to live (sec) for a message lock 60
enableDeadLetter True to enable dead letter queues False
enableExpress True to enable express queues False
enablePartitioning True to enable partitioning of queues False
isAnonymous True to enable anonymous connections False
maxDeliveryCount Maximum number of delivery attempts 3
forwardDLTo The name of the dead-letter queue
forwardTo Name of a queue where messages will be forwarded to
maxSize Maximum size in MB (1024, 2048, 3072, 4096, 5120) 1024

SQL Call

exec bsc.AzureBus.CreateQueue 'myqueue'


Http Call

/bsc/azurebus/createqueue

Output Columns

This call does not return data.

CreateRuleAction Creates a new rule action on a subscription. details 

Arguments

Name Description Default
topicName R The name of the topic
subscriptionName R The name of the subscription
name R The name of the rule action
actionSqlExpression The SQL action (ex: SET priority = 1)
filterSqlExpression The SQL where clause of the filter (ex: state = 'FL' OR sys.label = 'urgent')

SQL Call

exec bsc.AzureBus.CreateRuleAction 'mytopic', 'mysubscription', 'rulename', 'set priority=1', 'sys.label=''mobileapp'''


Http Call

/bsc/azurebus/createruleaction

Output Columns

This call does not return data.

CreateSubscription Creates a subscription on a topic. details 

Arguments

Name Description Default
topicName R The name of the topic
subscriptionName R The name of the subscription
ttlMsg Time to live (sec) for messages in a queue 60
ttlLock Time to live (sec) for a message lock 60
dealLetterOnEvalErrors True to enable dead letter queue on evaluation errors False
dealLetterOnExpire True to enable dead letter queue on message expiration False
maxDeliveryCount Maximum number of delivery attempts 3
forwardDLTo The name of the dead-letter queue
forwardTo Name of a queue where messages will be forwarded to
sqlFilter An SQL-like filter used to determine which messages are received by this subcription

SQL Call

exec bsc.AzureBus.CreateSubscription 'mytopic', 'mysubscription'


Http Call

/bsc/azurebus/createsubscription

Output Columns

This call does not return data.

CreateTopic Creates a new Service Bus Topic details 

Arguments

Name Description Default
name R The name of the topic to create
ttlMsg Time to live (sec) for messages in a queue 60
enableExpress True to enable express queues False
enablePartitioning True to enable partitioning of queues False
isAnonymous True to enable anonymous connections False
enableFiltering True to enable filtering prior to publishing False
maxSize Maximum size in MB (1024, 2048, 3072, 4096, 5120) 1024

SQL Call

exec bsc.AzureBus.CreateTopic 'mytopic'


Http Call

/bsc/azurebus/createtopic

Output Columns

This call does not return data.

DeleteQueue Deletes a Service Bus Queue details 

Arguments

Name Description Default
name R The name of the queue to delete

SQL Call

exec bsc.AzureBus.DeleteQueue 'test'


Http Call

/bsc/azurebus/deletequeue

Output Columns

This call does not return data.

DeleteRuleAction Deletes a rule action on a subscription details 

Arguments

Name Description Default
topicName R The name of the topic
subscriptionName R The name of the subscription
name R The comma-separated list of names of the rule actions to delete; send * to delete all rule actions.

SQL Call

exec bsc.AzureBus.DeleteRuleAction 'mytopic', 'mysubscription', 'rulename'


Http Call

/bsc/azurebus/deleteruleaction

Output Columns

This call does not return data.

DeleteSubscription Deletes a Service Bus Subscription details 

Arguments

Name Description Default
topicName R The name of the topic where the subscription belongs
subscriptionName R The name of the subscription to delete

SQL Call

exec bsc.AzureBus.DeleteSubscription 'mytopic', 'mysubscription'


Http Call

/bsc/azurebus/deletesubscription

Output Columns

This call does not return data.

DeleteTopic Deletes a Service Bus Topic details 

Arguments

Name Description Default
name R The name of the topic to delete

SQL Call

exec bsc.AzureBus.DeleteTopic 'mytopic'


Http Call

/bsc/azurebus/deletetopic

Output Columns

This call does not return data.

ListQueue Lists available queues details 

Arguments


SQL Call

exec bsc.AzureBus.ListQueue 'test'


Http Call

/bsc/azurebus/listqueue

Output Columns

String nameThe name of the queue
String statusThe status of the queue
String sizeInBytesThe size of the queue
String queueLengthThe number of items in the queue
String lastAccessedTimeThe last date/time the queue was accessed
String createdAtThe creation date/time of the queue
String msgTTLMessage Time to Live in seconds
String isDeadLetterEnabledTrue when the dead letter queue is enabled
String enableExpressTrue when this is an express queue
String enablePartitioningTrue when partitioning is enabled
String forwardDLMessagesToName of the Dead Letter queue
String forwardToName of the queue where messages are forwarded
String isAnonymousAccessibleTrue when anonymous access is allowed
String isReadOnlyTrue when the queue is read-only
String lockDurationMessage lock duration in seconds
String maxDeliveryCountMaximum delivery count
String maxSizeInMegabytesMaximum size of the queue in MB
ListRuleAction Returns the list of filters on a subscription details 

Arguments

Name Description Default
topicName R The name of the topic
subscriptionName R The name of the subscription

SQL Call

exec bsc.AzureBus.ListRuleAction 'mytopic', 'mysubscription'


Http Call

/bsc/azurebus/listruleaction

Output Columns

String topicNameThe name of the topic
String subscriptionNameThe name of the subscription
String nameThe name of the rule action
String isReadOnlyTrue if the rule action is read-only
String createdAtCreation datetime of the rule action
String actionRequiresPreprocessingTrue if the Action command requires pre-processing
String actionSqlExpressionThe action SQL expression
String filterRequiresPreprocessingTrue if the SQL Filter requires pre-processing
String filterSqlExpressionThe filter SQL expression
ListSubscription Lists subscriptions that belong to a Topic details 

Arguments

Name Description Default
topicName R The name of the topic

SQL Call

exec bsc.AzureBus.ListSubscription 'mytopic'


Http Call

/bsc/azurebus/listsubscription

Output Columns

String topicNameThe name of the topic
String subscriptionNameThe name of the subscription
Int32 messageCountMessage count
String statusThe status of the subscription
DateTime lastAccessedThe last datetime the subscription was accessed
DateTime createdAtThe datetime the subscription was created
Int32 ttlMsgMessage time to live in seconds
Boolean readOnlyTrue when the subscription is read-only
Int32 maxDeliveryCountMaximum delivery count
Boolean dealLetterOnEvalErrorsTrue when messages are sent to the dead letter queue upon evaluation errors
Boolean dealLetterOnExpireTrue when messages are sent to the dead letter queue upon expiration
String forwardDLToThe name of the dead letter queue
String forwardToThe name of the queue where messages are forwarded to
Int32 ttlLockThe lock duration in seconds
String filtersA list of filters being applied on the subscription
ListTopic Lists available topics details 

Arguments


SQL Call

exec bsc.AzureBus.ListTopic


Http Call

/bsc/azurebus/listtopic

Output Columns

String nameThe name of the topic
String statusThe status of the queue
String sizeInBytesThe size of the queue
String lastAccessedTimeThe last date/time the queue was accessed
String createdAtThe creation date/time of the queue
String msgTTLMessage Time to Live in seconds
String enableExpressTrue when this is an express queue
String enablePartitioningTrue when partitioning is enabled
String isAnonymousAccessibleTrue when anonymous access is allowed
String isReadOnlyTrue when the queue is read-only
String maxSizeInMegabytesMaximum size of the queue in MB
PeekLockFromQueue Receives a message from a queue and leaves the message in the queue by releasing the lock, or removes it from the queue by completing the message. details 

Arguments

Name Description Default
name R The name of the queue
complete When true, completes and removes the message from the queue; when false, leaves the lock on the message (default) False
count Approximate number of messages to return 1
timeoutSec The timeout for the wait operation; specify 0 for infinite (default: 1 second) 1

SQL Call

exec bsc.AzureBus.PeekLockFromQueue 'testqueue'


Http Call

/bsc/azurebus/peeklockfromqueue

Output Columns

String nameThe name of the queue
String bodyThe body of the message as a string value
Object bodyAsBytesThe body of the message as a raw byte array
String messageIdThe message id
String correlationIdThe message correlation id
String sessionIdThe session id
String replyToThe reply to queue
String labelThe application label
String contentTypeThe content type
String propertiesThe message properties
Int64 sequenceNumberThe sequence number
String toThe send to address
DateTime enqueuedTimeUtcWhen the message was created
Int64 ttlThe message time to live in seconds
String deliveryCountThe delivery count for the message
String expiresUtcThe expiration date of the message
String lockedUntilUtcThe lock expiration date
String lockTokenThe Lock Token
String partitionKeyThe partition key of the message
String replyToSessionIdThe session id where replies should be sent
Int64 sizeThe size of the message in bytes
String viaPartitionKeyThe viaPartitionKey property of the message
PeekLockFromSubscription Receives a message from a queue and leaves the message in the queue by releasing the lock, or removes it from the queue by completing the message. details 

Arguments

Name Description Default
topicname R The name of the topic
subname R The name of the subscription
complete When true, completes and removes the message from the queue; when false, leaves the lock on the message (default) False
count Approximate number of messages to return 1
timeoutSec The timeout for the wait operation; specify 0 for infinite (default: 1 second) 1

SQL Call

exec bsc.AzureBus.PeekLockFromSubscription 'testqueue'


Http Call

/bsc/azurebus/peeklockfromsubscription

Output Columns

String topicnameThe name of the topic
String subnameThe name of the topic
String bodyThe body of the message as a string value
Object bodyAsBytesThe body of the message as a raw byte array
String messageIdThe message id
String correlationIdThe message correlation id
String sessionIdThe session id
String replyToThe reply to queue
String labelThe application label
String contentTypeThe content type
String propertiesThe message properties
Int64 sequenceNumberThe sequence number
String toThe send to address
DateTime enqueuedTimeUtcWhen the message was created
Int64 ttlThe message time to live in seconds
String deliveryCountThe delivery count for the message
String expiresUtcThe expiration date of the message
String lockedUntilUtcThe lock expiration date
String lockTokenThe Lock Token
String partitionKeyThe partition key of the message
String replyToSessionIdThe session id where replies should be sent
Int64 sizeThe size of the message in bytes
String viaPartitionKeyThe viaPartitionKey property of the message
ReadFromQueue Receives a message from a queue and removes the message immediately details 

Arguments

Name Description Default
name R The name of the queue
operation R Peek, PeekAbandon, PeekCommit, or ReadDelete peek
timeoutSec The timeout for the wait operation; specify 0 for infinite (default: 1 second) 1

SQL Call

SELECT TOP 2 * FROM AzureBus.Queue WHERE name = 'testqueue' AND operation = 'peek'


Http Call

/bsc/azurebus/readfromqueue

Output Columns

String nameThe name of the queue
String bodyThe body of the message as a string value
Object bodyAsBytesThe body of the message as a raw byte array
String messageIdThe message id
String correlationIdThe message correlation id
String sessionIdThe session id
String replyToThe reply to queue
String labelThe application label
String contentTypeThe content type
String propertiesThe message properties
Int64 sequenceNumberThe sequence number
String toThe send to address
DateTime enqueuedTimeUtcWhen the message was created
Int64 ttlThe message time to live in seconds
String deliveryCountThe delivery count for the message
String expiresUtcThe expiration date of the message
String lockedUntilUtcThe lock expiration date
String lockTokenThe Lock Token
String partitionKeyThe partition key of the message
String replyToSessionIdThe session id where replies should be sent
Int64 sizeThe size of the message in bytes
String viaPartitionKeyThe viaPartitionKey property of the message
ReadFromSub Receives a message from a subscription and removes the message immediately details 

Arguments

Name Description Default
topicname R The name of the topic
subName R The name of the subscription
operation R Peek, PeekAbandon, PeekComplete, or ReadDelete peek
timeoutSec The timeout for the wait operation; specify 0 for infinite (default: 1 second) 1

SQL Call

SELECT TOP 2 * FROM AzureBus.Subscription WHERE topicname = 'mytopic' AND subName = 'mysub' AND operation = 'peek'


Http Call

/bsc/azurebus/readfromsub

Output Columns

String topicnameThe name of the topic
String subNameThe name of the subscription
String bodyThe body of the message as a string value
Object bodyAsBytesThe body of the message as a raw byte array
String messageIdThe message id
String correlationIdThe message correlation id
String sessionIdThe session id
String replyToThe reply to queue
String labelThe application label
String contentTypeThe content type
String propertiesThe message properties
Int64 sequenceNumberThe sequence number
String toThe send to address
DateTime enqueuedTimeUtcWhen the message was created
Int64 ttlThe message time to live in seconds
String deliveryCountThe delivery count for the message
String expiresUtcThe expiration date of the message
String lockedUntilUtcThe lock expiration date
String lockTokenThe Lock Token
String partitionKeyThe partition key of the message
String replyToSessionIdThe session id where replies should be sent
Int64 sizeThe size of the message in bytes
String viaPartitionKeyThe viaPartitionKey property of the message
ReceiveDeleteFromQueue Receives a message from a queue and removes the message immediately details 

Arguments

Name Description Default
name R The name of the queue
count Approximate number of messages to return 1
timeoutSec The timeout for the wait operation; specify 0 for infinite (default: 1 second) 1

SQL Call

SELECT TOP 2 * FROM AzureBus.Queue WHERE name = 'testqueue'
exec bsc.AzureBus.ReceiveDeleteFromQueue 'testqueue'


Http Call

/bsc/azurebus/receivedeletefromqueue

Output Columns

String nameThe name of the queue
String bodyThe body of the message as a string value
Object bodyAsBytesThe body of the message as a raw byte array
String messageIdThe message id
String correlationIdThe message correlation id
String sessionIdThe session id
String replyToThe reply to queue
String labelThe application label
String contentTypeThe content type
String propertiesThe message properties
Int64 sequenceNumberThe sequence number
String toThe send to address
DateTime enqueuedTimeUtcWhen the message was created
Int64 ttlThe message time to live in seconds
String deliveryCountThe delivery count for the message
String expiresUtcThe expiration date of the message
String lockedUntilUtcThe lock expiration date
String lockTokenThe Lock Token
String partitionKeyThe partition key of the message
String replyToSessionIdThe session id where replies should be sent
Int64 sizeThe size of the message in bytes
String viaPartitionKeyThe viaPartitionKey property of the message
ReceiveDeleteFromSubscription Receives a message from a queue and removes the message immediately details 

Arguments

Name Description Default
topicname R The name of the topic
subname R The name of the subscription
count Approximate number of messages to return 1
timeoutSec The timeout for the wait operation; specify 0 for infinite (default: 1 second) 1

SQL Call

exec bsc.AzureBus.ReceiveDeleteFromSubscription 'testqueue'


Http Call

/bsc/azurebus/receivedeletefromsubscription

Output Columns

String topicnameThe name of the topic
String subnameThe name of the topic
String bodyThe body of the message as a string value
Object bodyAsBytesThe body of the message as a raw byte array
String messageIdThe message id
String correlationIdThe message correlation id
String sessionIdThe session id
String replyToThe reply to queue
String labelThe application label
String contentTypeThe content type
String propertiesThe message properties
Int64 sequenceNumberThe sequence number
String toThe send to address
DateTime enqueuedTimeUtcWhen the message was created
Int64 ttlThe message time to live in seconds
String deliveryCountThe delivery count for the message
String expiresUtcThe expiration date of the message
String lockedUntilUtcThe lock expiration date
String lockTokenThe Lock Token
String partitionKeyThe partition key of the message
String replyToSessionIdThe session id where replies should be sent
Int64 sizeThe size of the message in bytes
String viaPartitionKeyThe viaPartitionKey property of the message
RenewLockQueueMessage Extends the lock of a message. details 

Arguments

Name Description Default
name R The name of the queue
lockId R The lock id of the message

SQL Call

exec bsc.AzureBus.RenewLockQueueMessage 'testqueue', 'lockid'


Http Call

/bsc/azurebus/renewlockqueuemessage

Output Columns

This call does not return data.

RenewLockSubMessage Extends the lock of a message in a subscription. details 

Arguments

Name Description Default
topicName R The name of the topic
subname R The name of the subscription
lockId R The lock id of the message

SQL Call

exec bsc.AzureBus.RenewLockSubMessage 'testqueue', 'mysubscription', 'lockid'


Http Call

/bsc/azurebus/renewlocksubmessage

Output Columns

This call does not return data.

SendMessageAsBytesToQueue Send a message in a queue as a UTF-8 encoded byte array details 

Arguments

Name Description Default
name R The name of the queue where the message will be sent
body R The message content as a byte array
messageId A message identifier used to detect duplicate messages (cannot be longer than 128 characters)
correlationId A correlation identifier
sessionId A session identifier
replyTo The address of the queue to reply to
label An optional application label
contentType The content type (ex: application/pdf) application/octet-stream
properties A comma-separated list of key value pairs (ex: state=FL,flag=1 )
partitionKey PartitionKey used for transactional messages in non session-aware queues
msgTTL The message time-to-live in seconds 300
to The send to address
viaPartitionKey The PartitionKey value when a transaction is to be used to send messages via a transfer queue

SQL Call

exec bsc.AzureBus.SendMessageAsBytesToQueue 'myqueue', '0x0102030405', 'msg-001'


Http Call

/bsc/azurebus/sendmessageasbytestoqueue

Output Columns

This call does not return data.

SendMessageAsBytesToTopic Send a message in a queue as a UTF-8 encoded byte array details 

Arguments

Name Description Default
name R The name of the queue where the message will be sent
body R The message content as a byte array
messageId A message identifier used to detect duplicate messages (cannot be longer than 128 characters)
correlationId A correlation identifier
sessionId A session identifier
replyTo The address of the queue to reply to
label An optional application label
contentType The content type (ex: application/pdf) application/octet-stream
properties A comma-separated list of key value pairs (ex: state=FL,flag=1 )
partitionKey PartitionKey used for transactional messages in non session-aware queues
msgTTL The message time-to-live in seconds 300
to The send to address
viaPartitionKey The PartitionKey value when a transaction is to be used to send messages via a transfer queue

SQL Call

exec bsc.AzureBus.SendMessageAsBytesToTopic 'mytopic', '0x0102030405', 'msg-001'


Http Call

/bsc/azurebus/sendmessageasbytestotopic

Output Columns

This call does not return data.

SendMessageQueue Send a message in a queue details 

Arguments

Name Description Default
name R The name of the queue where the message will be sent
body The message content (leave null when sending a byte array content)
bodyAsBytes The message content as a byte array
messageId A message identifier used to detect duplicate messages
correlationId A correlation identifier
sessionId A session identifier
replyTo The address of the queue to reply to
label An optional application label
contentType The content type (ex: text/xml) text/plain
properties A comma-separated list of key value pairs (ex: state=FL,flag=1 )
partitionKey PartitionKey used for transactional messages in non session-aware queues
msgTTL The message time-to-live in seconds 300
to The send to address
viaPartitionKey The PartitionKey value when a transaction is to be used to send messages via a transfer queue

SQL Call

insert into AzureBus.queue (name, body, msgttl) values ('myqueue', 'test message', 600)


Http Call

/bsc/azurebus/sendmessagequeue

Output Columns

This call does not return data.

SendMessageTopic Send a message in a topic details 

Arguments

Name Description Default
name R The name of the topic
body The message content (leave null when sending a byte array content)
bodyAsBytes The message content as a byte array
messageId A message identifier used to detect duplicate messages
correlationId A correlation identifier
sessionId A session identifier
replyTo The address of the queue to reply to
label An optional application label
contentType The content type (ex: text/xml) text/plain
properties A comma-separated list of key value pairs (ex: state=FL,flag=1 )
partitionKey PartitionKey used for transactional messages in non session-aware queues
msgTTL The message time-to-live in seconds 300
to The send to address
viaPartitionKey The PartitionKey value when a transaction is to be used to send messages via a transfer queue

SQL Call

insert into AzureBus.Topic (name, body, msgttl) values ('mytopic', 'test message', 600)


Http Call

/bsc/azurebus/sendmessagetopic

Output Columns

This call does not return data.

SendMessageToQueue Send a message in a queue details 

Arguments

Name Description Default
name R The name of the queue where the message will be sent
body R The message content
messageId A message identifier used to detect duplicate messages
correlationId A correlation identifier
sessionId A session identifier
replyTo The address of the queue to reply to
label An optional application label
contentType The content type (ex: text/xml) text/plain
properties A comma-separated list of key value pairs (ex: state=FL,flag=1 )
partitionKey PartitionKey used for transactional messages in non session-aware queues
msgTTL The message time-to-live in seconds 300
to The send to address
viaPartitionKey The PartitionKey value when a transaction is to be used to send messages via a transfer queue

SQL Call

exec bsc.AzureBus.SendMessageToQueue 'myqueue', 'test'


Http Call

/bsc/azurebus/sendmessagetoqueue

Output Columns

This call does not return data.

SendMessageToTopic Send a message in a topic details 

Arguments

Name Description Default
name R The name of the queue where the message will be sent
body R The message content
messageId A message identifier used to detect duplicate messages
correlationId A correlation identifier
sessionId A session identifier
replyTo The address of the queue to reply to
label An optional application label
contentType The content type (ex: text/xml) text/plain
properties A comma-separated list of key value pairs (ex: state=FL,flag=1 )
partitionKey PartitionKey used for transactional messages in non session-aware queues
msgTTL The message time-to-live in seconds 300
to The send to address
viaPartitionKey The PartitionKey value when a transaction is to be used to send messages via a transfer queue

SQL Call

exec bsc.AzureBus.SendMessageToTopic 'mytopic', 'test'


Http Call

/bsc/azurebus/sendmessagetotopic

Output Columns

This call does not return data.

UpdateQueue Updates a Service Bus queue details 

Arguments

Name Description Default
name R The name of the queue to update
ttlMsg Time to live (sec) for messages in a queue
ttlLock Time to live (sec) for a message lock
status The status of the queue (enable, disable, sendonly, receiveonly)
enableDeadLetter True to enable dead letter queues
enableExpress True to enable express queues
enablePartitioning True to enable partitioning of queues
isAnonymous True to enable anonymous connections
maxDeliveryCount Maximum number of delivery attempts
forwardDLTo The name of the dead-letter queue
forwardTo Name of a queue where messages will be forwarded to
maxSize Maximum size in MB (1024, 2048, 3072, 4096, 5120)

SQL Call

exec bsc.AzureBus.UpdateQueue 'myqueue', 90


Http Call

/bsc/azurebus/updatequeue

Output Columns

This call does not return data.

UpdateSubscription Updates a subscription on a topic. details 

Arguments

Name Description Default
topicName R The name of the topic
subscriptionName R The name of the subscription
ttlMsg Time to live (sec) for messages in a queue
ttlLock Time to live (sec) for a message lock
status The status of the queue (enable, disable, sendonly)
dealLetterOnEvalErrors True to enable dead letter queue on evaluation errors
dealLetterOnExpire True to enable dead letter queue on message expiration
maxDeliveryCount Maximum number of delivery attempts
forwardDLTo The name of the dead-letter queue
forwardTo Name of a queue where messages will be forwarded to

SQL Call

exec bsc.AzureBus.UpdateSubscription 'mytopic', 'mysubscription', 600


Http Call

/bsc/azurebus/updatesubscription

Output Columns

This call does not return data.

UpdateTopic Updates a Service Bus Topic details 

Arguments

Name Description Default
name R The name of the topic to update
ttlMsg Time to live (sec) for messages in a queue
status The status of the queue (enable, disable, receiveonly)
enableExpress True to enable express queues
enablePartitioning True to enable partitioning of queues
isAnonymous True to enable anonymous connections
enableFiltering True to enable filtering prior to publishing
maxSize Maximum size in MB (1024, 2048, 3072, 4096, 5120)

SQL Call

exec bsc.AzureBus.UpdateTopic 'mytopic', 600


Http Call

/bsc/azurebus/updatetopic

Output Columns

This call does not return data.