Create a function triggered by Azure Queue storage
Learn how to create a function triggered when messages are submitted to an Azure Storage queue.
Download and install the Microsoft Azure Storage Explorer.
An Azure subscription. If you don't have one, create a free account before you begin.
Favorite Functions in the portal
If you haven't already done so, add Function Apps to your favorites in the Azure portal. This makes it easier to find your function apps. If you have already done this, skip to the next section.
Log in to the Azure portal.
Click the arrow at the bottom left to expand all services, type
Functionsin the Filter field, and then click the star next to Function Apps.
This adds the Functions icon to the menu on the left of the portal.
Close the menu, then scroll down to the bottom to see the Functions icon. Click this icon to see a list of all your function apps. Click your function app to work with functions in this app.
Create an Azure Function app
Click Create a resource in the upper left-hand corner of the Azure portal, then select Compute > Function App.
Use the function app settings as specified in the table below the image.
Setting Suggested value Description App name Globally unique name Name that identifies your new function app. Valid characters are
Subscription Your subscription The subscription under which this new function app is created. Resource Group myResourceGroup Name for the new resource group in which to create your function app. OS Windows Serverless hosting is currently only available when running on Windows. For Linux hosting, see Create your first function running on Linux using the Azure CLI. Hosting plan Consumption plan Hosting plan that defines how resources are allocated to your function app. In the default Consumption Plan, resources are added dynamically as required by your functions. In this serverless hosting, you only pay for the time your functions run. Location West Europe Choose a region near you or near other services your functions access. Storage account Globally unique name Name of the new storage account used by your function app. Storage account names must be between 3 and 24 characters in length and may contain numbers and lowercase letters only. You can also use an existing account.
Click Create to provision and deploy the new function app. You can monitor the status of the deployment by clicking the Notification icon in the upper-right corner of the portal.
Clicking Go to resource takes you to your new function app.
Next, you create a function in the new function app.
Create a Queue triggered function
Expand your function app and click the + button next to Functions. If this is the first function in your function app, select Custom function. This displays the complete set of function templates.
In the search field, type
queueand then choose your desired language for the Queue storage trigger template.
Use the settings as specified in the table below the image.
Setting Suggested value Description Name Unique in your function app Name of this queue triggered function. Queue name myqueue-items Name of the queue to connect to in your Storage account. Storage account connection AzureWebJobStorage You can use the storage account connection already being used by your function app, or create a new one.
Click Create to create your function.
Next, you connect to your Azure Storage account and create the myqueue-items storage queue.
Create the queue
In your function, click Integrate, expand Documentation, and copy both Account name and Account key. You use these credentials to connect to the storage account in Azure Storage Explorer. If you have already connected your storage account, skip to step 4.
Run the Microsoft Azure Storage Explorer tool, click the connect icon on the left, choose Use a storage account name and key, and click Next.
Enter the Account name and Account key from step 1, click Next and then Connect.
Expand the attached storage account, right-click Queues, click Create Queue, type
myqueue-items, and then press enter.
Now that you have a storage queue, you can test the function by adding a message to the queue.
Test the function
Back in the Azure portal, browse to your function, expand the Logs at the bottom of the page, and make sure that log streaming isn't paused.
In Storage Explorer, expand your storage account, Queues, and myqueue-items, then click Add message.
Type your "Hello World!" message in Message text and click OK.
Wait for a few seconds, then go back to your function logs and verify that the new message has been read from the queue.
Back in Storage Explorer, click Refresh and verify that the message has been processed and is no longer in the queue.
Clean up resources
Other quick starts in this collection build upon this quick start. If you plan to work with subsequent quick starts, tutorials, or with any of the services you have created in this quick start, do not clean up the resources.
Resources in Azure refers to function apps, functions, storage accounts, and so forth. They are grouped into resource groups, and you can delete everything in a group by deleting the group.
You created resources to complete these quickstarts. You may be billed for these resources, depending on your account status and service pricing. If you don't need the resources anymore, here's how to delete them:
In the Azure portal, go to the Resource group page.
To get to that page from the function app page, select the Overview tab and then select the link under Resource group.
To get to that page from the dashboard, select Resource groups, and then select the resource group that you used for this quickstart.
In the Resource group page, review the list of included resources, and verify that they are the ones you want to delete.
Select Delete resource group, and follow the instructions.
Deletion may take a couple of minutes. When it's done, a notification appears for a few seconds. You can also select the bell icon at the top of the page to view the notification.
You have created a function that runs when a message is added to a storage queue.
Learn how to create functions with other kinds of triggers or how to integrate functions with other Azure services.
- Create a function that runs on a schedule
- Create a function triggered by Storage queue messages
- Create a function triggered by a generic webhook
- Create a function triggered by a GitHub webhook
- Add messages to an Azure Storage queue using Functions
- Store unstructured data in Azure Cosmos DB using Functions
For more information about Queue storage triggers, see Azure Functions Storage queue bindings.