Read
Read message from 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.Read
Task Parameters
SourceType : QueueOrTopic
Source type.
Possible values:
Queue: Source type.Topic: Source type.
Default: 0
Example: Queue
QueueOrTopicName : String
The name of the queue or topic.
Default: -
Example: QueueOrTopicName
SubscriptionName : String
The 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]
TimeoutSeconds : Int32
Timeout in seconds.
Default: 60
Example: 60
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
BodySerializationType : BodySerializationType
How the body is expected to be serialized.
Possible values:
Stream: How the body is expected to be serialized.ByteArray: How the body is expected to be serialized.String: How the body is expected to be serialized.
Default: 0
Example: Stream
DefaultEncoding : MessageEncoding
What encoding the message contents is expected to be in.
Possible values:
UTF8: What encoding the message contents is expected to be in.UTF32: What encoding the message contents is expected to be in.ASCII: What encoding the message contents is expected to be in.Unicode: What encoding the message contents is expected to be in.Latin1: What encoding the message contents is expected to be in.BigEndianUnicode: What encoding the message contents is expected to be in.
Default: 0
Example: UTF8, UTF32, ASCII, Unicode, Latin1, BigEndianUnicode
CreateQueueOrTopicIfItDoesNotExist : Boolean
Should the existence of the message source be checked and created if it does not exist.
Default: False
Example: False
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 and contains converter e.g. 61 minutes = 1 hour 1 minute.
Default: 5
Example: 5
TimeFormat : TimeFormat
Time format for AutoDeleteOnIdle.
Possible values:
Minutes: Time format for AutoDeleteOnIdle.Hours: Time format for AutoDeleteOnIdle.Days: Time format 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
Task Result
Results : List<ReadResult>
Read result.
Task Changelog
Changelog for Task Frends.ServiceBus.Read.
[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?