-
Notifications
You must be signed in to change notification settings - Fork 255
/
ServiceBusTriggerAttribute.xml
302 lines (302 loc) · 16.7 KB
/
ServiceBusTriggerAttribute.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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<Type Name="ServiceBusTriggerAttribute" FullName="Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute">
<TypeSignature Language="C#" Value="public sealed class ServiceBusTriggerAttribute : Attribute, Microsoft.Azure.WebJobs.IConnectionProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ServiceBusTriggerAttribute extends System.Attribute implements class Microsoft.Azure.WebJobs.IConnectionProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ServiceBusTriggerAttribute
Inherits Attribute
Implements IConnectionProvider" />
<TypeSignature Language="F#" Value="type ServiceBusTriggerAttribute = class
 inherit Attribute
 interface IConnectionProvider" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>5.1.0.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.5.1.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.8.0.0</AssemblyVersion>
<AssemblyVersion>5.8.1.0</AssemblyVersion>
<AssemblyVersion>5.9.0.0</AssemblyVersion>
<AssemblyVersion>5.10.0.0</AssemblyVersion>
<AssemblyVersion>5.11.0.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
<AssemblyVersion>5.13.0.0</AssemblyVersion>
<AssemblyVersion>5.13.3.0</AssemblyVersion>
<AssemblyVersion>5.13.4.0</AssemblyVersion>
<AssemblyVersion>5.13.5.0</AssemblyVersion>
<AssemblyVersion>5.13.6.0</AssemblyVersion>
<AssemblyVersion>5.14.0.0</AssemblyVersion>
<AssemblyVersion>5.15.1.0</AssemblyVersion>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.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.ServiceBusAccountAttribute))]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Azure.WebJobs.ConnectionProvider(typeof(Microsoft.Azure.WebJobs.ServiceBusAccountAttribute))>]</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)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Parameter)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerDisplay("{DebuggerDisplay,nq}")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerDisplay("{DebuggerDisplay,nq}")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Attribute used to bind a parameter to a ServiceBus Queue message, causing the function to run when a
message is enqueued.
</summary>
<remarks>
The method parameter type can be one of the following:
<list type="bullet"><item><description><see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /></description></item><item><description><see cref="T:System.String" /></description></item><item><description><see cref="T:System.Byte" />array</description></item><item><description><see cref="T:System.BinaryData" /></description></item><item><description>A user-defined type (serialized as JSON)</description></item></list></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusTriggerAttribute (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.ServiceBusTriggerAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (queueName As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute : string -> Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute" Usage="new Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute queueName" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.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.ServiceBusTriggerAttribute" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusTriggerAttribute (string topicName, string subscriptionName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string topicName, string subscriptionName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (topicName As String, subscriptionName As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute : string * string -> Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute" Usage="new Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute (topicName, subscriptionName)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="topicName" Type="System.String" />
<Parameter Name="subscriptionName" Type="System.String" />
</Parameters>
<Docs>
<param name="topicName">The name of the topic to bind to.</param>
<param name="subscriptionName">The name of the subscription in <paramref name="topicName" /> to bind to.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutoCompleteMessages">
<MemberSignature Language="C#" Value="public bool AutoCompleteMessages { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AutoCompleteMessages" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.AutoCompleteMessages" />
<MemberSignature Language="VB.NET" Value="Public Property AutoCompleteMessages As Boolean" />
<MemberSignature Language="F#" Value="member this.AutoCompleteMessages : bool with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.AutoCompleteMessages" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether trigger should automatically complete the message after successful processing. If not explicitly set, the behavior will be based on the <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.AutoCompleteMessages" /> value.
</summary>
<value>To be added.</value>
<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.ServiceBusTriggerAttribute.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.ServiceBusTriggerAttribute.Connection" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Azure.WebJobs.IConnectionProvider.Connection</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the app setting name that contains the Service Bus connection string.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsSessionsEnabled">
<MemberSignature Language="C#" Value="public bool IsSessionsEnabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsSessionsEnabled" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.IsSessionsEnabled" />
<MemberSignature Language="VB.NET" Value="Public Property IsSessionsEnabled As Boolean" />
<MemberSignature Language="F#" Value="member this.IsSessionsEnabled : bool with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.IsSessionsEnabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether sessions are enabled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxMessageBatchSize">
<MemberSignature Language="C#" Value="public int MaxMessageBatchSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxMessageBatchSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.MaxMessageBatchSize" />
<MemberSignature Language="VB.NET" Value="Public Property MaxMessageBatchSize As Integer" />
<MemberSignature Language="F#" Value="member this.MaxMessageBatchSize : int with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.MaxMessageBatchSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum number of messages that will be passed to each function call. This only applies for functions that receive
a batch of messages.
</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.ServiceBusTriggerAttribute.QueueName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property QueueName As String" />
<MemberSignature Language="F#" Value="member this.QueueName : string" Usage="Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.QueueName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the queue to bind to.
</summary>
<value>To be added.</value>
<remarks>When binding to a subscription in a topic, returns <see langword="null" />.</remarks>
</Docs>
</Member>
<Member MemberName="SubscriptionName">
<MemberSignature Language="C#" Value="public string SubscriptionName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SubscriptionName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.SubscriptionName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SubscriptionName As String" />
<MemberSignature Language="F#" Value="member this.SubscriptionName : string" Usage="Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.SubscriptionName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the subscription in <see cref="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.TopicName" /> to bind to.
</summary>
<value>To be added.</value>
<remarks>When binding to a queue, returns <see langword="null" />.</remarks>
</Docs>
</Member>
<Member MemberName="TopicName">
<MemberSignature Language="C#" Value="public string TopicName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TopicName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.TopicName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TopicName As String" />
<MemberSignature Language="F#" Value="member this.TopicName : string" Usage="Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.TopicName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the topic to bind to.
</summary>
<value>To be added.</value>
<remarks>When binding to a queue, returns <see langword="null" />.</remarks>
</Docs>
</Member>
</Members>
</Type>