/
QueueAttribute.xml
155 lines (154 loc) · 8.9 KB
/
QueueAttribute.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<Type Name="QueueAttribute" FullName="Microsoft.Azure.WebJobs.QueueAttribute">
<TypeSignature Language="C#" Value="public class QueueAttribute : Attribute, Microsoft.Azure.WebJobs.IConnectionProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit QueueAttribute extends System.Attribute implements class Microsoft.Azure.WebJobs.IConnectionProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.QueueAttribute" />
<TypeSignature Language="VB.NET" Value="Public Class QueueAttribute
Inherits Attribute
Implements IConnectionProvider" />
<TypeSignature Language="F#" Value="type QueueAttribute = class
 inherit Attribute
 interface IConnectionProvider" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage.Queues</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.1.0</AssemblyVersion>
<AssemblyVersion>5.1.0.0</AssemblyVersion>
<AssemblyVersion>5.1.1.0</AssemblyVersion>
<AssemblyVersion>5.1.2.0</AssemblyVersion>
<AssemblyVersion>5.1.3.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
<AssemblyVersion>5.2.1.0</AssemblyVersion>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage</AssemblyName>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.WebJobs.IConnectionProvider</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Microsoft.Azure.WebJobs.ConnectionProvider(typeof(Microsoft.Azure.WebJobs.StorageAccountAttribute))]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Azure.WebJobs.ConnectionProvider(typeof(Microsoft.Azure.WebJobs.StorageAccountAttribute))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Microsoft.Azure.WebJobs.Description.Binding]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Azure.WebJobs.Description.Binding>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerDisplay("{QueueName,nq}")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerDisplay("{QueueName,nq}")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Attribute used to bind a parameter to an Azure Queue.
</summary>
<remarks>
The method parameter type can be one of the following:
<list type="bullet"><item><description><see cref="T:Azure.Storage.Queues.QueueClient" /></description></item><item><description><see cref="T:Azure.Storage.Queues.Models.QueueMessage" /> (out parameter)</description></item><item><description><see cref="T:System.String" /> (out parameter)</description></item><item><description><see cref="T:byte[]" /> (out parameter)</description></item><item><description><see cref="T:System.BinaryData" /> (out parameter)</description></item><item><description>A user-defined type (out parameter, serialized as JSON)</description></item><item><description><see cref="T:Microsoft.Azure.WebJobs.ICollector`1" /> of these types (to enqueue multiple messages via <see cref="M:Microsoft.Azure.WebJobs.ICollector`1.Add(`0)" /></description></item><item><description><see cref="T:Microsoft.Azure.WebJobs.IAsyncCollector`1" /> of these types (to enqueue multiple messages via <see cref="M:Microsoft.Azure.WebJobs.IAsyncCollector`1.AddAsync(`0,System.Threading.CancellationToken)" /></description></item></list>
By default the extension Base64-encodes outgoing messages.
This behavior can be changed by setting <see cref="P:Microsoft.Azure.WebJobs.Host.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>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public QueueAttribute (string queueName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string queueName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.QueueAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (queueName As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.WebJobs.QueueAttribute : string -> Microsoft.Azure.WebJobs.QueueAttribute" Usage="new Microsoft.Azure.WebJobs.QueueAttribute queueName" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage.Queues</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage</AssemblyName>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="queueName" Type="System.String" />
</Parameters>
<Docs>
<param name="queueName">The name of the queue to which to bind.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Azure.WebJobs.QueueAttribute" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Connection">
<MemberSignature Language="C#" Value="public string Connection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Connection" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.QueueAttribute.Connection" />
<MemberSignature Language="VB.NET" Value="Public Property Connection As String" />
<MemberSignature Language="F#" Value="member this.Connection : string with get, set" Usage="Microsoft.Azure.WebJobs.QueueAttribute.Connection" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Azure.WebJobs.IConnectionProvider.Connection</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage.Queues</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage</AssemblyName>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the app setting name that contains the Azure Storage connection string.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueueName">
<MemberSignature Language="C#" Value="public string QueueName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string QueueName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.QueueAttribute.QueueName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property QueueName As String" />
<MemberSignature Language="F#" Value="member this.QueueName : string" Usage="Microsoft.Azure.WebJobs.QueueAttribute.QueueName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage.Queues</AssemblyName>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.Storage</AssemblyName>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Microsoft.Azure.WebJobs.Description.AutoResolve]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Azure.WebJobs.Description.AutoResolve>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the queue to which to bind.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>