Skip to content

Document Blob Storage SDK type requirements #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Arnab Nandy (arnabnandy7) wants to merge 1 commit into
base: dev
Choose a base branch
from
+31 −0
Open

Document Blob Storage SDK type requirements #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,33 @@ Binary data is represented as `byte[]` or `Byte[]` in your Azure functions code.

Empty input values could be `null` as your functions argument, but a recommended way to deal with potential empty values is to use `Optional<T>` type.

### Blob Storage SDK types

Support for binding directly to Azure Blob Storage SDK types is currently in preview. `BlobClient` and `BlobContainerClient` parameters require:

* The `JAVA_ENABLE_SDK_TYPES` application setting set to `true`.
* Azure Functions Maven Plugin version 1.38.0 or later, or the corresponding Gradle plugin support.

Without these settings, the Java worker treats the parameter as a regular POJO and attempts to deserialize the blob content into it.

For example, a blob trigger can access blob properties through `BlobClient`:

```java
@FunctionName("processBlob")
public void run(
@BlobTrigger(
name = "content",
path = "images/{name}",
connection = "AzureWebJobsStorage") BlobClient blob,
@BindingName("name") String filename,
ExecutionContext context
) {
context.getLogger().info("Name: " + filename + ", Size: " + blob.getProperties().getBlobSize() + " bytes");
}
```

Only one SDK type can be used in a function definition. See the [Java developer guide](https://learn.microsoft.com/azure/azure-functions/functions-reference-java#sdk-types) for configuration, supported types, and troubleshooting information.


## Inputs

Expand Down
4 changes: 4 additions & 0 deletions src/main/java/com/microsoft/azure/functions/annotation/BlobTrigger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@
* <li>Any native Java types such as int, String, byte[]</li>
* <li>Nullable values using Optional&lt;T&gt;</li>
* <li>Any POJO type</li>
* <li>Azure Blob Storage SDK types {@code BlobClient} and {@code BlobContainerClient} (preview)</li>
* </ul>
*
* <p>SDK type parameters require the {@code JAVA_ENABLE_SDK_TYPES} application setting to be {@code true} and
* Azure Functions Maven Plugin version 1.38.0 or later (or corresponding Gradle plugin support). Without SDK type
* support enabled, the Java worker treats the parameter as a POJO.</p>
*
* <p>The following example shows a Java function that logs the filename and size when a blob is added or updated
* in the "samples-workitems" container:</p>
Expand Down