-
Notifications
You must be signed in to change notification settings - Fork 262
/
EventHubConsumerGroup.xml
1480 lines (1453 loc) · 120 KB
/
EventHubConsumerGroup.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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="EventHubConsumerGroup" FullName="Microsoft.ServiceBus.Messaging.EventHubConsumerGroup">
<TypeSignature Language="C#" Value="public sealed class EventHubConsumerGroup : Microsoft.ServiceBus.Messaging.ClientEntity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit EventHubConsumerGroup extends Microsoft.ServiceBus.Messaging.ClientEntity" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class EventHubConsumerGroup
Inherits ClientEntity" />
<TypeSignature Language="F#" Value="type EventHubConsumerGroup = class
 inherit ClientEntity" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceBus.Messaging.ClientEntity</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the consumer group within an Event Hub. This class creates receivers for a specific consumer
group within an Event Hub. This can be the default consumer group or another user-created consumer group.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition. You can use the
created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns the
<see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" /> object that is tied to the given Event Hubs partition.</returns>
<remarks>If the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup" /> has checkpoint enabled,
this overload will always throw InvalidOperationException because checkpoint
enabled ConsumerGroup requires epoch to work (please use the overload that
supply epoch as input argument). If checkpoint is disabled,
then receiver will get message from the start of the event stream, as determined by the
message retention policy of the Event Hub.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="partitionId" /> is not within the expected range, as determined by the
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubDescription.PartitionCount" /> property.</exception>
<exception cref="T:System.ServiceModel.QuotaExceededException">Thrown if the number of receivers currently connected to the partition specified
by <paramref name="partitionId" /> has exceeded the maximum allowed quota set by the service.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ReceiverDisconnectedException">Thrown if there is currently a receiver connected to the
partition as specified by <paramref name="partitionId" />.</exception>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, DateTime startingDateTimeUtc, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, valuetype System.DateTime startingDateTimeUtc, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.DateTime,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, startingDateTimeUtc As DateTime, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * DateTime * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, startingDateTimeUtc, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingDateTimeUtc" Type="System.DateTime" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingDateTimeUtc">The starting UTC time for receiving messages.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time.
You can use the created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>Service only uses this <paramref name="startingDateTimeUtc" /> as an approximation when
determining next event to deliver.
Keep in mind that there can be clock skew between client time and service time, so user application
should be designed to handle duplication in event delivery.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="partitionId" /> is not within the expected range, as determined by the
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubDescription.PartitionCount" /> property.</exception>
<exception cref="T:System.ServiceModel.QuotaExceededException">Thrown if the number of receivers currently connected to the partition specified
by <paramref name="partitionId" /> has exceeded the maximum allowed quota set by the service.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ReceiverDisconnectedException">Thrown if there is currently a receiver connected to the
partition as specified by <paramref name="partitionId" />, with an <paramref name="startingDateTimeUtc" /> specified.</exception>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, and the specified epoch value. You
can use the created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>If the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup" /> has checkpoint enabled, then the
receiver will get next message from the checkpoint offset. If checkpoint is disabled,
then receiver will get message from the start of the event stream, as determined by the
message retention policy of the event hub.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="partitionId" /> is not within the expected range, as determined by the
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubDescription.PartitionCount" /> property.</exception>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, string startingOffset, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.String,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, startingOffset As String, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * string * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, startingOffset, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You
can use the created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="partitionId" /> is not within the expected range, as determined by the
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubDescription.PartitionCount" /> property.</exception>
<exception cref="T:System.ServiceModel.QuotaExceededException">Thrown if the number of receivers currently connected to the partition specified
by <paramref name="partitionId" /> has exceeded the maximum allowed quota set by the service.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ReceiverDisconnectedException">Thrown if there is currently a receiver connected to the
partition as specified by <paramref name="partitionId" />, with an <paramref name="startingOffset" /> specified.</exception>
<code>
// the following code snippet creates a receiver that receive events
// from the first partitions of the default consumer gorup.
// assume we have obtained the description which will gives us the partition ids.
EventHubDescription description;
EventHubClient client = EventHubClient.CreateFromConnectionString(connection);
var defaultGroup = client.GetDefaultConsumerGroup();
var receiver = defaultGroup.CreateReceiver(
description.PartitionIds.First(),
EventHubConsumerGroup.StartOfStream);
var eventData = receiver.Receive();
</code>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, Microsoft.ServiceBus.Messaging.EventPosition position, long? epoch = default, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, class Microsoft.ServiceBus.Messaging.EventPosition position, valuetype System.Nullable`1<int64> epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,Microsoft.ServiceBus.Messaging.EventPosition,System.Nullable{System.Int64},Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, position As EventPosition, Optional epoch As Nullable(Of Long) = Nothing, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * Microsoft.ServiceBus.Messaging.EventPosition * Nullable<int64> * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, position, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="position" Type="Microsoft.ServiceBus.Messaging.EventPosition" />
<Parameter Name="epoch" Type="System.Nullable<System.Int64>" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="position">The starting <see cref="T:Microsoft.ServiceBus.Messaging.EventPosition" /> at which to start receiving messages.</param>
<param name="epoch">The epoch value. If set, the service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, at the specified starting position. You
can use the created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, DateTime startingDateTimeUtc, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, valuetype System.DateTime startingDateTimeUtc, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.DateTime,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, startingDateTimeUtc As DateTime, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * DateTime * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, startingDateTimeUtc, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingDateTimeUtc" Type="System.DateTime" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingDateTimeUtc">The starting UTC time for receiving messages.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time.
You can use the created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>Service only uses this <paramref name="startingDateTimeUtc" /> as an approximation when
determining next event to deliver.
Keep in mind that there can be clock skew between client time and service time, so user application
should be designed to handle duplication in event delivery.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="partitionId" /> is not within the expected range, as determined by the
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubDescription.PartitionCount" /> property.</exception>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, bool offsetInclusive, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, string startingOffset, bool offsetInclusive, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.String,System.Boolean,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, startingOffset As String, offsetInclusive As Boolean, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * string * bool * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, startingOffset, offsetInclusive, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="offsetInclusive" Type="System.Boolean" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="receiverOptions">To be added.</param>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages.</param>
<param name="offsetInclusive">A Boolean value that indicates whether <paramref name="startingOffset" /> is treated as an inclusive offset, meaning that the first
<param name="receiverOptions">Options for a event hub receiver.</param>
event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You
can use the created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>To be added.</remarks>
<code>
// the following code snippet creates a receiver that receive events
// from the first partitions of the default consumer group. It uses
// a previously stored offset as starting offset and return that event
// as the first event
// assume we have obtained the description which will gives us the partition ids.
// Also assume user has retrieved the stored offset
EventHubDescription description;
string storedOffset = "2478";
EventHubClient client = EventHubClient.CreateFromConnectionString(connection);
var defaultGroup = client.GetDefaultConsumerGroup();
var receiver = defaultGroup.CreateReceiver(
description.PartitionIds.First(),
storedOffset);
// eventData will have offset == storedOffset
var eventData = receiver.Receive();
</code>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, string startingOffset, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.String,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, startingOffset As String, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * string * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, startingOffset, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages. To specify the start of the stream, see
<see cref="F:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.StartOfStream" />.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, at the specified starting offset.</summary>
<returns>Returns the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="partitionId" /> is not within the expected range, as determined by the
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubDescription.PartitionCount" /> property.</exception>
</Docs>
</Member>
<Member MemberName="CreateReceiver">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, bool offsetInclusive, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver(string partitionId, string startingOffset, bool offsetInclusive, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.String,System.Boolean,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiver (partitionId As String, startingOffset As String, offsetInclusive As Boolean, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver" />
<MemberSignature Language="F#" Value="member this.CreateReceiver : string * string * bool * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiver" Usage="eventHubConsumerGroup.CreateReceiver (partitionId, startingOffset, offsetInclusive, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventHubReceiver</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="offsetInclusive" Type="System.Boolean" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages.</param>
<param name="offsetInclusive">A Boolean value that indicates whether <paramref name="startingOffset" /> is treated as an inclusive offset, meaning that the first
event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You
can use the created receiver to receive events for one Event Hubs partition, specified by <paramref name="partitionId" />.</summary>
<returns>Returns <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of <see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>If the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup" /> has checkpoint enabled,
this overload will always throw InvalidOperationException because checkpoint
enabled ConsumerGroup requires epoch to work (please use the overload that
supply epoch as input argument). If checkpoint is disabled,
then receiver will get message from the start of the event stream, as determined by the
message retention policy of the Event Hub.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, DateTime startingDateTimeUtc, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, valuetype System.DateTime startingDateTimeUtc, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,System.DateTime,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, startingDateTimeUtc As DateTime, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * DateTime * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, startingDateTimeUtc, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingDateTimeUtc" Type="System.DateTime" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingDateTimeUtc">The starting UTC time for receiving messages.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.DateTime,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>Service only use this <paramref name="startingDateTimeUtc" /> as an approximation when
determining next event to deliver.
Keep in mind that there can be clock skew between client time and service time, so user application
should be designed to handle duplication in event delivery.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>If the <see cref="T:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup" /> has checkpoint enabled, then the
receiver will get next message from the checkpoint offset. If checkpoint is disabled,
then receiver will get message from the start of the event stream, as determined by the
message retention policy of the Event Hub.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, string startingOffset, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,System.String,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, startingOffset As String, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * string * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, startingOffset, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, Microsoft.ServiceBus.Messaging.EventPosition position, long? epoch = default, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, class Microsoft.ServiceBus.Messaging.EventPosition position, valuetype System.Nullable`1<int64> epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,Microsoft.ServiceBus.Messaging.EventPosition,System.Nullable{System.Int64},Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, position As EventPosition, Optional epoch As Nullable(Of Long) = Nothing, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * Microsoft.ServiceBus.Messaging.EventPosition * Nullable<int64> * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, position, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="position" Type="Microsoft.ServiceBus.Messaging.EventPosition" />
<Parameter Name="epoch" Type="System.Nullable<System.Int64>" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="position">The starting <see cref="T:Microsoft.ServiceBus.Messaging.EventPosition" /> at which to start receiving messages.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,Microsoft.ServiceBus.Messaging.EventPosition,System.Nullable{System.Int64},Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, DateTime startingDateTimeUtc, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, valuetype System.DateTime startingDateTimeUtc, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,System.DateTime,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, startingDateTimeUtc As DateTime, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * DateTime * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, startingDateTimeUtc, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingDateTimeUtc" Type="System.DateTime" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingDateTimeUtc">The starting UTC time for receiving messages.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.DateTime,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>Service only uses this <paramref name="startingDateTimeUtc" /> as an approximation when
determining next event to deliver.
Keep in mind that there can be clock skew between client time and service time, so user application
should be designed to handle duplication in event delivery.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, string startingOffset, bool offsetInclusive, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, bool offsetInclusive, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,System.String,System.Boolean,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, startingOffset As String, offsetInclusive As Boolean, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * string * bool * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, startingOffset, offsetInclusive, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="offsetInclusive" Type="System.Boolean" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages.</param>
<param name="offsetInclusive">A Boolean value that indicates whether <paramref name="startingOffset" /> is treated as an inclusive offset, meaning that the first
event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.String,System.Boolean,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>To be added.</remarks>
<code>
// The following code snippet creates a receiver that receive events
// from the first partitions of the default consumer group. It uses
// a previously stored offset as starting offset and return that event
// as the first event
// assume we have obtained the description which will gives us the partition ids.
// Also assume user has retrieved the stored offset
EventHubDescription description;
string storedOffset = "2478";
EventHubClient client = EventHubClient.CreateFromConnectionString(connection);
var defaultGroup = client.GetDefaultConsumerGroup();
var receiver = defaultGroup.CreateReceiver(
description.PartitionIds.First(),
storedOffset);
// eventData will have offset == storedOffset
var eventData = receiver.Receive();
</code>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, string startingOffset, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,System.String,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, startingOffset As String, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * string * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, startingOffset, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages. To specify the start of the stream, see
<see cref="F:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.StartOfStream" />.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.String,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateReceiverAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync (string partitionId, string startingOffset, bool offsetInclusive, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, bool offsetInclusive, int64 epoch, class Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiverAsync(System.String,System.String,System.Boolean,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateReceiverAsync (partitionId As String, startingOffset As String, offsetInclusive As Boolean, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As Task(Of EventHubReceiver)" />
<MemberSignature Language="F#" Value="member this.CreateReceiverAsync : string * string * bool * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver>" Usage="eventHubConsumerGroup.CreateReceiverAsync (partitionId, startingOffset, offsetInclusive, epoch, receiverOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventHubReceiver></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="partitionId" Type="System.String" />
<Parameter Name="startingOffset" Type="System.String" />
<Parameter Name="offsetInclusive" Type="System.Boolean" />
<Parameter Name="epoch" Type="System.Int64" />
<Parameter Name="receiverOptions" Type="Microsoft.ServiceBus.Messaging.ReceiverOptions" />
</Parameters>
<Docs>
<param name="partitionId">The ID of the partition.</param>
<param name="startingOffset">The starting offset at which to start receiving messages.</param>
<param name="offsetInclusive">A Boolean value that indicates whether <paramref name="startingOffset" /> is treated as an inclusive offset, meaning that the first
event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.</param>
<param name="epoch">The epoch value. The service uses this value to enforce partition/lease ownership.</param>
<param name="receiverOptions">Options for a event hub receiver.</param>
<summary>Asynchronous version of
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,System.String,System.Boolean,System.Int64,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultGroupName">
<MemberSignature Language="C#" Value="public const string DefaultGroupName;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string DefaultGroupName" />
<MemberSignature Language="DocId" Value="F:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.DefaultGroupName" />
<MemberSignature Language="VB.NET" Value="Public Const DefaultGroupName As String " />
<MemberSignature Language="F#" Value="val mutable DefaultGroupName : string" Usage="Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.DefaultGroupName" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The name of the default ConsumerGroup that is pre-created when creating EventHub.
</summary>
<remarks>To be added.</remarks>
<altmember cref="M:Microsoft.ServiceBus.Messaging.EventHubClient.GetDefaultConsumerGroup" />
</Docs>
</Member>
<Member MemberName="EnableReceiverRuntimeMetric">
<MemberSignature Language="C#" Value="public bool EnableReceiverRuntimeMetric { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableReceiverRuntimeMetric" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EnableReceiverRuntimeMetric" />
<MemberSignature Language="VB.NET" Value="Public Property EnableReceiverRuntimeMetric As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableReceiverRuntimeMetric : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EnableReceiverRuntimeMetric" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets or sets a value indicating whether the runtime metric of a receiver is enabled. </summary>
<value> true if a client wants to access <see cref="T:Microsoft.ServiceBus.Messaging.ReceiverRuntimeInfo" /> using <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />. </value>
<remarks>Its default value is derived from the value of <see cref="P:Microsoft.ServiceBus.Messaging.Amqp.AmqpTransportSettings.EnableReceiverRuntimeMetric" /></remarks>
</Docs>
</Member>
<Member MemberName="EndOfStream">
<MemberSignature Language="C#" Value="public const string EndOfStream;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string EndOfStream" />
<MemberSignature Language="DocId" Value="F:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EndOfStream" />
<MemberSignature Language="VB.NET" Value="Public Const EndOfStream As String " />
<MemberSignature Language="F#" Value="val mutable EndOfStream : string" Usage="Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EndOfStream" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The constant that denotes the end of a stream. This can be used as an offset argument in receiver creation to
start receiving from the latest event, instead of a specific point in time/offset value.
</summary>
<remarks>To be added.</remarks>
<altmember cref="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.CreateReceiver(System.String,Microsoft.ServiceBus.Messaging.ReceiverOptions)" />
<code>
// the following code snippet creates a receiver that receive events
// from the first partitions of the default consumer gorup.
// assume we have obtained the description which will gives us the partition ids.
EventHubDescription description;
EventHubClient client = EventHubClient.CreateFromConnectionString(connection);
var defaultGroup = client.GetDefaultConsumerGroup();
var receiver = defaultGroup.CreateReceiver(
description.PartitionIds.First(),
EventHubConsumerGroup.EndOfStream);
var eventData = receiver.Receive();
</code>
</Docs>
</Member>
<Member MemberName="EventHubPath">
<MemberSignature Language="C#" Value="public string EventHubPath { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EventHubPath" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EventHubPath" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventHubPath As String" />
<MemberSignature Language="F#" Value="member this.EventHubPath : string" Usage="Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EventHubPath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the event hub path.</summary>
<value>The event hub path</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EventProcessorLifeCycleManagerFaulted">
<MemberSignature Language="C#" Value="public event EventHandler<Microsoft.ServiceBus.Messaging.EventProcessorFaultedEventArgs> EventProcessorLifeCycleManagerFaulted;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.ServiceBus.Messaging.EventProcessorFaultedEventArgs> EventProcessorLifeCycleManagerFaulted" />
<MemberSignature Language="DocId" Value="E:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EventProcessorLifeCycleManagerFaulted" />
<MemberSignature Language="VB.NET" Value="Public Event EventProcessorLifeCycleManagerFaulted As EventHandler(Of EventProcessorFaultedEventArgs) " />
<MemberSignature Language="F#" Value="member this.EventProcessorLifeCycleManagerFaulted : EventHandler<Microsoft.ServiceBus.Messaging.EventProcessorFaultedEventArgs> " Usage="member this.EventProcessorLifeCycleManagerFaulted : System.EventHandler<Microsoft.ServiceBus.Messaging.EventProcessorFaultedEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.ServiceBus.Messaging.EventProcessorFaultedEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GroupName">
<MemberSignature Language="C#" Value="public string GroupName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string GroupName" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.GroupName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property GroupName As String" />
<MemberSignature Language="F#" Value="member this.GroupName : string" Usage="Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.GroupName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the consumer group.</summary>
<value>The name of the consumer group.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnAbort">
<MemberSignature Language="C#" Value="protected override void OnAbort ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnAbort() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.OnAbort" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnAbort ()" />
<MemberSignature Language="F#" Value="override this.OnAbort : unit -> unit" Usage="eventHubConsumerGroup.OnAbort " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginClose">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginClose (TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginClose(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.OnBeginClose(System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginClose (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.OnBeginClose : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="eventHubConsumerGroup.OnBeginClose (timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<param name="callback">To be added.</param>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginOpen">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginOpen (TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginOpen(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.OnBeginOpen(System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginOpen (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.OnBeginOpen : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="eventHubConsumerGroup.OnBeginOpen (timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<param name="callback">To be added.</param>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnClose">
<MemberSignature Language="C#" Value="protected override void OnClose (TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnClose(valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.OnClose(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnClose (timeout As TimeSpan)" />
<MemberSignature Language="F#" Value="override this.OnClose : TimeSpan -> unit" Usage="eventHubConsumerGroup.OnClose timeout" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndClose">
<MemberSignature Language="C#" Value="protected override void OnEndClose (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnEndClose(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.OnEndClose(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnEndClose (result As IAsyncResult)" />
<MemberSignature Language="F#" Value="override this.OnEndClose : IAsyncResult -> unit" Usage="eventHubConsumerGroup.OnEndClose result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndOpen">
<MemberSignature Language="C#" Value="protected override void OnEndOpen (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnEndOpen(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.OnEndOpen(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnEndOpen (result As IAsyncResult)" />
<MemberSignature Language="F#" Value="override this.OnEndOpen : IAsyncResult -> unit" Usage="eventHubConsumerGroup.OnEndOpen result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</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.ServiceBus.Messaging.EventHubConsumerGroup.PrefetchCount" />
<MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" />
<MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.PrefetchCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from
<see cref="T:Microsoft.ServiceBus.Messaging.EventHubClient" />. The default value is 10,000.</summary>
<value>The number of events that the receiver can cache.</value>
<remarks>Any <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" /> created from this instance will inherit this value by default.
Changes to this value will not be propagate to already created receiver, but will be used by
new <see cref="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" /> created after the change. Also setting this property to non-zero will
set <see cref="P:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.PrefetchSizeInBytes" /> to null.