Functions with queue triggers in Azure - Commands & Configuration

Introduction

Sometimes you want your app to do work only when new messages arrive in a queue. Azure Functions with queue triggers let your code run automatically when a message appears in an Azure Storage Queue. This helps you process tasks without checking the queue all the time.

When you want to process orders as soon as they are placed without delay.

When you need to resize images uploaded to storage automatically.

When you want to send emails after a user signs up, triggered by a queue message.

When you want to handle background tasks like data cleanup without blocking users.

When you want to scale processing automatically based on the number of messages.

Config File - function.json

function.json

{
  "bindings": [
    {
      "name": "myQueueItem",
      "type": "queueTrigger",
      "direction": "in",
      "queueName": "myqueue-items",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

This file tells Azure Functions to run the function when a new message arrives in the queue named myqueue-items. The myQueueItem is the variable that holds the message content. The connection points to the storage account connection string.

Commands

Create a new Azure Functions project using the .NET runtime to start building your function.

Terminal

func init MyQueueFunctionProj --worker-runtime dotnet

Expected Output

Writing C# project file to MyQueueFunctionProj.csproj

Writing host.json

Writing local.settings.json

Writing .gitignore

Function runtime initialized

→

--worker-runtime - Specifies the language runtime for the function app

Add a new function named QueueTriggerFunction that triggers when a message arrives in the queue.

Terminal

func new --name QueueTriggerFunction --template "Queue trigger"

Expected Output

Created new function 'QueueTriggerFunction' in project

→

--name - Sets the function name

→

--template - Chooses the function trigger template

Run the function app locally to test that it triggers when a message is added to the queue.

Terminal

func start

Expected Output

Hosting environment: Production

Content root path: /path/to/MyQueueFunctionProj

Now listening on: http://localhost:7071

Application started. Press Ctrl+C to shut down.

[QueueTriggerFunction] C# Queue trigger function processed message: Hello from queue

Add a test message to the Azure Storage Queue to trigger the function.

Terminal

az storage message put --queue-name myqueue-items --content "Hello from queue" --account-name mystorageaccount --account-key XXXXXXXXXXXXXXXXXXXXXXXXX

Expected Output

{"popReceipt":"AgAAAAMAAAAAAAAA+V7v1w==","timeNextVisible":"2024-06-01T12:00:00Z","messageId":"12345678-1234-1234-1234-123456789abc"}

→

--queue-name - Specifies the target queue

→

--content - The message content to add

→

--account-name - Storage account name

→

--account-key - Storage account key for authentication

Key Concept

If you remember nothing else from this pattern, remember: Azure Functions with queue triggers run your code automatically whenever a new message arrives in the specified queue.

Common Mistakes

Using the wrong queue name in the function.json file.

The function will not trigger because it listens to a different queue than where messages are sent.

Ensure the queueName in function.json matches exactly the queue where messages are added.

Not setting the AzureWebJobsStorage connection string in local.settings.json or Azure portal.

The function cannot connect to the storage account to read queue messages, so it never triggers.

Set the AzureWebJobsStorage connection string correctly in local.settings.json for local testing or in the app settings in Azure.

Running the function app without starting the Azure Storage Emulator or having access to the storage account.

The function cannot listen to the queue, so no messages trigger the function.

Start the Azure Storage Emulator locally or ensure the function app has network access to the Azure Storage account.

Summary

Initialize a new Azure Functions project with the correct runtime.

Create a function with a queue trigger that listens to a specific Azure Storage Queue.

Run the function app locally and add messages to the queue to see the function trigger automatically.

Ensure connection strings and queue names match between your function and storage account.

Practice

1. What does an Azure Function with a queue trigger do when a new message arrives in the queue?

easy

A. It automatically starts and processes the message.

B. It waits for manual activation to process the message.

C. It deletes the message without processing.

D. It sends an email notification only.

Solution

1. Step 1: Understand queue trigger behavior

   Queue triggers start the function automatically when a new message arrives in the queue.

2. Step 2: Identify the function's action

   The function processes the message as soon as it triggers without manual intervention.

3. Final Answer:

   It automatically starts and processes the message. -> Option A

4. Quick Check:

   Queue trigger = automatic start [OK]

Hint: Queue triggers start functions automatically on new messages [OK]

Common Mistakes:

• Thinking the function needs manual start
• Assuming the message is deleted without processing
• Confusing triggers with notifications

2. Which of the following is the correct way to declare a queue trigger in an Azure Function using Python?

easy

A. @app.queue_trigger(arg_name='msg', queue_name='myqueue', connection='AzureWebJobsStorage')

B. @blob_trigger(container_name='mycontainer')

C. @http_trigger(methods=['GET'])

D. @timer_trigger(schedule='0 */5 * * * *')

Solution

1. Step 1: Identify the correct trigger decorator

   Queue triggers use @app.queue_trigger with queue_name, connection, and arg_name parameters.

2. Step 2: Check other options

   Blob, HTTP, and timer triggers use different decorators and parameters.

3. Final Answer:

   @app.queue_trigger(arg_name='msg', queue_name='myqueue', connection='AzureWebJobsStorage') -> Option A

4. Quick Check:

   Queue trigger decorator = @app.queue_trigger [OK]

Hint: Queue triggers use @app.queue_trigger decorator with queue_name [OK]

Common Mistakes:

• Using wrong trigger decorators like @blob_trigger
• Missing required parameters like queue_name
• Confusing connection string names

3. Given this Azure Function code snippet in Python, what will be printed when a message with content 'Hello' arrives in the queue?

import logging
import azure.functions as func

def main(msg: func.QueueMessage):
    message = msg.get_body().decode('utf-8')
    logging.info(f'Received message: {message}')

medium

A. Error: msg.get_body() is not a function

B. Received message: b'Hello'

C. No output because logging is disabled

D. Received message: Hello

Solution

1. Step 1: Decode the message body

   The message body is decoded from bytes to string using decode('utf-8'), so 'Hello' is a string.

2. Step 2: Logging output

   The logging.info call prints 'Received message: Hello' to the logs.

3. Final Answer:

   Received message: Hello -> Option D

4. Quick Check:

   Decoded message logged = 'Received message: Hello' [OK]

Hint: Decode bytes to string before logging message content [OK]

Common Mistakes:

• Logging raw bytes without decoding
• Assuming get_body() is not callable
• Thinking logging is off by default

4. You deployed an Azure Function with a queue trigger, but it never runs when messages arrive. Which of these is the most likely cause?

medium

A. The function code has a syntax error in the main function.

B. The connection string for the storage account is incorrect or missing.

C. The queue name is misspelled in the trigger configuration.

D. The function app is set to manual scale mode.

Solution

1. Step 1: Check connection string

   If the connection string to the storage account is wrong or missing, the function cannot listen to the queue.

2. Step 2: Consider other causes

   While syntax errors cause deployment failure, misspelled queue names cause no trigger, but connection issues are most common.

3. Final Answer:

   The connection string for the storage account is incorrect or missing. -> Option B

4. Quick Check:

   Connection string error = no trigger run [OK]

Hint: Verify storage connection string first if function doesn't trigger [OK]

Common Mistakes:

• Ignoring connection string errors
• Assuming scaling mode stops triggers
• Overlooking queue name spelling

5. You want to process messages from two different queues in the same Azure Function app. What is the best way to configure this?

hard

A. Use one function with two queue triggers on the same method.

B. Combine both queues into one and use a single queue trigger.

C. Create two separate functions within the app, each with its own queue trigger for each queue.

D. Use a timer trigger to poll both queues manually.

Solution

1. Step 1: Understand function triggers

   Each function can have one trigger. To listen to two queues, create two functions with separate queue triggers.

2. Step 2: Evaluate other options

   One function cannot have two queue triggers on the same method; combining queues may not be feasible; timer triggers require manual polling.

3. Final Answer:

   Create two separate functions within the app, each with its own queue trigger for each queue. -> Option C

4. Quick Check:

   One trigger per function = two functions for two queues [OK]

Hint: Use separate functions for each queue trigger [OK]

Common Mistakes:

• Trying multiple triggers on one function method
• Merging queues without control
• Using timer triggers instead of queue triggers