Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Storage] Base64 encoding remarks in Webjobs docs. #18345

Merged
merged 1 commit into from
Feb 2, 2021
Merged

[Storage] Base64 encoding remarks in Webjobs docs. #18345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Queues/src/QueueAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using Azure.Storage.Queues;
using Azure.Storage.Queues.Models;
using Microsoft.Azure.WebJobs.Description;
using Microsoft.Azure.WebJobs.Host;

namespace Microsoft.Azure.WebJobs
{
Expand All @@ -25,6 +26,17 @@ namespace Microsoft.Azure.WebJobs
/// <item><description><see cref="ICollector{T}"/> of these types (to enqueue multiple messages via <see cref="ICollector{T}.Add"/></description></item>
/// <item><description><see cref="IAsyncCollector{T}"/> of these types (to enqueue multiple messages via <see cref="IAsyncCollector{T}.AddAsync(T, System.Threading.CancellationToken)"/></description></item>
/// </list>
///
/// By default the extension Base64-encodes outgoing messages.
/// This behavior can be changed by setting <see cref="QueuesOptions.MessageEncoding"/>.
/// For example, to configure Azure Functions to perform no base64 encoding/decoding, specify the following in host.json.
/// <code>
/// "extensions": {
/// "queues": {
/// "messageEncoding": "none"
/// }
/// }
/// </code>
/// </remarks>
#pragma warning restore CA1200 // Avoid using cref tags with a prefix
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1813:AvoidUnsealedAttributes")]
Expand Down
12 changes: 12 additions & 0 deletions sdk/storage/Microsoft.Azure.WebJobs.Extensions.Storage.Queues/src/QueueTriggerAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using System.Diagnostics;
using Azure.Storage.Queues.Models;
using Microsoft.Azure.WebJobs.Description;
using Microsoft.Azure.WebJobs.Host;

namespace Microsoft.Azure.WebJobs
{
Expand All @@ -22,6 +23,17 @@ namespace Microsoft.Azure.WebJobs
/// <item><description><see cref="BinaryData"/></description></item>
/// <item><description>A user-defined type (serialized as JSON)</description></item>
/// </list>
///
/// By default messages received from the queue are expected to be Base64-encoded and are decoded before calling the function.
/// This behavior can be changed by setting <see cref="QueuesOptions.MessageEncoding"/>.
/// For example, to configure Azure Functions to perform no base64 encoding/decoding, specify the following in host.json.
/// <code>
/// "extensions": {
/// "queues": {
/// "messageEncoding": "none"
/// }
/// }
/// </code>
/// </remarks>
[AttributeUsage(AttributeTargets.Parameter)]
#pragma warning restore CA1200 // Avoid using cref tags with a prefix
Expand Down