xml/Azure.Messaging.EventHubs.Primitives/PartitionReceiver.xml

<Type Name="PartitionReceiver" FullName="Azure.Messaging.EventHubs.Primitives.PartitionReceiver"> <TypeSignature Language="C#" Value="public class PartitionReceiver : IAsyncDisposable" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PartitionReceiver extends System.Object implements class System.IAsyncDisposable" /> <TypeSignature Language="DocId" Value="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> <TypeSignature Language="VB.NET" Value="Public Class PartitionReceiver
Implements IAsyncDisposable" /> <TypeSignature Language="F#" Value="type PartitionReceiver = class
 interface IAsyncDisposable" /> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.4.0.0</AssemblyVersion> <AssemblyVersion>5.4.1.0</AssemblyVersion> <AssemblyVersion>5.5.0.0</AssemblyVersion> <AssemblyVersion>5.6.0.0</AssemblyVersion> <AssemblyVersion>5.6.1.0</AssemblyVersion> <AssemblyVersion>5.6.2.0</AssemblyVersion> <AssemblyVersion>5.7.0.0</AssemblyVersion> <AssemblyVersion>5.7.1.0</AssemblyVersion> <AssemblyVersion>5.7.2.0</AssemblyVersion> <AssemblyVersion>5.7.3.0</AssemblyVersion> <AssemblyVersion>5.7.4.0</AssemblyVersion> <AssemblyVersion>5.7.5.0</AssemblyVersion> <AssemblyVersion>5.8.0.0</AssemblyVersion> <AssemblyVersion>5.8.1.0</AssemblyVersion> <AssemblyVersion>5.9.0.0</AssemblyVersion> <AssemblyVersion>5.9.1.0</AssemblyVersion> <AssemblyVersion>5.9.2.0</AssemblyVersion> <AssemblyVersion>5.9.3.0</AssemblyVersion> <AssemblyVersion>5.10.0.0</AssemblyVersion> <AssemblyVersion>5.11.0.0</AssemblyVersion> <AssemblyVersion>5.11.1.0</AssemblyVersion> <AssemblyVersion>5.11.2.0</AssemblyVersion> <AssemblyVersion>5.11.3.0</AssemblyVersion> <AssemblyVersion>5.11.4.0</AssemblyVersion> <AssemblyVersion>5.11.5.0</AssemblyVersion> <AssemblyVersion>5.11.6.0</AssemblyVersion> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>System.IAsyncDisposable</InterfaceName> </Interface> </Interfaces> <Docs> <summary> Allows reading events from a specific partition of an Event Hub, and in the context of a specific consumer group, to be read with a greater level of control over communication with the Event Hubs service than is offered by other event consumers. </summary> <remarks> <para>It is recommended that the <c>EventProcessorClient</c> or <see cref="T:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient" /> be used for reading and processing events for the majority of scenarios. The partition receiver is intended to enable scenarios with special needs which require more direct control.</para> <para>The <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> is safe to cache and use for the lifetime of an application, and which is the best practice when the application reads events regularly or semi-regularly. The receiver is responsible for ensuring efficient network, CPU, and memory use. Calling either <see cref="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.CloseAsync(System.Threading.CancellationToken)" /> or <see cref="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.DisposeAsync" /> as the application is shutting down will ensure that network resources and other unmanaged objects are properly cleaned up.</para> </remarks> <altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,Azure.Messaging.EventHubs.Consumer.ReadEventOptions,System.Threading.CancellationToken)" /> <altmember cref="M:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClient.ReadEventsFromPartitionAsync(System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.Threading.CancellationToken)" /> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected PartitionReceiver ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public PartitionReceiver (string consumerGroup, string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, Azure.Messaging.EventHubs.EventHubConnection connection, Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string consumerGroup, string partitionId, valuetype Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, class Azure.Messaging.EventHubs.EventHubConnection connection, class Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.#ctor(System.String,System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,Azure.Messaging.EventHubs.EventHubConnection,Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (consumerGroup As String, partitionId As String, eventPosition As EventPosition, connection As EventHubConnection, Optional options As PartitionReceiverOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver : string * string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.EventHubConnection * Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions -> Azure.Messaging.EventHubs.Primitives.PartitionReceiver" Usage="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver (consumerGroup, partitionId, eventPosition, connection, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="consumerGroup" Type="System.String" /> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="eventPosition" Type="Azure.Messaging.EventHubs.Consumer.EventPosition" /> <Parameter Name="connection" Type="Azure.Messaging.EventHubs.EventHubConnection" /> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions" /> </Parameters> <Docs> <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param> <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param> <param name="eventPosition">The position within the partition where the client should begin reading events.</param> <param name="connection">The <see cref="T:Azure.Messaging.EventHubs.EventHubConnection" /> connection to use for communication with the Event Hubs service.</param> <param name="options">A set of options to apply when configuring the client.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public PartitionReceiver (string consumerGroup, string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string connectionString, Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string consumerGroup, string partitionId, valuetype Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string connectionString, class Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.#ctor(System.String,System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.String,Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (consumerGroup As String, partitionId As String, eventPosition As EventPosition, connectionString As String, Optional options As PartitionReceiverOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver : string * string * Azure.Messaging.EventHubs.Consumer.EventPosition * string * Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions -> Azure.Messaging.EventHubs.Primitives.PartitionReceiver" Usage="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver (consumerGroup, partitionId, eventPosition, connectionString, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="consumerGroup" Type="System.String" /> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="eventPosition" Type="Azure.Messaging.EventHubs.Consumer.EventPosition" /> <Parameter Name="connectionString" Type="System.String" /> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions" /> </Parameters> <Docs> <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param> <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param> <param name="eventPosition">The position within the partition where the client should begin reading events.</param> <param name="connectionString">The connection string to use for connecting to the Event Hubs namespace; it is expected that the Event Hub name and the shared key properties are contained in this connection string.</param> <param name="options">A set of options to apply when configuring the client.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> class. </summary> <remarks> If the connection string is copied from the Event Hubs namespace, it will likely not contain the name of the desired Event Hub, which is needed. In this case, the name can be added manually by adding ";EntityPath=[[ EVENT HUB NAME ]]" to the end of the connection string. For example, ";EntityPath=telemetry-hub". If you have defined a shared access policy directly on the Event Hub itself, then copying the connection string from that Event Hub will result in a connection string that contains the name. </remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public PartitionReceiver (string consumerGroup, string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string connectionString, string eventHubName, Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string consumerGroup, string partitionId, valuetype Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string connectionString, string eventHubName, class Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.#ctor(System.String,System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.String,System.String,Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (consumerGroup As String, partitionId As String, eventPosition As EventPosition, connectionString As String, eventHubName As String, Optional options As PartitionReceiverOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver : string * string * Azure.Messaging.EventHubs.Consumer.EventPosition * string * string * Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions -> Azure.Messaging.EventHubs.Primitives.PartitionReceiver" Usage="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver (consumerGroup, partitionId, eventPosition, connectionString, eventHubName, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="consumerGroup" Type="System.String" /> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="eventPosition" Type="Azure.Messaging.EventHubs.Consumer.EventPosition" /> <Parameter Name="connectionString" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions" /> </Parameters> <Docs> <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param> <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param> <param name="eventPosition">The position within the partition where the client should begin reading events.</param> <param name="connectionString">The connection string to use for connecting to the Event Hubs namespace; it is expected that the shared key properties are contained in this connection string, but not the Event Hub name.</param> <param name="eventHubName">The name of the specific Event Hub to associate the client with.</param> <param name="options">A set of options to apply when configuring the client.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> class. </summary> <remarks> If the connection string is copied from the Event Hub itself, it will contain the name of the desired Event Hub, and can be used directly without passing the <paramref name="eventHubName" />. The name of the Event Hub should be passed only once, either as part of the connection string or separately. </remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public PartitionReceiver (string consumerGroup, string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string fullyQualifiedNamespace, string eventHubName, Azure.AzureNamedKeyCredential credential, Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string consumerGroup, string partitionId, valuetype Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string fullyQualifiedNamespace, string eventHubName, class Azure.AzureNamedKeyCredential credential, class Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.#ctor(System.String,System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.String,System.String,Azure.AzureNamedKeyCredential,Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (consumerGroup As String, partitionId As String, eventPosition As EventPosition, fullyQualifiedNamespace As String, eventHubName As String, credential As AzureNamedKeyCredential, Optional options As PartitionReceiverOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver : string * string * Azure.Messaging.EventHubs.Consumer.EventPosition * string * string * Azure.AzureNamedKeyCredential * Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions -> Azure.Messaging.EventHubs.Primitives.PartitionReceiver" Usage="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver (consumerGroup, partitionId, eventPosition, fullyQualifiedNamespace, eventHubName, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="consumerGroup" Type="System.String" /> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="eventPosition" Type="Azure.Messaging.EventHubs.Consumer.EventPosition" /> <Parameter Name="fullyQualifiedNamespace" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="credential" Type="Azure.AzureNamedKeyCredential" /> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions" /> </Parameters> <Docs> <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param> <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param> <param name="eventPosition">The position within the partition where the client should begin reading events.</param> <param name="fullyQualifiedNamespace">The fully qualified Event Hubs namespace to connect to. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param> <param name="eventHubName">The name of the specific Event Hub to associate the client with.</param> <param name="credential">The shared key credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.</param> <param name="options">A set of options to apply when configuring the client.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public PartitionReceiver (string consumerGroup, string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string fullyQualifiedNamespace, string eventHubName, Azure.AzureSasCredential credential, Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string consumerGroup, string partitionId, valuetype Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string fullyQualifiedNamespace, string eventHubName, class Azure.AzureSasCredential credential, class Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.#ctor(System.String,System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.String,System.String,Azure.AzureSasCredential,Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (consumerGroup As String, partitionId As String, eventPosition As EventPosition, fullyQualifiedNamespace As String, eventHubName As String, credential As AzureSasCredential, Optional options As PartitionReceiverOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver : string * string * Azure.Messaging.EventHubs.Consumer.EventPosition * string * string * Azure.AzureSasCredential * Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions -> Azure.Messaging.EventHubs.Primitives.PartitionReceiver" Usage="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver (consumerGroup, partitionId, eventPosition, fullyQualifiedNamespace, eventHubName, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="consumerGroup" Type="System.String" /> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="eventPosition" Type="Azure.Messaging.EventHubs.Consumer.EventPosition" /> <Parameter Name="fullyQualifiedNamespace" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="credential" Type="Azure.AzureSasCredential" /> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions" /> </Parameters> <Docs> <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param> <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param> <param name="eventPosition">The position within the partition where the client should begin reading events.</param> <param name="fullyQualifiedNamespace">The fully qualified Event Hubs namespace to connect to. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param> <param name="eventHubName">The name of the specific Event Hub to associate the client with.</param> <param name="credential">The shared signature credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.</param> <param name="options">A set of options to apply when configuring the client.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public PartitionReceiver (string consumerGroup, string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string fullyQualifiedNamespace, string eventHubName, Azure.Core.TokenCredential credential, Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string consumerGroup, string partitionId, valuetype Azure.Messaging.EventHubs.Consumer.EventPosition eventPosition, string fullyQualifiedNamespace, string eventHubName, class Azure.Core.TokenCredential credential, class Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.#ctor(System.String,System.String,Azure.Messaging.EventHubs.Consumer.EventPosition,System.String,System.String,Azure.Core.TokenCredential,Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (consumerGroup As String, partitionId As String, eventPosition As EventPosition, fullyQualifiedNamespace As String, eventHubName As String, credential As TokenCredential, Optional options As PartitionReceiverOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver : string * string * Azure.Messaging.EventHubs.Consumer.EventPosition * string * string * Azure.Core.TokenCredential * Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions -> Azure.Messaging.EventHubs.Primitives.PartitionReceiver" Usage="new Azure.Messaging.EventHubs.Primitives.PartitionReceiver (consumerGroup, partitionId, eventPosition, fullyQualifiedNamespace, eventHubName, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="consumerGroup" Type="System.String" /> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="eventPosition" Type="Azure.Messaging.EventHubs.Consumer.EventPosition" /> <Parameter Name="fullyQualifiedNamespace" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions" /> </Parameters> <Docs> <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param> <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param> <param name="eventPosition">The position within the partition where the client should begin reading events.</param> <param name="fullyQualifiedNamespace">The fully qualified Event Hubs namespace to connect to. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param> <param name="eventHubName">The name of the specific Event Hub to associate the client with.</param> <param name="credential">The Azure managed identity credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.</param> <param name="options">A set of options to apply when configuring the client.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CloseAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task CloseAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CloseAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.CloseAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CloseAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="partitionReceiver.CloseAsync cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task</ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Closes the client. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ConsumerGroup"> <MemberSignature Language="C#" Value="public string ConsumerGroup { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string ConsumerGroup" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.ConsumerGroup" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ConsumerGroup As String" /> <MemberSignature Language="F#" Value="member this.ConsumerGroup : string" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiver.ConsumerGroup" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The name of the consumer group that this client is associated with. Events will be read only in the context of this group. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="DisposeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.ValueTask DisposeAsync ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask DisposeAsync() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.DisposeAsync" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DisposeAsync () As ValueTask" /> <MemberSignature Language="F#" Value="abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask" Usage="partitionReceiver.DisposeAsync " /> <MemberType>Method</MemberType> <Implements> <InterfaceMember>M:System.IAsyncDisposable.DisposeAsync</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.ValueTask</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Performs the task needed to clean up resources used by the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" />, including ensuring that the client itself has been closed. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Equals"> <MemberSignature Language="C#" Value="public override bool Equals (object obj);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.Equals(System.Object)" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" /> <MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="partitionReceiver.Equals obj" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> <summary> Determines whether the specified <see cref="T:System.Object" /> is equal to this instance. </summary> <returns> <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="EventHubName"> <MemberSignature Language="C#" Value="public string EventHubName { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string EventHubName" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.EventHubName" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventHubName As String" /> <MemberSignature Language="F#" Value="member this.EventHubName : string" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiver.EventHubName" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The name of the Event Hub that the client is connected to, specific to the Event Hubs namespace that contains it. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="FullyQualifiedNamespace"> <MemberSignature Language="C#" Value="public string FullyQualifiedNamespace { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string FullyQualifiedNamespace" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.FullyQualifiedNamespace" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property FullyQualifiedNamespace As String" /> <MemberSignature Language="F#" Value="member this.FullyQualifiedNamespace : string" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiver.FullyQualifiedNamespace" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The fully qualified Event Hubs namespace that the client is associated with. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetHashCode"> <MemberSignature Language="C#" Value="public override int GetHashCode ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.GetHashCode" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" /> <MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="partitionReceiver.GetHashCode " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Returns a hash code for this instance. </summary> <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetPartitionPropertiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Messaging.EventHubs.PartitionProperties> GetPartitionPropertiesAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Messaging.EventHubs.PartitionProperties> GetPartitionPropertiesAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.GetPartitionPropertiesAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetPartitionPropertiesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of PartitionProperties)" /> <MemberSignature Language="F#" Value="abstract member GetPartitionPropertiesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.EventHubs.PartitionProperties>
override this.GetPartitionPropertiesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.EventHubs.PartitionProperties>" Usage="partitionReceiver.GetPartitionPropertiesAsync cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Messaging.EventHubs.PartitionProperties></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Retrieves information about the partition this client is associated to, including elements that describe the available events in the partition event stream. </summary> <returns>The set of information for the associated partition under the Event Hub this client is associated with.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Identifier"> <MemberSignature Language="C#" Value="public string Identifier { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string Identifier" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.Identifier" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Identifier As String" /> <MemberSignature Language="F#" Value="member this.Identifier : string" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiver.Identifier" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> A unique name used to identify this receiver. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="InitialPosition"> <MemberSignature Language="C#" Value="public Azure.Messaging.EventHubs.Consumer.EventPosition InitialPosition { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Messaging.EventHubs.Consumer.EventPosition InitialPosition" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.InitialPosition" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property InitialPosition As EventPosition" /> <MemberSignature Language="F#" Value="member this.InitialPosition : Azure.Messaging.EventHubs.Consumer.EventPosition" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiver.InitialPosition" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Messaging.EventHubs.Consumer.EventPosition</ReturnType> </ReturnValue> <Docs> <summary> The position within the partition where the client begins reading events. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="IsClosed"> <MemberSignature Language="C#" Value="public bool IsClosed { get; protected set; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool IsClosed" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.IsClosed" /> <MemberSignature Language="VB.NET" Value="Public Property IsClosed As Boolean" /> <MemberSignature Language="F#" Value="member this.IsClosed : bool with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiver.IsClosed" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Docs> <summary> Indicates whether or not this <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> has been closed. </summary> <value> <c>true</c> if the client is closed; otherwise, <c>false</c>. </value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="PartitionId"> <MemberSignature Language="C#" Value="public string PartitionId { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance string PartitionId" /> <MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.PartitionId" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property PartitionId As String" /> <MemberSignature Language="F#" Value="member this.PartitionId : string" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiver.PartitionId" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Docs> <summary> The identifier of the Event Hub partition that this client is associated with. Events will be read only from this partition. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ReadLastEnqueuedEventProperties"> <MemberSignature Language="C#" Value="public virtual Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties ReadLastEnqueuedEventProperties ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties ReadLastEnqueuedEventProperties() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.ReadLastEnqueuedEventProperties" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReadLastEnqueuedEventProperties () As LastEnqueuedEventProperties" /> <MemberSignature Language="F#" Value="abstract member ReadLastEnqueuedEventProperties : unit -> Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties
override this.ReadLastEnqueuedEventProperties : unit -> Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties" Usage="partitionReceiver.ReadLastEnqueuedEventProperties " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> A set of information about the last enqueued event of the partition associated with this receiver, observed as events are received from the Event Hubs service. This is only available if the receiver was created with <see cref="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.TrackLastEnqueuedEventProperties" /> set. Otherwise, the properties will contain default values. </summary> <returns>The set of properties for the last event that was enqueued to the partition. If no events were read or tracking was not set, the properties will be returned with default values.</returns> <remarks> When information about the partition's last enqueued event is being tracked, each event received from the Event Hubs service will carry metadata about the partition that it otherwise would not. This results in a small amount of additional network bandwidth consumption that is generally a favorable trade-off when considered against periodically making requests for partition properties using an Event Hub client. </remarks> <exception cref="T:Azure.Messaging.EventHubs.EventHubsException">Occurs when the Event Hubs client needed to read this information is no longer available.</exception> </Docs> </Member> <Member MemberName="ReceiveBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync(int32 maximumEventCount, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.ReceiveBatchAsync(System.Int32,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>" Usage="partitionReceiver.ReceiveBatchAsync (maximumEventCount, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maximumEventCount" Type="System.Int32" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="maximumEventCount">The maximum number of messages to receive in this batch.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Receives a batch of <see cref="T:Azure.Messaging.EventHubs.EventData" /> from the Event Hub partition this client is associated with. </summary> <returns>The batch of <see cref="T:Azure.Messaging.EventHubs.EventData" /> from the Event Hub partition this client is associated with. If no events are present, an empty enumerable is returned.</returns> <remarks> When events are available in the prefetch queue, they will be used to form the batch as quickly as possible without waiting for additional events from the Event Hubs service to try and meet the requested <paramref name="maximumEventCount" />. When no events are available in prefetch, the receiver will wait up to the duration specified by the <see cref="P:Azure.Messaging.EventHubs.EventHubsRetryOptions.TryTimeout" /> in the active retry policy for events to be read from the service. Once any events are available, they will be used to form the batch immediately. </remarks> <exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested <paramref name="maximumEventCount" /> is less than 1.</exception> <exception cref="T:Azure.Messaging.EventHubs.EventHubsException"> Occurs when an <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> is unable to read from the requested Event Hub partition due to another reader having asserted exclusive ownership. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />. </exception> </Docs> </Member> <Member MemberName="ReceiveBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, TimeSpan maximumWaitTime, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync(int32 maximumEventCount, valuetype System.TimeSpan maximumWaitTime, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.ReceiveBatchAsync(System.Int32,System.TimeSpan,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, maximumWaitTime As TimeSpan, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))" /> <MemberSignature Language="F#" Value="abstract member ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>" Usage="partitionReceiver.ReceiveBatchAsync (maximumEventCount, maximumWaitTime, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maximumEventCount" Type="System.Int32" /> <Parameter Name="maximumWaitTime" Type="System.TimeSpan" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="maximumEventCount">The maximum number of messages to receive in this batch.</param> <param name="maximumWaitTime">The maximum amount of time to wait for events to become available, if no events can be read from the prefetch queue.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Receives a batch of <see cref="T:Azure.Messaging.EventHubs.EventData" /> from the Event Hub partition this client is associated with. </summary> <returns>The batch of <see cref="T:Azure.Messaging.EventHubs.EventData" /> from the Event Hub partition this client is associated with. If no events are present, an empty enumerable is returned.</returns> <remarks> When events are available in the prefetch queue, they will be used to form the batch as quickly as possible without waiting for additional events from the Event Hubs service to try and meet the requested <paramref name="maximumEventCount" />. When no events are available in prefetch, the receiver will wait up to the <paramref name="maximumWaitTime" /> for events to be read from the service. Once any events are available, they will be used to form the batch immediately. </remarks> <exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested <paramref name="maximumEventCount" /> is less than 1.</exception> <exception cref="T:Azure.Messaging.EventHubs.EventHubsException"> Occurs when an <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> is unable to read from the requested Event Hub partition due to another reader having asserted exclusive ownership. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />. </exception> </Docs> </Member> <Member MemberName="ToString"> <MemberSignature Language="C#" Value="public override string ToString ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiver.ToString" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" /> <MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="partitionReceiver.ToString " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Messaging.EventHubs</AssemblyName> <AssemblyVersion>5.12.0.0</AssemblyVersion> <AssemblyVersion>5.12.1.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Converts the instance to string representation. </summary> <returns>A <see cref="T:System.String" /> that represents this instance.</returns> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Azure.Messaging.EventHubs.Primitives/PartitionReceiver.xml (750 lines of code) (raw):