EventHubProducerClient class

  • Referencia
Csomag:
@azure/event-hubs

Az EventHubProducerClient osztály eseményközpontba küldi az eseményeket.

Többféleképpen is létrehozható EventHubProducerClient

  • Használja az Event Hub-példányhoz létrehozott SAS-szabályzat kapcsolati sztring.
  • Használja az Event Hub-névtérhez létrehozott SAS-szabályzat kapcsolati sztring és az Event Hub-példány nevét
  • Használja a teljes névteret, például <yournamespace>.servicebus.windows.neta , és egy hitelesítőadat-objektumot.

Az újrapróbálkozás szabályzatának vagy proxybeállításainak konfigurálásához megadhat egy beállításcsomagot is.

Konstruktorok

EventHubProducerClient(string, EventHubClientOptions)

Az EventHubProducerClient osztály események eseményközpontba való küldésére szolgál. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
EventHubProducerClient(string, string, EventHubClientOptions)

Az EventHubProducerClient osztály események eseményközpontba való küldésére szolgál. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
EventHubProducerClient(string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubClientOptions)

Az EventHubProducerClient osztály események eseményközpontba való küldésére szolgál. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

Tulajdonságok

eventHubName

Annak az Event Hub-példánynak a neve, amelyhez az ügyfél létrejön.
fullyQualifiedNamespace

Annak az Event Hub-példánynak a teljes névtere, amelyhez az ügyfél létrejön. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hoz.
identifier

Az EventHubProducerClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

Metódusok

close()

Bezárja az AMQP-kapcsolatot az Event Hub-példányhoz, és visszaad egy ígéretet, amely a leválasztás befejezésekor megoldódik.
createBatch(CreateBatchOptions)

Létrehoz egy példányt EventDataBatch , amelyhez eseményeket adhat hozzá, amíg el nem éri a maximális támogatott méretet. A köteg átadható a küldendő Azure Event Hubs sendBatch metódusánakEventHubProducerClient.

A partitionKey vagy partitionId különböző értékekkel rendelkező eseményeket különböző kötegekbe kell helyezni. Ha egyszerűbbé szeretné tenni az ilyen kötegkezelést a partíciók között, vagy hogy az ügyfél automatikusan kötegelje az eseményeket, és adott időközönként küldje el őket, használja inkább a parancsot EventHubBufferedProducerClient .

Az alábbi példa azt feltételezi, hogy egy sor esemény van a kezében, amelyet biztonságosan kell kötegeltíteni. Ha egyesével érkeznek események, EventHubBufferedProducerClient a kötegek hatékony kezelése helyett ajánlott.

Példahasználat:

const client = new EventHubProducerClient(connectionString);
let batch = await client.createBatch();
for (let i = 0; i < messages.length; i++) {
 if (!batch.tryAdd(messages[i])) {
   await client.sendBatch(batch);
   batch = await client.createBatch();
   if (!batch.tryAdd(messages[i])) {
     throw new Error("Message too big to fit")
   }
   if (i === messages.length - 1) {
     await client.sendBatch(batch);
   }
  }
}
getEventHubProperties(GetEventHubPropertiesOptions)

Megadja az Event Hub futtatókörnyezetének adatait.
getPartitionIds(GetPartitionIdsOptions)

Megadja az Eseményközponthoz társított partíciók azonosítóját.
getPartitionProperties(string, GetPartitionPropertiesOptions)

Információt nyújt a megadott partíció állapotáról.
sendBatch(EventDataBatch, OperationOptions)

A használatával létrehozott EventHubProducerClient.createBatch() események kötegét küldi el a társított Eseményközpontnak.

A partitionKey vagy partitionId különböző értékekkel rendelkező eseményeket különböző kötegekbe kell helyezni. Ha egyszerűbbé szeretné tenni az ilyen kötegkezelést a partíciók között, vagy hogy az ügyfél automatikusan kötegelje az eseményeket, és adott időközönként küldje el őket, használja inkább a parancsot EventHubBufferedProducerClient .

Az alábbi példa azt feltételezi, hogy egy sor esemény van a kezében, amelyet biztonságosan kell kötegeltíteni. Ha egyesével érkeznek események, EventHubBufferedProducerClient a kötegek hatékony kezelése helyett ajánlott.

Példahasználat:

const client = new EventHubProducerClient(connectionString);
let batch = await client.createBatch();
for (let i = 0; i < messages.length; i++) {
 if (!batch.tryAdd(messages[i])) {
   await client.sendBatch(batch);
   batch = await client.createBatch();
   if (!batch.tryAdd(messages[i])) {
     throw new Error("Message too big to fit")
   }
   if (i === messages.length - 1) {
     await client.sendBatch(batch);
   }
  }
}
sendBatch(EventData[] | AmqpAnnotatedMessage[], SendBatchOptions)

Eseménytömböt küld kötegként a társított Eseményközpontnak.

Azure Event Hubs az elküldhető köteg méretére vonatkozó korlátozással rendelkezik, amely ha túllépi, a kóddal MessageTooLargeErrorkapcsolatos hibát eredményez. A kötegméret korlátain belüli biztonságos küldéshez használja vagy EventHubBufferedProducerClient használja EventHubProducerClient.createBatch() a parancsot.

Példahasználat:

const client = new EventHubProducerClient(connectionString);
await client.sendBatch(messages);

Konstruktor adatai

EventHubProducerClient(string, EventHubClientOptions)

Az EventHubProducerClient osztály események eseményközpontba való küldésére szolgál. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

new EventHubProducerClient(connectionString: string, options?: EventHubClientOptions)

Paraméterek

connectionString

string

Az Event Hub-példányhoz való csatlakozáshoz használandó kapcsolati sztring. A megosztott kulcs tulajdonságai és az Eseményközpont elérési útja várhatóan ebben a kapcsolati sztring található. például: "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name".

options
EventHubClientOptions

Az ügyfél konfigurálásakor alkalmazandó beállítások készlete.

  • retryOptions : Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.
  • userAgent : A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc.

EventHubProducerClient(string, string, EventHubClientOptions)

Az EventHubProducerClient osztály események eseményközpontba való küldésére szolgál. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

new EventHubProducerClient(connectionString: string, eventHubName: string, options?: EventHubClientOptions)

Paraméterek

connectionString

string

Az Event Hubs-névtérhez való csatlakozáshoz használandó kapcsolati sztring. A megosztott kulcs tulajdonságai várhatóan ebben a kapcsolati sztring találhatók, de az Eseményközpont elérési útja nem, például :Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.

options
EventHubClientOptions

Az ügyfél konfigurálásakor alkalmazandó beállítások készlete.

  • retryOptions : Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.
  • userAgent : A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzendő karakterlánc.

EventHubProducerClient(string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubClientOptions)

Az EventHubProducerClient osztály események eseményközpontba való küldésére szolgál. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

new EventHubProducerClient(fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubClientOptions)

Paraméterek

fullyQualifiedNamespace

string

A teljes névtér, amely valószínűleg hasonló lesz a .servicebus.windows.net

eventHubName

string

Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.

credential

TokenCredential | NamedKeyCredential | SASCredential

Egy hitelesítőadat-objektum, amelyet az ügyfél használ a jogkivonat lekéréséhez a Azure Event Hubs szolgáltatással való kapcsolat hitelesítéséhez. Az AAD-hitelesítést támogató hitelesítő adatok létrehozásáról a @azure/identitás című témakörben olvashat. Használja a AzureNamedKeyCredential from @azure/core-auth parancsot, ha kapcsolati sztring használata nélkül szeretne megadni egy SharedAccessKeyName és SharedAccessKey értéket. Ezek a mezők a és key a name mezőre vannak képezve a mezőbenAzureNamedKeyCredential. Használja a AzureSASCredential from @azure/core-auth parancsot, ha kapcsolati sztring használata nélkül szeretne megadni egy SharedAccessSignature értéket. Ez a mező a következőre lesz leképzve: signatureAzureSASCredential.

options
EventHubClientOptions

Az ügyfél konfigurálásakor alkalmazandó beállítások halmaza.

  • retryOptions : Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.
  • userAgent : A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring.

Tulajdonság adatai

eventHubName

Annak az Event Hub-példánynak a neve, amelyhez az ügyfél létrejön.

string eventHubName

Tulajdonság értéke

string

fullyQualifiedNamespace

Annak az Event Hub-példánynak a teljes névtere, amelyhez az ügyfél létrejön. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hoz.

string fullyQualifiedNamespace

Tulajdonság értéke

string

identifier

Az EventHubProducerClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

identifier: string

Tulajdonság értéke

string

Metódus adatai

close()

Bezárja az AMQP-kapcsolatot az Event Hub-példányhoz, és visszaad egy ígéretet, amely a leválasztás befejezésekor megoldódik.

function close(): Promise<void>

Válaszok

Promise<void>

Ígéret

createBatch(CreateBatchOptions)

Létrehoz egy példányt EventDataBatch , amelyhez eseményeket adhat hozzá, amíg el nem éri a maximális támogatott méretet. A köteg átadható a küldendő Azure Event Hubs sendBatch metódusánakEventHubProducerClient.

A partitionKey vagy partitionId különböző értékekkel rendelkező eseményeket különböző kötegekbe kell helyezni. Ha egyszerűbbé szeretné tenni az ilyen kötegkezelést a partíciók között, vagy hogy az ügyfél automatikusan kötegelje az eseményeket, és adott időközönként küldje el őket, használja inkább a parancsot EventHubBufferedProducerClient .

Az alábbi példa azt feltételezi, hogy egy sor esemény van a kezében, amelyet biztonságosan kell kötegeltíteni. Ha egyesével érkeznek események, EventHubBufferedProducerClient a kötegek hatékony kezelése helyett ajánlott.

Példahasználat:

const client = new EventHubProducerClient(connectionString);
let batch = await client.createBatch();
for (let i = 0; i < messages.length; i++) {
 if (!batch.tryAdd(messages[i])) {
   await client.sendBatch(batch);
   batch = await client.createBatch();
   if (!batch.tryAdd(messages[i])) {
     throw new Error("Message too big to fit")
   }
   if (i === messages.length - 1) {
     await client.sendBatch(batch);
   }
  }
}

function createBatch(options?: CreateBatchOptions): Promise<EventDataBatch>

Paraméterek

options
CreateBatchOptions

Konfigurálja a köteg viselkedését.

  • partitionKey: A Azure Event Hubs szolgáltatás kivonatolt és használt értéke annak a partíciónak a meghatározásához, amelyre az eseményeket el kell küldeni.
  • partitionId : Annak a partíciónak az azonosítója, amelyre az események kötegét el kell küldeni.
  • maxSizeInBytes: A köteg méretének felső korlátja. A tryAdd függvény a korlát elérése után tér vissza false .
  • abortSignal : A művelet megszakítására irányuló kérés jelzése.

Válaszok

Promise<EventDataBatch>

Ígéret

getEventHubProperties(GetEventHubPropertiesOptions)

Megadja az Event Hub futtatókörnyezetének adatait.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

Paraméterek

options
GetEventHubPropertiesOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<EventHubProperties>

Egy ígéret, amely az Event Hub-példányra vonatkozó információkkal oldható fel.

getPartitionIds(GetPartitionIdsOptions)

Megadja az Eseményközponthoz társított partíciók azonosítóját.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

Paraméterek

options
GetPartitionIdsOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<string[]>

Egy ígéret, amely az Event Hubhoz társított egyes partíciók azonosítóját képviselő sztringek tömbjével oldható fel.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Információt nyújt a megadott partíció állapotáról.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

Paraméterek

partitionId

string

Annak a partíciónak az azonosítója, amelyhez információ szükséges.

options
GetPartitionPropertiesOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<PartitionProperties>

Egy ígéret, amely a partíció állapotával kapcsolatos információkkal oldható fel.

sendBatch(EventDataBatch, OperationOptions)

A használatával létrehozott EventHubProducerClient.createBatch() események kötegét küldi el a társított Eseményközpontnak.

A partitionKey vagy partitionId különböző értékekkel rendelkező eseményeket különböző kötegekbe kell helyezni. Ha egyszerűbbé szeretné tenni az ilyen kötegkezelést a partíciók között, vagy hogy az ügyfél automatikusan kötegelje az eseményeket, és adott időközönként küldje el őket, használja inkább a parancsot EventHubBufferedProducerClient .

Az alábbi példa azt feltételezi, hogy egy sor esemény van a kezében, amelyet biztonságosan kell kötegeltíteni. Ha egyesével érkeznek események, EventHubBufferedProducerClient a kötegek hatékony kezelése helyett ajánlott.

Példahasználat:

const client = new EventHubProducerClient(connectionString);
let batch = await client.createBatch();
for (let i = 0; i < messages.length; i++) {
 if (!batch.tryAdd(messages[i])) {
   await client.sendBatch(batch);
   batch = await client.createBatch();
   if (!batch.tryAdd(messages[i])) {
     throw new Error("Message too big to fit")
   }
   if (i === messages.length - 1) {
     await client.sendBatch(batch);
   }
  }
}

function sendBatch(batch: EventDataBatch, options?: OperationOptions): Promise<void>

Paraméterek

batch
EventDataBatch

A createBatch metódussal létrehozható események kötege.

options
OperationOptions

Az eseményeknek a társított eseményközpontba való elküldésének módjának befolyásolására megadható lehetőségek készlete.

  • abortSignal : A küldési művelet megszakítására irányuló kérés jelzése.

Válaszok

Promise<void>

Ígéret

sendBatch(EventData[] | AmqpAnnotatedMessage[], SendBatchOptions)

Eseménytömböt küld kötegként a társított Eseményközpontnak.

Azure Event Hubs az elküldhető köteg méretére vonatkozó korlátozással rendelkezik, amely ha túllépi, a kóddal MessageTooLargeErrorkapcsolatos hibát eredményez. A kötegméret korlátain belüli biztonságos küldéshez használja vagy EventHubBufferedProducerClient használja EventHubProducerClient.createBatch() a parancsot.

Példahasználat:

const client = new EventHubProducerClient(connectionString);
await client.sendBatch(messages);

function sendBatch(batch: EventData[] | AmqpAnnotatedMessage[], options?: SendBatchOptions): Promise<void>

Paraméterek

batch

EventData[] | AmqpAnnotatedMessage[]

EventData vagy AmqpAnnotatedMessage.

options
SendBatchOptions

Az eseményeknek a társított eseményközpontba való elküldésének módjának befolyásolására megadható lehetőségek készlete.

  • abortSignal : A küldési művelet megszakítására irányuló kérés jelzése.
  • partitionId : A köteg partíciója lesz elküldve. Ha be van állítva, partitionKey nem állítható be.
  • partitionKey : A partíció-hozzárendelés létrehozásához kivonatolt érték. Ha be van állítva, partitionId nem állítható be.

Válaszok

Promise<void>

Ígéret