Skip to content

Commit a91ffe7

Browse files
authored
update README (#144)
update README
1 parent a18accd commit a91ffe7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,41 +5,41 @@
55
# RabbitMQ Binding Support for Azure Functions
66
NuGet Package [Microsoft.Azure.WebJobs.Extensions.RabbitMQ](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.RabbitMQ)
77

8-
The Azure Functions RabbitMQ Binding extensions allows you to send and receive messages using the RabbitMQ API but by writing Functions code. The RabbitMQ output binding sends messages to a specific queue. The RabbitMQ trigger fires when it receives a message from a specific queue.
8+
Please note that the RabbitMQ extension is fully supported on Premium and Dedicated plans. Consumption is not supported. The Azure Functions RabbitMQ Binding extensions allow you to send and receive messages using the RabbitMQ API but by writing Functions code. The RabbitMQ output binding sends messages to a specific queue. The RabbitMQ trigger fires when it receives a message from a specific queue.
99

1010
[RabbitMQ Documentation for the .NET Client](https://www.rabbitmq.com/dotnet-api-guide.html)
1111

12-
To get started with developing with this extension, make sure you first [set up a RabbitMQ endpoint](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Setting-up-a-RabbitMQ-Endpoint). Then you can go ahead and begin developing your functions in [C#](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-C%23), [JavaScript](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-JavaScript), [Python](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-Python) or [Java](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-Java). If you would like a way to handle messages that error, check out our [guide to configuring a dead letter exchange](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Configuring-a-Dead-Letter-Exchange-and-Queue).
12+
To get started with developing with this extension, make sure you first [set up a RabbitMQ endpoint](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Setting-up-a-RabbitMQ-Endpoint). Then you can go ahead and begin developing your functions in [C#](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-C%23), [C# Script](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-CSX), [JavaScript](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-JavaScript), [Python](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-Python) or [Java](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki/Samples-in-Java).
1313

1414
# Samples
1515

1616
See the repository [wiki](https://github.com/Azure/azure-functions-rabbitmq-extension/wiki) for more detailed samples of bindings to different types.
1717

1818
```C#
1919
public static void RabbitMQTrigger_RabbitMQOutput(
20-
[RabbitMQTrigger("queue", ConnectionStringSetting = "RabbitMQConnection")] string inputMessage,
20+
[RabbitMQTrigger("queue", ConnectionStringSetting = "RabbitMQConnectionAppSetting")] string inputMessage,
2121
[RabbitMQ(
22-
ConnectionStringSetting = "RabbitMQConnection",
22+
ConnectionStringSetting = "RabbitMQConnectionAppSetting",
2323
QueueName = "hello")] out string outputMessage,
2424
ILogger logger)
2525
{
2626
outputMessage = inputMessage;
27-
logger.LogInformation($"RabittMQ output binding function sent message: {outputMessage}");
27+
logger.LogInformation($"RabbitMQ output binding function sent message: {outputMessage}");
2828
}
2929
```
3030

31-
The above sample waits on a trigger from the queue named "queue" connected to the connection string value of key "RabbitMQConnection." The output binding takes the messages from the trigger queue and outputs them to queue "hello" connected to the connection configured by the key "RabibtMQConnection". When running locally, add the connection string setting to local.settings.json file. When running in Azure, add this setting as [Application Setting](https://docs.microsoft.com/en-us/azure/azure-functions/functions-how-to-use-azure-function-app-settings) for your app.
31+
The above sample waits on a trigger from the queue named "queue" connected to the connection string value of key "RabbitMQConnectionAppSetting." The output binding takes the messages from the trigger queue and outputs them to queue "hello" connected to the connection configured by the key "RabbitMQConnectionAppSetting". When running locally, add the connection string setting to local.settings.json file. When running in Azure, add this setting as [Application Setting](https://docs.microsoft.com/en-us/azure/azure-functions/functions-how-to-use-azure-function-app-settings) for your app.
3232

3333

3434
## Properties
3535

3636
|Property Name|Description|Example|
3737
|--|--|--|
3838
|ConnectionStringSetting|The connection string for the RabbitMQ queue|`amqp://user:password@url:port`|
39-
|QueueName|The name of the source or destination queue. To move failed messages to deadletter queue, please configure queue and exchange(https://www.rabbitmq.com/dlx.html)|`myQueue`|
40-
|HostName|(optional if using ConnectionStringSetting) Hostname of the queue|`10.26.45.210`|
41-
|UserName|(optional if using ConnectionStringSetting) User name to access queue|`user`|
42-
|Password|(optional if using ConnectionStringSetting) Password to access queue|`password1`|
39+
|QueueName|The name of the source or destination queue.|
40+
|HostName|(ignored if using ConnectionStringSetting) Hostname of the queue|`10.26.45.210`|
41+
|UserName|(ignored if using ConnectionStringSetting) User name to access queue|`user`|
42+
|Password|(ignored if using ConnectionStringSetting) Password to access queue|`password`|
4343

4444
# Contributing
4545

0 commit comments

Comments
 (0)