Skip to content

add README for azure-functions-java-core #7

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.

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

Merged
merged 1 commit into from
Sep 7, 2017
Merged
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions azure-functions-java-core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Azure Functions Java Core

This package contains libraries to author Azure Functions in Java.

### Usage
Use this package by including the following snippet in your `pom.xml`.

```xml
<dependency>
<groupId>com.microsoft.azure.serverless</groupId>
<artifactId>azure-function-java-core</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
```

### Annotation for Triggers and Bindings
Instead of writing `function.json`, you can use annotations in code to specify triggers and bindings of your functions.
`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).

The following table lists the Java annotations for each binding type.

Binding | Annotation
---|---
CosmosDB | N/A
Event Hubs | <ul><li>`EventHubTrigger`</li><li>`EventHubOutput`</li></ul>
HTTP | <ul><li>`HttpTrigger`</li><li>`HttpOutput`</li></ul>
Mobile Apps | N/A
Notification Hubs | N/A
Service Bus | <ul><li>`ServiceBusQueueTrigger`</li><li>`ServiceBusQueueOutput`</li><li>`ServiceBusTopicTrigger`</li><li>`ServiceBusTopicOutput`</li></ul>
Storage Blob | <ul><li>`BlobTrigger`</li><li>`BlobOutput`</li><li>`StorageAccount`</li></ul>
Storage Queue | <ul><li>`QueueTrigger`</li><li>`QueueOutput`</li><li>`StorageAccount`</li></ul>
Storage Table | <ul><li>`TableInput`</li><li>`TableOutput`</li><li>`StorageAccount`</li></ul>
Timer | <ul><li>`TimerTrigger`</li></ul>
Twilio | N/A