AzureFunctions.Worker.Extensions.IBMMQ 1.2.1

IBMMQ Extension for Azure Functions

This extension provides functionality for receiving IBM MQ messages in Azure Functions, allowing you to easily write functions that respond to any message published to IBM MQ.

Packages

This project is the source code for the following NuGet packages:

• AzureFunctions.Worker.Extensions.IBMMQ - IBMMQ extensions for .NET isolated functions
• AzureWebJobs.Extensions.IBMMQ - Azure WebJobs SDK IBMMQ Extension

Available bindings

Supported types

MQExtensionConfigProvider facilitates various types to use with the bindings, you can use the following:

(1) Native message with MQ properties, without conversion (requires a NuGet reference to IBMXMSDotnetClient):

• IBM.XMS.IMessage

(2) Converted message with some popular MQ properties (see MessageConverters - CreateMessage method):

• Azure.WebJobs.Extensions.IBMMQ.MQMessage
• Azure.WebJobs.Extensions.IBMMQ.MQTextMessage
• Azure.WebJobs.Extensions.IBMMQ.MQBytesMessage

(3) Converted message, only the body, without MQ properties:

• byte[]
• string

Example connection strings

As value for MQ_CONNECTION_STRING.

Certificate authentication:

Host=192.168.50.209;Port=1414;Channel=DEV.APP.SVRCONN;SSLCipherSpec=TLS_RSA_WITH_AES_256_CBC_SHA256;SSLCertLabel=mykey;SSLKeyRepo=*USER

Password authentication:

Host=localhost;Port=1414;Channel=DEV.APP.SVRCONN;UserId=app;Password=passw0rd

Running examples

If you don't have an MQ server available you can quickly have one using docker and running the following command:

docker run -e LICENSE=accept -e MQ_QMGR_NAME=QMGR -p 1414:1414 -p 9443:9443 -detach --name QMGR icr.io/ibm-messaging/mq:latest

To configure certificate authentication on the MQ-side, consider the following .mqsc script, which you can place into the container at /etc/mqm/ and it will automatically execute:

-- Enable SSL/TLS on the SVRCONN channel
ALTER CHANNEL('DEV.APP.SVRCONN') CHLTYPE(SVRCONN) SSLCIPH('ANY_TLS12')

-- Optional: Require clients to present a valid certificate for authentication
ALTER CHANNEL('DEV.APP.SVRCONN') CHLTYPE(SVRCONN) SSLCAUTH(REQUIRED)

-- Optional but recommended: Disable CHLAUTH temporarily to allow SSL-based access
ALTER QMGR CHLAUTH(DISABLED)

-- Apply and refresh SSL security settings
REFRESH SECURITY TYPE(SSL)

Then you can run either:

1. the Worker.Extensions.Samples project. Please note that this uses the assembly from NuGet, read more about it here.
2. the WebJobs.Extensions.Samples project. This runs the binding directly from /src/.

DevContainers

When using 'devcontainers', four containers are started (see ./devcontainer/docker-compose.yml for nitty gritty). The containers are connected to same network:

• devcontainer: provides your prompt and tools (e.g. dotNet and Azure function core),
• IBM MQ container: provides an IBM MQ dev instance
• Azurite container: provides storage for Azure function core
• generate-cert container: an init container only for creating fresh dev certificates

Run the WebJobs sample in the devcontainer:

• cd samples/WebJobs.Extensions.Samples
• mv local.settings.json local.settings.json.bak
• cp local.settings.devcontainer.json local.settings.json
• func start -v

FAQ

Q: How do i remove left-over devcontainers?
A: Go to folder ´.devcontainer/´ and run ´./cleanup-devcontainers.sh´