Skip to content

Commit ae095bb

Browse files
author
Junyi Yi
authored
Merge pull request #7 from xscript/documentation
add README for azure-functions-java-core
2 parents c750c13 + ae34d88 commit ae095bb

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

azure-functions-java-core/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Azure Functions Java Core
2+
3+
This package contains libraries to author Azure Functions in Java.
4+
5+
### Usage
6+
Use this package by including the following snippet in your `pom.xml`.
7+
8+
```xml
9+
<dependency>
10+
<groupId>com.microsoft.azure.serverless</groupId>
11+
<artifactId>azure-function-java-core</artifactId>
12+
<version>1.0-SNAPSHOT</version>
13+
</dependency>
14+
```
15+
16+
### Annotation for Triggers and Bindings
17+
Instead of writing `function.json`, you can use annotations in code to specify triggers and bindings of your functions.
18+
`function.json` can be automatically generated by [Maven Plugin for Azure Functions](https://github.com/Microsoft/azure-maven-plugins/tree/master/azure-functions-maven-plugin).
19+
20+
The following table lists the Java annotations for each binding type.
21+
22+
Binding | Annotation
23+
---|---
24+
CosmosDB | N/A
25+
Event Hubs | <ul><li>`EventHubTrigger`</li><li>`EventHubOutput`</li></ul>
26+
HTTP | <ul><li>`HttpTrigger`</li><li>`HttpOutput`</li></ul>
27+
Mobile Apps | N/A
28+
Notification Hubs | N/A
29+
Service Bus | <ul><li>`ServiceBusQueueTrigger`</li><li>`ServiceBusQueueOutput`</li><li>`ServiceBusTopicTrigger`</li><li>`ServiceBusTopicOutput`</li></ul>
30+
Storage Blob | <ul><li>`BlobTrigger`</li><li>`BlobOutput`</li><li>`StorageAccount`</li></ul>
31+
Storage Queue | <ul><li>`QueueTrigger`</li><li>`QueueOutput`</li><li>`StorageAccount`</li></ul>
32+
Storage Table | <ul><li>`TableInput`</li><li>`TableOutput`</li><li>`StorageAccount`</li></ul>
33+
Timer | <ul><li>`TimerTrigger`</li></ul>
34+
Twilio | N/A

0 commit comments

Comments
 (0)