-
Notifications
You must be signed in to change notification settings - Fork 256
/
ServiceBusOptions.xml
593 lines (591 loc) · 36 KB
/
ServiceBusOptions.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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
<Type Name="ServiceBusOptions" FullName="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions">
<TypeSignature Language="C#" Value="public class ServiceBusOptions : Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusOptions extends System.Object implements class Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceBusOptions
Implements IOptionsFormatter" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="F#" Value="type ServiceBusOptions = class
 interface IOptionsFormatter" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="C#" Value="public class ServiceBusOptions" FrameworkAlternate="azure-dotnet-legacy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusOptions extends System.Object" FrameworkAlternate="azure-dotnet-legacy" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceBusOptions" FrameworkAlternate="azure-dotnet-legacy" />
<TypeSignature Language="F#" Value="type ServiceBusOptions = class" FrameworkAlternate="azure-dotnet-legacy" />
<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>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface FrameworkAlternate="azure-dotnet">
<InterfaceName>Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Configuration options for the ServiceBus extension.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Constructs a new instance.
</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.ServiceBus.ServiceBusOptions.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.ServiceBus.ServiceBusOptions.AutoCompleteMessages" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets whether to automatically complete messages after successful execution of the function.
The default value is true.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientRetryOptions">
<MemberSignature Language="C#" Value="public Azure.Messaging.ServiceBus.ServiceBusRetryOptions ClientRetryOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Messaging.ServiceBus.ServiceBusRetryOptions ClientRetryOptions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.ClientRetryOptions" />
<MemberSignature Language="VB.NET" Value="Public Property ClientRetryOptions As ServiceBusRetryOptions" />
<MemberSignature Language="F#" Value="member this.ClientRetryOptions : Azure.Messaging.ServiceBus.ServiceBusRetryOptions with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.ClientRetryOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.ServiceBus.ServiceBusRetryOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
The set of options to use for determining whether a failed operation should be retried and,
if so, the amount of time to wait between retry attempts. These options also control the
amount of time allowed for receiving messages and other interactions with the Service Bus service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConnectionString">
<MemberSignature Language="C#" Value="public string ConnectionString { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ConnectionString" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.ConnectionString" />
<MemberSignature Language="VB.NET" Value="Public Property ConnectionString As String" />
<MemberSignature Language="F#" Value="member this.ConnectionString : string with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.ConnectionString" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableCrossEntityTransactions">
<MemberSignature Language="C#" Value="public bool EnableCrossEntityTransactions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableCrossEntityTransactions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.EnableCrossEntityTransactions" />
<MemberSignature Language="VB.NET" Value="Public Property EnableCrossEntityTransactions As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableCrossEntityTransactions : bool with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.EnableCrossEntityTransactions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a flag that indicates whether or not transactions may span multiple
Service Bus entities.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JsonSerializerSettings">
<MemberSignature Language="C#" Value="public Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.JsonSerializerSettings" />
<MemberSignature Language="VB.NET" Value="Public Property JsonSerializerSettings As JsonSerializerSettings" />
<MemberSignature Language="F#" Value="member this.JsonSerializerSettings : Newtonsoft.Json.JsonSerializerSettings with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.JsonSerializerSettings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Newtonsoft.Json.JsonSerializerSettings</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the JSON serialization settings to use when binding to POCOs.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxAutoLockRenewalDuration">
<MemberSignature Language="C#" Value="public TimeSpan MaxAutoLockRenewalDuration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxAutoLockRenewalDuration" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxAutoLockRenewalDuration" />
<MemberSignature Language="VB.NET" Value="Public Property MaxAutoLockRenewalDuration As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaxAutoLockRenewalDuration : TimeSpan with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxAutoLockRenewalDuration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum duration within which the lock will be renewed automatically. This
value should be greater than the longest message lock duration; for example, the LockDuration Property.
The default value is 5 minutes. This does not apply for functions that receive a batch of messages.
To specify an infinite duration, use <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> or <value>-00:00:00.0010000</value>
if specifying via host.json.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxBatchWaitTime">
<MemberSignature Language="C#" Value="public TimeSpan MaxBatchWaitTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxBatchWaitTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxBatchWaitTime" />
<MemberSignature Language="VB.NET" Value="Public Property MaxBatchWaitTime As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaxBatchWaitTime : TimeSpan with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxBatchWaitTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum time that the trigger should wait to fill a batch before invoking the function.
This is only considered when <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MinMessageBatchSize" /> is set to larger than 1 and is otherwise unused.
If less than <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MinMessageBatchSize" /> messages were available before the wait time elapses, the function
will be invoked with a partial batch. This value should be no longer then 50% of the entity message lock duration.
Therefore, the maximum allowed value is 2 minutes and 30 seconds.
Otherwise, you may get lock exceptions when messages are pulled from the cache.
The default value is 30 seconds.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxConcurrentCalls">
<MemberSignature Language="C#" Value="public int MaxConcurrentCalls { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxConcurrentCalls" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxConcurrentCalls" />
<MemberSignature Language="VB.NET" Value="Public Property MaxConcurrentCalls As Integer" />
<MemberSignature Language="F#" Value="member this.MaxConcurrentCalls : int with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxConcurrentCalls" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum number of messages that can be processed concurrently by a function.
This setting does not apply for functions that receive a batch of messages. The default is 16 times
the return value of <see cref="M:Microsoft.Azure.WebJobs.ServiceBus.Utility.GetProcessorCount" />. When <see cref="P:Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled" />
is true, this value will be ignored, and concurrency will be increased/decreased dynamically.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxConcurrentCallsPerSession">
<MemberSignature Language="C#" Value="public int MaxConcurrentCallsPerSession { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxConcurrentCallsPerSession" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxConcurrentCallsPerSession" />
<MemberSignature Language="VB.NET" Value="Public Property MaxConcurrentCallsPerSession As Integer" />
<MemberSignature Language="F#" Value="member this.MaxConcurrentCallsPerSession : int with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxConcurrentCallsPerSession" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum number of concurrent calls to the function per session.
Thus the total number of concurrent calls will be equal to MaxConcurrentSessions * MaxConcurrentCallsPerSession.
The default value is 1. This applies only to functions that set <see cref="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.IsSessionsEnabled" />
to <c>true</c>. This does not apply for functions that receive a batch of messages.
When <see cref="P:Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled" /> is true, this value will be ignored,
and concurrency will be increased/decreased dynamically.
</summary>
<value>The maximum number of concurrent calls to the message handler for each session that is being processed.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
A value that is not positive is attempted to be set for the property.
</exception>
</Docs>
</Member>
<Member MemberName="MaxConcurrentSessions">
<MemberSignature Language="C#" Value="public int MaxConcurrentSessions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxConcurrentSessions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxConcurrentSessions" />
<MemberSignature Language="VB.NET" Value="Public Property MaxConcurrentSessions As Integer" />
<MemberSignature Language="F#" Value="member this.MaxConcurrentSessions : int with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxConcurrentSessions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum number of sessions that can be processed concurrently by a function.
The default value is 8. This applies only to functions that set <see cref="P:Microsoft.Azure.WebJobs.ServiceBusTriggerAttribute.IsSessionsEnabled" />
to <c>true</c>. This does not apply for functions that receive a batch of messages.
When <see cref="P:Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled" /> is true, this value will be ignored,
and concurrency will be increased/decreased dynamically.
</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.ServiceBus.ServiceBusOptions.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.ServiceBus.ServiceBusOptions.MaxMessageBatchSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.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. The default value is 1000.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageHandlerOptions">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ServiceBus.MessageHandlerOptions MessageHandlerOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.ServiceBus.MessageHandlerOptions MessageHandlerOptions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MessageHandlerOptions" />
<MemberSignature Language="VB.NET" Value="Public Property MessageHandlerOptions As MessageHandlerOptions" />
<MemberSignature Language="F#" Value="member this.MessageHandlerOptions : Microsoft.Azure.ServiceBus.MessageHandlerOptions with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MessageHandlerOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ServiceBus.MessageHandlerOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter.Format">
<MemberSignature Language="C#" Value="string IOptionsFormatter.Format ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance string Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter.Format() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.Microsoft#Azure#WebJobs#Hosting#IOptionsFormatter#Format" />
<MemberSignature Language="VB.NET" Value="Function Format () As String Implements IOptionsFormatter.Format" />
<MemberSignature Language="F#" Value="abstract member Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter.Format : unit -> string
override this.Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter.Format : unit -> string" Usage="serviceBusOptions.Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter.Format " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter.Format</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Formats the options as JSON objects for display.
</summary>
<returns>Options formatted as JSON.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinMessageBatchSize">
<MemberSignature Language="C#" Value="public int MinMessageBatchSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MinMessageBatchSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MinMessageBatchSize" />
<MemberSignature Language="VB.NET" Value="Public Property MinMessageBatchSize As Integer" />
<MemberSignature Language="F#" Value="member this.MinMessageBatchSize : int with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MinMessageBatchSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the minimum number of messages desired for a batch. This setting applies only to functions that
receive multiple messages. This value must be less than <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxMessageBatchSize" /> and is used in
conjunction with <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxBatchWaitTime" />. If <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxBatchWaitTime" /> passes and less than
<see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MinMessageBatchSize" /> has been received, the function will be invoked with a partial batch.
Default 1.
</summary>
<value>To be added.</value>
<remarks>
The minimum size is not a strict guarantee, as a partial batch will be dispatched if a full batch cannot be
prepared before the <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxBatchWaitTime" /> has elapsed.
</remarks>
</Docs>
</Member>
<Member MemberName="PrefetchCount">
<MemberSignature Language="C#" Value="public int PrefetchCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PrefetchCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.PrefetchCount" />
<MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" />
<MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.PrefetchCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the PrefetchCount that will be used when receiving messages. The default value is 0.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProcessErrorAsync">
<MemberSignature Language="C#" Value="public Func<Azure.Messaging.ServiceBus.ProcessErrorEventArgs,System.Threading.Tasks.Task> ProcessErrorAsync { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class Azure.Messaging.ServiceBus.ProcessErrorEventArgs, class System.Threading.Tasks.Task> ProcessErrorAsync" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.ProcessErrorAsync" />
<MemberSignature Language="VB.NET" Value="Public Property ProcessErrorAsync As Func(Of ProcessErrorEventArgs, Task)" />
<MemberSignature Language="F#" Value="member this.ProcessErrorAsync : Func<Azure.Messaging.ServiceBus.ProcessErrorEventArgs, System.Threading.Tasks.Task> with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.ProcessErrorAsync" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Azure.Messaging.ServiceBus.ProcessErrorEventArgs,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets an optional error handler that will be invoked if an exception occurs while attempting to process
a message. This does not apply for functions that receive a batch of messages.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SessionClosingAsync">
<MemberSignature Language="C#" Value="public Func<Azure.Messaging.ServiceBus.ProcessSessionEventArgs,System.Threading.Tasks.Task> SessionClosingAsync { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class Azure.Messaging.ServiceBus.ProcessSessionEventArgs, class System.Threading.Tasks.Task> SessionClosingAsync" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.SessionClosingAsync" />
<MemberSignature Language="VB.NET" Value="Public Property SessionClosingAsync As Func(Of ProcessSessionEventArgs, Task)" />
<MemberSignature Language="F#" Value="member this.SessionClosingAsync : Func<Azure.Messaging.ServiceBus.ProcessSessionEventArgs, System.Threading.Tasks.Task> with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.SessionClosingAsync" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Azure.Messaging.ServiceBus.ProcessSessionEventArgs,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
Optional handler that can be set to be notified when a session is about to be closed for processing.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SessionIdleTimeout">
<MemberSignature Language="C#" Value="public TimeSpan? SessionIdleTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> SessionIdleTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.SessionIdleTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property SessionIdleTimeout As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.SessionIdleTimeout : Nullable<TimeSpan> with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.SessionIdleTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum amount of time to wait for a message to be received for the
currently active session. After this time has elapsed, the processor will close the session
and attempt to process another session.
If not specified, the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.TryTimeout" /> will be used.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SessionInitializingAsync">
<MemberSignature Language="C#" Value="public Func<Azure.Messaging.ServiceBus.ProcessSessionEventArgs,System.Threading.Tasks.Task> SessionInitializingAsync { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class Azure.Messaging.ServiceBus.ProcessSessionEventArgs, class System.Threading.Tasks.Task> SessionInitializingAsync" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.SessionInitializingAsync" />
<MemberSignature Language="VB.NET" Value="Public Property SessionInitializingAsync As Func(Of ProcessSessionEventArgs, Task)" />
<MemberSignature Language="F#" Value="member this.SessionInitializingAsync : Func<Azure.Messaging.ServiceBus.ProcessSessionEventArgs, System.Threading.Tasks.Task> with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.SessionInitializingAsync" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<Azure.Messaging.ServiceBus.ProcessSessionEventArgs,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
Optional handler that can be set to be notified when a new session is about to be processed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TransportType">
<MemberSignature Language="C#" Value="public Azure.Messaging.ServiceBus.ServiceBusTransportType TransportType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Messaging.ServiceBus.ServiceBusTransportType TransportType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.TransportType" />
<MemberSignature Language="VB.NET" Value="Public Property TransportType As ServiceBusTransportType" />
<MemberSignature Language="F#" Value="member this.TransportType : Azure.Messaging.ServiceBus.ServiceBusTransportType with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.TransportType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.ServiceBus.ServiceBusTransportType</ReturnType>
</ReturnValue>
<Docs>
<summary>
The type of protocol and transport that will be used for communicating with the Service Bus
service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WebProxy">
<MemberSignature Language="C#" Value="public System.Net.IWebProxy WebProxy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IWebProxy WebProxy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.WebProxy" />
<MemberSignature Language="VB.NET" Value="Public Property WebProxy As IWebProxy" />
<MemberSignature Language="F#" Value="member this.WebProxy : System.Net.IWebProxy with get, set" Usage="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.WebProxy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.IWebProxy</ReturnType>
</ReturnValue>
<Docs>
<summary>
The proxy to use for communication over web sockets.
</summary>
<value>To be added.</value>
<remarks>
A proxy cannot be used for communication over TCP; if web sockets are not in
use, specifying a proxy is an invalid option.
</remarks>
</Docs>
</Member>
</Members>
</Type>