xml/Azure.Messaging.EventHubs.Producer/EventHubProducerClient.xml (927 lines of code) (raw):

<Type Name="EventHubProducerClient" FullName="Azure.Messaging.EventHubs.Producer.EventHubProducerClient"> <TypeSignature Language="C#" Value="public class EventHubProducerClient : IAsyncDisposable" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EventHubProducerClient extends System.Object implements class System.IAsyncDisposable" /> <TypeSignature Language="DocId" Value="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> <TypeSignature Language="VB.NET" Value="Public Class EventHubProducerClient&#xA;Implements IAsyncDisposable" /> <TypeSignature Language="F#" Value="type EventHubProducerClient = class&#xA; 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> A client responsible for publishing <see cref="T:Azure.Messaging.EventHubs.EventData" /> to a specific Event Hub, grouped together in batches. Depending on the options specified when sending, events may be automatically assigned an available partition or may request a specific partition. The <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> publishes immediately, ensuring a deterministic outcome for each send operation, though requires that callers own the responsibility of building and managing batches. In scenarios where it is not important to have events published immediately and where maximizing partition availability is not a requirement, it is recommended to consider using the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubBufferedProducerClient" />, which takes responsibility for building and managing batches to reduce the complexity of doing so in application code. </summary> <remarks> <list type="bullet"> <listheader> <description>Allowing partition assignment is recommended when:</description> </listheader> <item> <description>The sending of events needs to be highly available.</description> </item> <item> <description>The event data should be evenly distributed among all available partitions.</description> </item> </list> <list type="number"> <listheader> <description>If no partition is specified, the following rules are used for automatically selecting one:</description> </listheader> <item> <description>Distribute the events equally amongst all available partitions using a round-robin approach.</description> </item> <item> <description>If a partition becomes unavailable, the Event Hubs service will automatically detect it and forward the message to another available partition.</description> </item> </list> <para> The <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> is safe to cache and use for the lifetime of an application, which is the best practice when the application publishes events regularly or semi-regularly. The producer is responsible for ensuring efficient network, CPU, and memory use. Calling either <see cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CloseAsync(System.Threading.CancellationToken)" /> or <see cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.DisposeAsync" /> as the application is shutting down will ensure that network resources and other unmanaged objects are properly cleaned up. </para> </remarks> <altmember cref="T:Azure.Messaging.EventHubs.Producer.EventHubBufferedProducerClient" /> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected EventHubProducerClient ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#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.Producer.EventHubProducerClient" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public EventHubProducerClient (string connectionString);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : string -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient connectionString" /> <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="connectionString" Type="System.String" /> </Parameters> <Docs> <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> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> 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 EventHubProducerClient (Azure.Messaging.EventHubs.EventHubConnection connection, Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Messaging.EventHubs.EventHubConnection connection, class Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(Azure.Messaging.EventHubs.EventHubConnection,Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (connection As EventHubConnection, Optional clientOptions As EventHubProducerClientOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : Azure.Messaging.EventHubs.EventHubConnection * Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient (connection, clientOptions)" /> <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="connection" Type="Azure.Messaging.EventHubs.EventHubConnection" /> <Parameter Name="clientOptions" Type="Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions" /> </Parameters> <Docs> <param name="connection">The <see cref="T:Azure.Messaging.EventHubs.EventHubConnection" /> connection to use for communication with the Event Hubs service.</param> <param name="clientOptions">A set of options to apply when configuring the producer.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public EventHubProducerClient (string connectionString, Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString, class Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(System.String,Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String, clientOptions As EventHubProducerClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : string * Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient (connectionString, clientOptions)" /> <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="connectionString" Type="System.String" /> <Parameter Name="clientOptions" Type="Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions" /> </Parameters> <Docs> <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="clientOptions">The set of options to use for this consumer.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> 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 EventHubProducerClient (string connectionString, string eventHubName);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString, string eventHubName) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(System.String,System.String)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String, eventHubName As String)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : string * string -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient (connectionString, eventHubName)" /> <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="connectionString" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> </Parameters> <Docs> <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 producer with.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> 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 EventHubProducerClient (string connectionString, string eventHubName, Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString, string eventHubName, class Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(System.String,System.String,Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String, eventHubName As String, clientOptions As EventHubProducerClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : string * string * Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient (connectionString, eventHubName, clientOptions)" /> <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="connectionString" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="clientOptions" Type="Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions" /> </Parameters> <Docs> <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 producer with.</param> <param name="clientOptions">A set of options to apply when configuring the producer.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> 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 EventHubProducerClient (string fullyQualifiedNamespace, string eventHubName, Azure.AzureNamedKeyCredential credential, Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fullyQualifiedNamespace, string eventHubName, class Azure.AzureNamedKeyCredential credential, class Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(System.String,System.String,Azure.AzureNamedKeyCredential,Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (fullyQualifiedNamespace As String, eventHubName As String, credential As AzureNamedKeyCredential, Optional clientOptions As EventHubProducerClientOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : string * string * Azure.AzureNamedKeyCredential * Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient (fullyQualifiedNamespace, eventHubName, credential, clientOptions)" /> <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="fullyQualifiedNamespace" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="credential" Type="Azure.AzureNamedKeyCredential" /> <Parameter Name="clientOptions" Type="Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions" /> </Parameters> <Docs> <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 producer with.</param> <param name="credential">The shared access 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="clientOptions">A set of options to apply when configuring the producer.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public EventHubProducerClient (string fullyQualifiedNamespace, string eventHubName, Azure.AzureSasCredential credential, Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fullyQualifiedNamespace, string eventHubName, class Azure.AzureSasCredential credential, class Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(System.String,System.String,Azure.AzureSasCredential,Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (fullyQualifiedNamespace As String, eventHubName As String, credential As AzureSasCredential, Optional clientOptions As EventHubProducerClientOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : string * string * Azure.AzureSasCredential * Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient (fullyQualifiedNamespace, eventHubName, credential, clientOptions)" /> <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="fullyQualifiedNamespace" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="credential" Type="Azure.AzureSasCredential" /> <Parameter Name="clientOptions" Type="Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions" /> </Parameters> <Docs> <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 producer with.</param> <param name="credential">The shared access 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="clientOptions">A set of options to apply when configuring the producer.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> class. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public EventHubProducerClient (string fullyQualifiedNamespace, string eventHubName, Azure.Core.TokenCredential credential, Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fullyQualifiedNamespace, string eventHubName, class Azure.Core.TokenCredential credential, class Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions clientOptions) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.#ctor(System.String,System.String,Azure.Core.TokenCredential,Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (fullyQualifiedNamespace As String, eventHubName As String, credential As TokenCredential, Optional clientOptions As EventHubProducerClientOptions = Nothing)" /> <MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient : string * string * Azure.Core.TokenCredential * Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions -&gt; Azure.Messaging.EventHubs.Producer.EventHubProducerClient" Usage="new Azure.Messaging.EventHubs.Producer.EventHubProducerClient (fullyQualifiedNamespace, eventHubName, credential, clientOptions)" /> <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="fullyQualifiedNamespace" Type="System.String" /> <Parameter Name="eventHubName" Type="System.String" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> <Parameter Name="clientOptions" Type="Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions" /> </Parameters> <Docs> <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 producer 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="clientOptions">A set of options to apply when configuring the producer.</param> <summary> Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> 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.Producer.EventHubProducerClient.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 -&gt; System.Threading.Tasks.Task&#xA;override this.CloseAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="eventHubProducerClient.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 producer. </summary> <returns>A task to be resolved on when the operation has completed.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="CreateBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt; CreateBatchAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;class Azure.Messaging.EventHubs.Producer.EventDataBatch&gt; CreateBatchAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateBatchAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of EventDataBatch)" /> <MemberSignature Language="F#" Value="abstract member CreateBatchAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt;&#xA;override this.CreateBatchAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt;" Usage="eventHubProducerClient.CreateBatchAsync 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.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt;</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> Creates a size-constraint batch to which <see cref="T:Azure.Messaging.EventHubs.EventData" /> may be added using a try-based pattern. If an event would exceed the maximum allowable size of the batch, the batch will not allow adding the event and signal that scenario using its return value. Because events that would violate the size constraint cannot be added, publishing a batch will not trigger an exception when attempting to send the events to the Event Hubs service. </summary> <returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the default batch options.</returns> <remarks>To be added.</remarks> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" /> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" /> </Docs> </Member> <Member MemberName="CreateBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt; CreateBatchAsync (Azure.Messaging.EventHubs.Producer.CreateBatchOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1&lt;class Azure.Messaging.EventHubs.Producer.EventDataBatch&gt; CreateBatchAsync(class Azure.Messaging.EventHubs.Producer.CreateBatchOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateBatchAsync (options As CreateBatchOptions, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of EventDataBatch)" /> <MemberSignature Language="F#" Value="abstract member CreateBatchAsync : Azure.Messaging.EventHubs.Producer.CreateBatchOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt;&#xA;override this.CreateBatchAsync : Azure.Messaging.EventHubs.Producer.CreateBatchOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt;" Usage="eventHubProducerClient.CreateBatchAsync (options, 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.ValueTask&lt;Azure.Messaging.EventHubs.Producer.EventDataBatch&gt;</ReturnType> </ReturnValue> <Parameters> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Producer.CreateBatchOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="options">The set of options to consider when creating 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> Creates a size-constraint batch to which <see cref="T:Azure.Messaging.EventHubs.EventData" /> may be added using a try-based pattern. If an event would exceed the maximum allowable size of the batch, the batch will not allow adding the event and signal that scenario using its return value. Because events that would violate the size constraint cannot be added, publishing a batch will not trigger an exception when attempting to send the events to the Event Hubs service. </summary> <returns>An <see cref="T:Azure.Messaging.EventHubs.Producer.EventDataBatch" /> with the requested <paramref name="options" />.</returns> <remarks>To be added.</remarks> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" /> <exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" /> </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.Producer.EventHubProducerClient.DisposeAsync" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DisposeAsync () As ValueTask" /> <MemberSignature Language="F#" Value="abstract member DisposeAsync : unit -&gt; System.Threading.Tasks.ValueTask&#xA;override this.DisposeAsync : unit -&gt; System.Threading.Tasks.ValueTask" Usage="eventHubProducerClient.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.Producer.EventHubProducerClient" />, including ensuring that the client itself has been closed. </summary> <returns>A task to be resolved on when the operation has completed.</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.Producer.EventHubProducerClient.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 -&gt; bool" Usage="eventHubProducerClient.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#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</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.Producer.EventHubProducerClient.EventHubName" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventHubName As String" /> <MemberSignature Language="F#" Value="member this.EventHubName : string" Usage="Azure.Messaging.EventHubs.Producer.EventHubProducerClient.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 producer 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.Producer.EventHubProducerClient.FullyQualifiedNamespace" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property FullyQualifiedNamespace As String" /> <MemberSignature Language="F#" Value="member this.FullyQualifiedNamespace : string" Usage="Azure.Messaging.EventHubs.Producer.EventHubProducerClient.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 producer 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="GetEventHubPropertiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.EventHubProperties&gt; GetEventHubPropertiesAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Azure.Messaging.EventHubs.EventHubProperties&gt; GetEventHubPropertiesAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.GetEventHubPropertiesAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetEventHubPropertiesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of EventHubProperties)" /> <MemberSignature Language="F#" Value="abstract member GetEventHubPropertiesAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.EventHubProperties&gt;&#xA;override this.GetEventHubPropertiesAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.EventHubProperties&gt;" Usage="eventHubProducerClient.GetEventHubPropertiesAsync 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&lt;Azure.Messaging.EventHubs.EventHubProperties&gt;</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 Event Hub that the connection is associated with, including the number of partitions present and their identifiers. </summary> <returns>The set of information for the Event Hub that this client is associated with.</returns> <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.Producer.EventHubProducerClient.GetHashCode" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" /> <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="eventHubProducerClient.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#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</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="GetPartitionIdsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task&lt;string[]&gt; GetPartitionIdsAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;string[]&gt; GetPartitionIdsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.GetPartitionIdsAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetPartitionIdsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of String())" /> <MemberSignature Language="F#" Value="abstract member GetPartitionIdsAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;string[]&gt;&#xA;override this.GetPartitionIdsAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;string[]&gt;" Usage="eventHubProducerClient.GetPartitionIdsAsync 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&lt;System.String[]&gt;</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 the set of identifiers for the partitions of an Event Hub. </summary> <returns>The set of identifiers for the partitions within the Event Hub that this client is associated with.</returns> <remarks> This method is synonymous with invoking <see cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.GetEventHubPropertiesAsync(System.Threading.CancellationToken)" /> and reading the <see cref="P:Azure.Messaging.EventHubs.EventHubProperties.PartitionIds" /> property that is returned. It is offered as a convenience for quick access to the set of partition identifiers for the associated Event Hub. No new or extended information is presented. </remarks> </Docs> </Member> <Member MemberName="GetPartitionPropertiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.PartitionProperties&gt; GetPartitionPropertiesAsync (string partitionId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Azure.Messaging.EventHubs.PartitionProperties&gt; GetPartitionPropertiesAsync(string partitionId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.GetPartitionPropertiesAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetPartitionPropertiesAsync (partitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PartitionProperties)" /> <MemberSignature Language="F#" Value="abstract member GetPartitionPropertiesAsync : string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.PartitionProperties&gt;&#xA;override this.GetPartitionPropertiesAsync : string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.PartitionProperties&gt;" Usage="eventHubProducerClient.GetPartitionPropertiesAsync (partitionId, 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&lt;Azure.Messaging.EventHubs.PartitionProperties&gt;</ReturnType> </ReturnValue> <Parameters> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="partitionId">The unique identifier of a partition associated with the Event Hub.</param> <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 a specific partition for an Event Hub, including elements that describe the available events in the partition event stream. </summary> <returns>The set of information for the requested partition under the Event Hub this client is associated with.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="GetPartitionPublishingPropertiesAsync"> <MemberSignature Language="C#" Value="protected internal virtual System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.Producer.PartitionPublishingProperties&gt; GetPartitionPublishingPropertiesAsync (string partitionId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Azure.Messaging.EventHubs.Producer.PartitionPublishingProperties&gt; GetPartitionPublishingPropertiesAsync(string partitionId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.GetPartitionPublishingPropertiesAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Protected Friend Overridable Function GetPartitionPublishingPropertiesAsync (partitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PartitionPublishingProperties)" /> <MemberSignature Language="F#" Value="abstract member GetPartitionPublishingPropertiesAsync : string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.Producer.PartitionPublishingProperties&gt;&#xA;override this.GetPartitionPublishingPropertiesAsync : string * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.Producer.PartitionPublishingProperties&gt;" Usage="eventHubProducerClient.GetPartitionPublishingPropertiesAsync (partitionId, cancellationToken)" /> <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#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task&lt;Azure.Messaging.EventHubs.Producer.PartitionPublishingProperties&gt;</ReturnType> </ReturnValue> <Parameters> <Parameter Name="partitionId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="partitionId">The unique identifier of a partition associated with the Event Hub.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> A set of information about the state of publishing for a partition, as observed by the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" />. This data can always be read, but will only be populated with information relevant to the active features for the producer client. </summary> <returns>The set of information about the publishing state of the requested partition, within the context of this producer.</returns> <remarks> The state of a partition is only understood by the <see cref="T:Azure.Messaging.EventHubs.Producer.EventHubProducerClient" /> after events have been published to that partition; calling this method for a partition before events have been published to it will return an empty set of properties. </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.Producer.EventHubProducerClient.Identifier" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Identifier As String" /> <MemberSignature Language="F#" Value="member this.Identifier : string" Usage="Azure.Messaging.EventHubs.Producer.EventHubProducerClient.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 producer. </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.Producer.EventHubProducerClient.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.Producer.EventHubProducerClient.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.Producer.EventHubProducerClient" /> 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="SendAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task SendAsync (Azure.Messaging.EventHubs.Producer.EventDataBatch eventBatch, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(class Azure.Messaging.EventHubs.Producer.EventDataBatch eventBatch, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SendAsync (eventBatch As EventDataBatch, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member SendAsync : Azure.Messaging.EventHubs.Producer.EventDataBatch * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&#xA;override this.SendAsync : Azure.Messaging.EventHubs.Producer.EventDataBatch * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="eventHubProducerClient.SendAsync (eventBatch, 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="eventBatch" Type="Azure.Messaging.EventHubs.Producer.EventDataBatch" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="eventBatch">The set of event data to send. A batch may be created using <see cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" />.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Sends a set of events to the associated Event Hub using a batched approach. </summary> <returns> A task to be resolved on when the operation has completed; if no exception is thrown when awaited, the Event Hubs service has acknowledge receipt and assumed responsibility for delivery of the batch. </returns> <remarks> When published, the result is atomic; either all events that belong to the batch were successful or all have failed. Partial success is not possible. </remarks> <exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified by the batch.</exception> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" /> </Docs> </Member> <Member MemberName="SendAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task SendAsync (System.Collections.Generic.IEnumerable&lt;Azure.Messaging.EventHubs.EventData&gt; eventBatch, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(class System.Collections.Generic.IEnumerable`1&lt;class Azure.Messaging.EventHubs.EventData&gt; eventBatch, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SendAsync (eventBatch As IEnumerable(Of EventData), Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member SendAsync : seq&lt;Azure.Messaging.EventHubs.EventData&gt; * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&#xA;override this.SendAsync : seq&lt;Azure.Messaging.EventHubs.EventData&gt; * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="eventHubProducerClient.SendAsync (eventBatch, 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="eventBatch" Type="System.Collections.Generic.IEnumerable&lt;Azure.Messaging.EventHubs.EventData&gt;" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="eventBatch">The set of event data to send.</param> <param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param> <summary> Sends a set of events to the associated Event Hub as a single operation. To avoid the overhead associated with measuring and validating the size in the client, validation will be delegated to the Event Hubs service and is deferred until the operation is invoked. The call will fail if the size of the specified set of events exceeds the maximum allowable size of a single batch. </summary> <returns> A task to be resolved on when the operation has completed; if no exception is thrown when awaited, the Event Hubs service has acknowledged receipt and assumed responsibility for delivery of the set of events to its partition. </returns> <remarks> When published, the result is atomic; either all events that belong to the set were successful or all have failed. Partial success is not possible. </remarks> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(System.Threading.CancellationToken)" /> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},Azure.Messaging.EventHubs.Producer.SendEventOptions,System.Threading.CancellationToken)" /> <exception cref="T:Azure.Messaging.EventHubs.EventHubsException"> Occurs when the set of events exceeds the maximum size allowed in a single batch, as determined by the Event Hubs service. The <see cref="P:Azure.Messaging.EventHubs.EventHubsException.Reason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.MessageSizeExceeded" /> in this case. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException"> Occurs when one of the events in the <paramref name="eventBatch" /> has a member in the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> collection that is an unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details. </exception> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" /> </Docs> </Member> <Member MemberName="SendAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task SendAsync (System.Collections.Generic.IEnumerable&lt;Azure.Messaging.EventHubs.EventData&gt; eventBatch, Azure.Messaging.EventHubs.Producer.SendEventOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(class System.Collections.Generic.IEnumerable`1&lt;class Azure.Messaging.EventHubs.EventData&gt; eventBatch, class Azure.Messaging.EventHubs.Producer.SendEventOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},Azure.Messaging.EventHubs.Producer.SendEventOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SendAsync (eventBatch As IEnumerable(Of EventData), options As SendEventOptions, Optional cancellationToken As CancellationToken = Nothing) As Task" /> <MemberSignature Language="F#" Value="abstract member SendAsync : seq&lt;Azure.Messaging.EventHubs.EventData&gt; * Azure.Messaging.EventHubs.Producer.SendEventOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&#xA;override this.SendAsync : seq&lt;Azure.Messaging.EventHubs.EventData&gt; * Azure.Messaging.EventHubs.Producer.SendEventOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task" Usage="eventHubProducerClient.SendAsync (eventBatch, options, 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="eventBatch" Type="System.Collections.Generic.IEnumerable&lt;Azure.Messaging.EventHubs.EventData&gt;" /> <Parameter Name="options" Type="Azure.Messaging.EventHubs.Producer.SendEventOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="eventBatch">The set of event data to send.</param> <param name="options">The set of options to consider when sending 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> Sends a set of events to the associated Event Hub as a single operation. To avoid the overhead associated with measuring and validating the size in the client, validation will be delegated to the Event Hubs service and is deferred until the operation is invoked. The call will fail if the size of the specified set of events exceeds the maximum allowable size of a single batch. </summary> <returns> A task to be resolved on when the operation has completed; if no exception is thrown when awaited, the Event Hubs service has acknowledged receipt and assumed responsibility for delivery of the set of events to its partition. </returns> <remarks> When published, the result is atomic; either all events that belong to the set were successful or all have failed. Partial success is not possible. </remarks> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.CreateBatchAsync(Azure.Messaging.EventHubs.Producer.CreateBatchOptions,System.Threading.CancellationToken)" /> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(System.Collections.Generic.IEnumerable{Azure.Messaging.EventHubs.EventData},System.Threading.CancellationToken)" /> <exception cref="T:System.InvalidOperationException">Occurs when both a partition identifier and partition key have been specified in the <paramref name="options" />.</exception> <exception cref="T:Azure.Messaging.EventHubs.EventHubsException"> Occurs when the set of events exceeds the maximum size allowed in a single batch, as determined by the Event Hubs service. The <see cref="P:Azure.Messaging.EventHubs.EventHubsException.Reason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.MessageSizeExceeded" /> in this case. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException"> Occurs when one of the events in the <paramref name="eventBatch" /> has a member in the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> collection that is an unsupported type for serialization. See the <see cref="P:Azure.Messaging.EventHubs.EventData.Properties" /> remarks for details. </exception> <altmember cref="M:Azure.Messaging.EventHubs.Producer.EventHubProducerClient.SendAsync(Azure.Messaging.EventHubs.Producer.EventDataBatch,System.Threading.CancellationToken)" /> </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.Producer.EventHubProducerClient.ToString" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" /> <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="eventHubProducerClient.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#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</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>