Skip to content

Commit ed3d1d0

Browse files
authored
Merge pull request #104736 from craigshoemaker/crs-functions-queue-restructure
Queue binding ref restructure
2 parents 7f01a9f + 868a52a commit ed3d1d0

18 files changed

+891
-840
lines changed

articles/app-service/webjobs-sdk-get-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Starting with version 3.x, you must explicitly install the Storage binding exten
174174

175175
The `QueueTrigger` attribute tells the runtime to call this function when a new message is written on an Azure Storage queue called `queue`. The contents of the queue message are provided to the method code in the `message` parameter. The body of the method is where you process the trigger data. In this example, the code just logs the message.
176176

177-
The `message` parameter doesn't have to be a string. You can also bind to a JSON object, a byte array, or a [CloudQueueMessage](https://docs.microsoft.com/dotnet/api/microsoft.azure.storage.queue.cloudqueuemessage) object. [See Queue trigger usage](../azure-functions/functions-bindings-storage-queue.md#trigger---usage). Each binding type (such as queues, blobs, or tables) has a different set of parameter types that you can bind to.
177+
The `message` parameter doesn't have to be a string. You can also bind to a JSON object, a byte array, or a [CloudQueueMessage](https://docs.microsoft.com/dotnet/api/microsoft.azure.storage.queue.cloudqueuemessage) object. [See Queue trigger usage](../azure-functions/functions-bindings-storage-queue-trigger.md#usage). Each binding type (such as queues, blobs, or tables) has a different set of parameter types that you can bind to.
178178

179179
## Create a storage account
180180

@@ -270,7 +270,7 @@ In this section, you build and run the project locally and trigger the function
270270

271271
Because you used the `QueueTrigger` attribute in the `ProcessQueueMessage` function, the WeJobs SDK runtime listens for queue messages when it starts up. It finds a new queue message in the queue named *queue* and calls the function.
272272

273-
Due to [queue polling exponential backoff](../azure-functions/functions-bindings-storage-queue.md#trigger---polling-algorithm), it might take as long as 2 minutes for the runtime to find the message and invoke the function. This wait time can be reduced by running in [development mode](webjobs-sdk-how-to.md#host-development-settings).
273+
Due to [queue polling exponential backoff](../azure-functions/functions-bindings-storage-queue-trigger.md#polling-algorithm), it might take as long as 2 minutes for the runtime to find the message and invoke the function. This wait time can be reduced by running in [development mode](webjobs-sdk-how-to.md#host-development-settings).
274274

275275
The console output looks like this:
276276

@@ -433,7 +433,7 @@ During deployment, you create an app service instance in which to run your funct
433433
1. Refresh the **Queue** page, and the new message disappears because it has been processed by the function running in Azure.
434434

435435
> [!TIP]
436-
> When you're testing in Azure, use [development mode](webjobs-sdk-how-to.md#host-development-settings) to ensure that a queue trigger function is invoked right away and avoid delays due to [queue polling exponential backoff](../azure-functions/functions-bindings-storage-queue.md#trigger---polling-algorithm).
436+
> When you're testing in Azure, use [development mode](webjobs-sdk-how-to.md#host-development-settings) to ensure that a queue trigger function is invoked right away and avoid delays due to [queue polling exponential backoff](../azure-functions/functions-bindings-storage-queue-trigger.md#polling-algorithm).
437437

438438
### View logs in Application Insights
439439

articles/app-service/webjobs-sdk-how-to.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ static async Task Main()
450450
}
451451
```
452452

453-
For more details, see the [Queue storage binding](../azure-functions/functions-bindings-storage-queue.md#hostjson-settings) article.
453+
For more details, see the [Queue storage binding](../azure-functions/functions-bindings-storage-queue-trigger.md#hostjson-properties) article.
454454

455455
#### Version 2.*x*
456456

@@ -677,11 +677,11 @@ For more information, see [Binding at runtime](../azure-functions/functions-dotn
677677

678678
The Azure Functions documentation provides reference information about each binding type. You'll find the following information in each binding reference article. (This example is based on Storage queue.)
679679

680-
* [Packages](../azure-functions/functions-bindings-storage-queue.md#packages---functions-1x). The package you need to install to include support for the binding in a WebJobs SDK project.
681-
* [Examples](../azure-functions/functions-bindings-storage-queue.md#trigger). Code samples. The C# class library example applies to the WebJobs SDK. Just omit the `FunctionName` attribute.
682-
* [Attributes](../azure-functions/functions-bindings-storage-queue.md#trigger---attributes-and-annotations). The attributes to use for the binding type.
683-
* [Configuration](../azure-functions/functions-bindings-storage-queue.md#trigger---configuration). Explanations of the attribute properties and constructor parameters.
684-
* [Usage](../azure-functions/functions-bindings-storage-queue.md#trigger---usage). The types you can bind to and information about how the binding works. For example: polling algorithm, poison queue processing.
680+
* [Packages](../azure-functions/functions-bindings-storage-queue.md). The package you need to install to include support for the binding in a WebJobs SDK project.
681+
* [Examples](../azure-functions/functions-bindings-storage-queue-trigger.md). Code samples. The C# class library example applies to the WebJobs SDK. Just omit the `FunctionName` attribute.
682+
* [Attributes](../azure-functions/functions-bindings-storage-queue-trigger.md#attributes-and-annotations). The attributes to use for the binding type.
683+
* [Configuration](../azure-functions/functions-bindings-storage-queue-trigger.md#configuration). Explanations of the attribute properties and constructor parameters.
684+
* [Usage](../azure-functions/functions-bindings-storage-queue-trigger.md#usage). The types you can bind to and information about how the binding works. For example: polling algorithm, poison queue processing.
685685

686686
For a list of binding reference articles, see "Supported bindings" in the [Triggers and bindings](../azure-functions/functions-triggers-bindings.md#supported-bindings) article for Azure Functions. In that list, the HTTP, Webhooks, and Event Grid bindings are supported only by Azure Functions, not by the WebJobs SDK.
687687

articles/azure-functions/TOC.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,13 @@
371371
- name: Notification Hubs
372372
href: functions-bindings-notification-hubs.md
373373
- name: Queue storage
374-
href: functions-bindings-storage-queue.md
374+
items:
375+
- name: Overview
376+
href: functions-bindings-storage-queue.md
377+
- name: Trigger
378+
href: functions-bindings-storage-queue-trigger.md
379+
- name: Output
380+
href: functions-bindings-storage-queue-output.md
375381
- name: SendGrid
376382
href: functions-bindings-sendgrid.md
377383
- name: Service Bus

articles/azure-functions/functions-add-output-binding-storage-queue-python.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ To write to an Azure Storage queue from this function, add an `out` binding of t
9595

9696
In this case, `msg` is given to the function as an output argument. For a `queue` type, you must also specify the name of the queue in `queueName` and provide the *name* of the Azure Storage connection (from *local.settings.json*) in `connection`.
9797

98-
For more information on the details of bindings, see [Azure Functions triggers and bindings concepts](functions-triggers-bindings.md) and [queue output configuration](functions-bindings-storage-queue.md#output---configuration).
98+
For more information on the details of bindings, see [Azure Functions triggers and bindings concepts](functions-triggers-bindings.md) and [queue output configuration](functions-bindings-storage-queue-output.md#configuration).
9999

100100
## Add code to use the output binding
101101

@@ -214,7 +214,7 @@ When your function generates an HTTP response for the web browser, it also calls
214214
---
215215
216216
217-
1. Use the [`az storage message peek`](/cli/azure/storage/message#az-storage-message-peek) command to view the messages in this queue, which should be the first name you used when testing the function earlier. The command retrieves the first message in the queue in [base64 encoding](functions-bindings-storage-queue.md#encoding), so you must also decode the message to view as text.
217+
1. Use the [`az storage message peek`](/cli/azure/storage/message#az-storage-message-peek) command to view the messages in this queue, which should be the first name you used when testing the function earlier. The command retrieves the first message in the queue in [base64 encoding](functions-bindings-storage-queue-trigger.md#encoding), so you must also decode the message to view as text.
218218
219219
# [bash](#tab/bash)
220220

articles/azure-functions/functions-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ How does your code react if a failure occurs after inserting 5,000 of those item
5959

6060
If a queue item was already processed, allow your function to be a no-op.
6161

62-
Take advantage of defensive measures already provided for components you use in the Azure Functions platform. For example, see **Handling poison queue messages** in the documentation for [Azure Storage Queue triggers and bindings](functions-bindings-storage-queue.md#trigger---poison-messages).
62+
Take advantage of defensive measures already provided for components you use in the Azure Functions platform. For example, see **Handling poison queue messages** in the documentation for [Azure Storage Queue triggers and bindings](functions-bindings-storage-queue-trigger.md#poison-messages).
6363

6464
## Scalability best practices
6565

articles/azure-functions/functions-bindings-error-pages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ When integrating with Azure services, errors may originate from the APIs of the
3030

3131
+ [Notification Hubs](functions-bindings-notification-hubs.md#exceptions-and-return-codes)
3232

33-
+ [Queue storage](functions-bindings-storage-queue.md#exceptions-and-return-codes)
33+
+ [Queue storage](functions-bindings-storage-queue-output.md#exceptions-and-return-codes)
3434

3535
+ [Service Bus](functions-bindings-service-bus.md#exceptions-and-return-codes)
3636

articles/azure-functions/functions-bindings-expressions-patterns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ These metadata values are accessible in *function.json* file properties. For exa
175175
]
176176
```
177177

178-
Details of metadata properties for each trigger are described in the corresponding reference article. For an example, see [queue trigger metadata](functions-bindings-storage-queue.md#trigger---message-metadata). Documentation is also available in the **Integrate** tab of the portal, in the **Documentation** section below the binding configuration area.
178+
Details of metadata properties for each trigger are described in the corresponding reference article. For an example, see [queue trigger metadata](functions-bindings-storage-queue-trigger.md#message-metadata). Documentation is also available in the **Integrate** tab of the portal, in the **Documentation** section below the binding configuration area.
179179

180180
## JSON payloads
181181

0 commit comments

Comments
 (0)