Skip to content

Commit

Permalink
Base64 encoding remarks. (Azure#18345)
Browse files Browse the repository at this point in the history
  • Loading branch information
kasobol-msft authored and jongio committed Feb 9, 2021
1 parent 743fd36 commit ae40ea4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
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
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

0 comments on commit ae40ea4

Please sign in to comment.