com.microsoft.azure.functions.annotation

Annotation Type ServiceBusQueueOutput

@Retention(value=RUNTIME)
 @Target(value={PARAMETER,METHOD})
public @interface ServiceBusQueueOutput

Place this on a parameter whose value would be written to a service bus queue. The parameter type should be OutputBinding<T>, where T could be one of:

• Any native Java types such as int, String, byte[]
• Any POJO type

The following example shows a Java function that sends a Service Bus queue message:

 @FunctionName("httpToServiceBusQueue")
 @ServiceBusQueueOutput(name = "message", queueName = "myqueue", connection = "AzureServiceBusConnection")
 public String pushToQueue(
     @HttpTrigger(name = "request", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS)
     final String message,
     @HttpOutput(name = "response") final OutputBinding<String> result
 ) {
     result.setValue(message + " has been sent.");
     return message;
 }

Since:

1.0.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	connection Defines the app setting name that contains the Service Bus connection string.
String	name The variable name used in function.json.
String	queueName Defines the name of the Service Bus queue to which to write.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
AccessRights	access Defines the permission of the Service Bus queue to which to write.
String	dataType Defines how Functions runtime should treat the parameter value.

Element Detail

name

public abstract String name

The variable name used in function.json.

Returns:

The variable name used in function.json.

queueName

public abstract String queueName

Defines the name of the Service Bus queue to which to write.

Returns:

The Service Bus queue name string.

connection

public abstract String connection

Defines the app setting name that contains the Service Bus connection string.

Returns:

The app setting name of the connection string.

dataType

public abstract String dataType

Defines how Functions runtime should treat the parameter value. Possible values are:

• "" or string: treat it as a string whose value is serialized from the parameter
• binary: treat it as a binary data whose value comes from for example OutputBinding<byte[]>

Returns:

The dataType which will be used by the Functions runtime.

Default:

""

access

public abstract AccessRights access

Defines the permission of the Service Bus queue to which to write.

Returns:

The Service Bus queue permission.

Default:

com.microsoft.azure.functions.annotation.AccessRights.MANAGE