Skip to content

Commit a058b17

Browse files
authored
[Storage] [Webjobs] Adding MaxDequeueCount to Format() (#37965)
* Adding MaxDequeueCount to Format() * PR Comment - update XML * Undo last commit, updated BlobsOptions XML doc * PR comment
1 parent ced5079 commit a058b17

File tree

1 file changed

+10
-8
lines changed
  • sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Blobs/src/Config

1 file changed

+10
-8
lines changed

sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Blobs/src/Config/BlobsOptions.cs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,15 @@ public int MaxDegreeOfParallelism
4747
}
4848

4949
/// <summary>
50-
/// Gets or sets the number of times to try processing a message before moving it to the poison queue (where
51-
/// possible).
50+
/// Gets or sets the number of times to try processing a given blob before adding a message to a
51+
/// storage queue named `webjobs-blobtrigger-poison`.
52+
///
53+
/// If not specified, will default to 5.
54+
///
55+
/// See <see href="https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-storage-blob-trigger#poison-blobs">
56+
/// Poison Blobs
57+
/// </see>.
5258
/// </summary>
53-
/// <remarks>
54-
/// Some queues do not have corresponding poison queues, and this property does not apply to them. Specifically,
55-
/// there are no corresponding poison queues for any queue whose name already ends in "-poison" or any queue
56-
/// whose name is already too long to add a "-poison" suffix.
57-
/// </remarks>
5859
public int MaxDequeueCount
5960
{
6061
get { return _maxDequeueCount; }
@@ -76,7 +77,8 @@ string IOptionsFormatter.Format()
7677
{
7778
JObject options = new JObject
7879
{
79-
{ nameof(MaxDegreeOfParallelism), MaxDegreeOfParallelism }
80+
{ nameof(MaxDegreeOfParallelism), MaxDegreeOfParallelism },
81+
{ nameof(MaxDequeueCount), MaxDequeueCount }
8082
};
8183

8284
return options.ToString(Formatting.Indented);

0 commit comments

Comments
 (0)