Send
Send message to Azure Service Bus queue or topic.
Task version: 1.1.0
Required Frends version: 5.5+
Required .NET version: 6.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.CrossplatformServiceBus/tree/main/Frends.ServiceBus.Send
Task Parameters
DestinationType : QueueOrTopic
Destination type.
Possible values:
Queue: Destination type.Topic: Destination type.
Default: 0
Example: Queue
QueueOrTopicName : String
Name of the queue or topic.
Default: -
Example: ExampleQueue
SubscriptionName : String
Name of the subscription.
Default: -
Example: SubscriptionName
🗝ConnectionString : String
Service Bus connection string.
Default: "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=[secret]"
Example: Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=[secret]
Properties : MessageProperty[]
Custom properties for the message.
Default: -
Example: Name = ExampleName, Value = ExampleValue
Data : String
Data to send.
Default: -
Example: Example text.
BodySerializationType : BodySerializationType
How should the body of the message be serialized.
Possible values:
Stream: How should the body of the message be serialized.ByteArray: How should the body of the message be serialized.String: How should the body of the message be serialized.
Default: 0
Example: Stream
ContentType : String
Content-Type descriptor.
Default: "text/plain; charset=UTF-8"
Example: text/plain; charset=UTF-8
MessageId : String
The message identifier can be used to detect duplicate messages. A new guid is generated as the value if left empty or null.
Default: -
Example: 254e5c7a-03eb-4637-935a-e1e61345c11d
SessionId : String
Message's session identifier. Messages can be filtered according to the session identifier and handled on the same Service Bus broker ensuring delivery order.
Default: -
Example: f580ef61-bd66-4676-b98f-b9804961b339
CorrelationId : String
The correlation identifier for the message can be used when filtering messages for subscriptions.
Default: -
Example: a1b58684-f04f-432a-bc73-1e72129ff6cc
ReplyTo : String
The reply to field for the message can be used to specify the name of the queue where the receiver of the message should reply to.
Default: -
Example: ReplyToQueue
ReplyToSessionId : String
The reply to session identifier can be used to specify the session identifier for a reply message.
Default: -
Example: fff56b95-af19-4e1b-87f4-3464543dab02
To : String
The intended recipient of the message.
Default: -
Example: Recipient
TimeToLiveSeconds : Nullable<Int64>
The time in seconds the message is kept in the queue before being discarded or deadlettered.
Default: -
Example: 60
ScheduledEnqueueTimeUtc : Nullable<DateTime>
UTC time when the message should be added to the queue. Can be used to delay the delivery of a message. Using DateTime.Now if left empty.
Default: -
Example: DateTime.Now.AddMinutes(5)
CreateQueueOrTopicIfItDoesNotExist : Boolean
Should the queue or topic be created if it does not already exist.
Default: False
Example: True
AutoDeleteOnIdle : Int32
Idle interval after which the queue or topic+subscription is automatically deleted. See TimeFormat to select Minutes/Hours/Days/Never. The minimum duration is 5 minutes. Contains converter e.g. 61 minutes = 1 hour 1 minute or 4 minutes = 5 minutes.
Default: 5
Example: 5, 61
TimeFormat : TimeFormat
Timeformat for AutoDeleteOnIdle.
Possible values:
Minutes: Timeformat for AutoDeleteOnIdle.Hours: Timeformat for AutoDeleteOnIdle.Days: Timeformat for AutoDeleteOnIdle.
Default: 0
Example: Minutes/Hours/Days/Never
MaxSize : Int32
The maximum size of the queue/topic in megabytes. Default value is 1024.
Default: 1024
Example: 1024
UseCachedConnection : Boolean
Should the Service Bus connection (MessagingFactory) be cached. This speeds up the execution as creating a new connection is slow by keeping the connection open in the background. A single namespace is limited to 1000 concurrent connections.
Default: True
Example: True
TimeoutSeconds : Int64
Timeout in seconds.
Default: 60
Example: 60
Task Result
Results : List<SendResult>
Send result.
Task Changelog
Changelog for Task Frends.ServiceBus.Send.
[1.1.0] - 2025-10-06
Changed
Updated Repository link in the metadata.
[1.0.0] - 2022-08-24
Added
Initial implementation
Last updated
Was this helpful?