com.microsoft.azure.functions.annotation

Annotation Type BlobOutput

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

Place this on a parameter whose value would be written to a blob. 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 blob input and output bindings in a Java function. The function makes a copy of a text blob. The function is triggered by a queue message that contains the name of the blob to copy. The new blob is named {originalblobname}-Copy.

 @FunctionName("copyTextBlob")
 @StorageAccount("AzureWebJobsStorage")
 @BlobOutput(name = "target", path = "samples-workitems/{queueTrigger}-Copy")
 public String blobCopy(
     @QueueTrigger(name = "filename",
                   queueName = "myqueue-items") String filename,
     @BlobInput(name = "source",
                path = "samples-workitems/{queueTrigger}") String content
 ) {
     return content;
 }

Since:

1.0.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The variable name used in function.json.
String	path Defines the path of the blob to which to write.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	connection Defines the app setting name that contains the Azure Storage connection string.
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.

path

public abstract String path

Defines the path of the blob to which to write.

Returns:

The blob path 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:

""

connection

public abstract String connection

Defines the app setting name that contains the Azure Storage connection string.

Returns:

The app setting name of the connection string.

Default:

""