Skip to content

Servicebus

This task performs Azure SerciceBus operations to a specified endpoint.

Step implementations

Arguments

  • direction RequestDirection - if the request is upstream or downstream

  • endpoint str - specifies details to be able to perform the request, e.g. Service Bus resource, queue, topic, subscription etc.

  • name str - name used in locust statistics

  • destination str (optional) - not used by this client

  • source str (optional) - file path of local file that should be put on endpoint

Format

endpoint

sb://[<username>:<password>@]<sbns resource name>[.servicebus.windows.net]/[queue:<queue name>|topic:<topic name>[/subscription:<subscription name>]][/expression:<expression>][;SharedAccessKeyName=<policy name>;SharedAccessKey=<access key>][#[Consume=<consume>][&MessageWait=<wait>][&ContentType<content type>][&Tenant=<tenant>][&Empty=<empty>][&Unique=<unique>][&Verbose=<verbose>][&Forward=<forward>]]

All variables in the endpoint have support for Templating.

Network location:

  • <username> str - when using credentials, authenticate with this username

  • <password> str - password for said user

  • <sbns resource name> str - must be specfied, Azure Service Bus Namespace name, with or without domain name

Path:

  • <queue name> str - name of queue, prefixed with queue: of an existing queue (mutual exclusive1)

  • <topic name> str - name of topic, prefixed with topic: of an existing topic (mutual exclusive1)

  • <subscription name> str - name of an subscription on topic name, either an existing, or one to be created (if step text containing SQL Filter rule is specified), the actual subscription name will be suffixed with unique id related to the user instance

  • <expression> str - JSON or XPath expression to filter out message on payload, only applicable when receiving messages

1 Either specify queue: or topic, not both

Query:

  • <policy name> str - name of the Service Bus policy to be used

  • <access key> str - secret access key for specified policy name

Fragment:

  • <consume> bool - if messages should be consumed (removed from endpoint), or only peeked at (left on endpoint) (default: True)

  • <wait> int - how many seconds to wait for a message to arrive on the endpoint (default: ∞)

  • <content type> str - content type of response payload, should be used in combination with <expression>

  • <tenant> str - when using credentials, tenant to authenticate with

  • <empty> bool - if endpoint should be emptied before each iteration, default True

  • <unique> bool - if each instance should have their own endpoint, or if they should share (default True, have their own endpoint subscription)

  • <verbose> bool - verbose logging for only these requests (default False)

  • <forward> bool - if a queue should be created and the subscription should forward to it, and consuming messages from the queue (default False)

If <unique> is False, it will not empty the endpoint between each iteration.

Parts listed below are mutally exclusive, e.g. either ones should be used, but no combinations between the two.

Connection strings

If connection strings is to be used for authenticating, the following endpoint parts must be present:

  • <policy name>

  • <access key>

Credential

If credential is to be used for authenticating, the following endpoint parts must be present:

  • <username>

  • <password>

  • <tenant>