@azure/event-hubs 5.13.0-alpha.20250107.2 → 5.13.0-alpha.20250114.1

package/README.md

@@ -1,13 +1,14 @@
 # Azure Event Hubs client library for JavaScript
 
-Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers. This lets you process and analyze the massive amounts of data produced by your connected devices and applications. If you would like to know more about Azure Event Hubs, you may wish to review: [What is Event Hubs](https://docs.microsoft.com/azure/event-hubs/event-hubs-about)?
+Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers. This lets you process and analyze the massive amounts of data produced by your connected devices and applications. If you would like to know more about Azure Event Hubs, you may wish to review: [What is Event Hubs](https://learn.microsoft.com/azure/event-hubs/event-hubs-about)?
 
 The Azure Event Hubs client library allows you to send and receive events in your Node.js application.
 
 Key links:
+
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventhub/event-hubs)
 - [Package (npm)](https://www.npmjs.com/package/@azure/event-hubs)
-- [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/event-hubs)
+- [API Reference Documentation](https://learn.microsoft.com/javascript/api/@azure/event-hubs)
 - [Product documentation](https://azure.microsoft.com/services/event-hubs/)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventhub/event-hubs/samples)
 
@@ -38,7 +39,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
 ### Prerequisites
 
 - An [Azure subscription](https://azure.microsoft.com/free/)
-- An [Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/)
+- An [Event Hubs Namespace](https://learn.microsoft.com/azure/event-hubs/)
 
 #### Configure TypeScript
 
@@ -141,18 +142,18 @@ Please consult the documentation of your favorite bundler for more information o
 
 ### React Native Support
 
-Similar to browsers, React Native does not support some JavaScript API used by this SDK library so you need to provide polyfills for them.  Please see the [Messaging React Native sample with Expo](https://github.com/Azure/azure-sdk-for-js/blob/main/samples/frameworks/react-native-expo/ts/messaging/README.md) for more details.
+Similar to browsers, React Native does not support some JavaScript API used by this SDK library so you need to provide polyfills for them. Please see the [Messaging React Native sample with Expo](https://github.com/Azure/azure-sdk-for-js/blob/main/samples/frameworks/react-native-expo/ts/messaging/README.md) for more details.
 
 ### Authenticate the client
 
 Interaction with Event Hubs starts with either an instance of the
-[EventHubConsumerClient](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventhubconsumerclient) class
-or an instance of the [EventHubProducerClient](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventhubproducerclient) class.
+[EventHubConsumerClient](https://learn.microsoft.com/javascript/api/@azure/event-hubs/eventhubconsumerclient) class
+or an instance of the [EventHubProducerClient](https://learn.microsoft.com/javascript/api/@azure/event-hubs/eventhubproducerclient) class.
 There are constructor overloads to support different ways of instantiating these classes as shown below:
 
 #### Use connection string for the Event Hubs namespace
 
-One of the constructor overloads takes a connection string of the form `Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;` and entity name to your Event Hub instance. You can create a consumer group and get the connection string as well as the entity name from the [Azure portal](https://docs.microsoft.com/azure/event-hubs/event-hubs-get-connection-string#get-connection-string-from-the-portal).
+One of the constructor overloads takes a connection string of the form `Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;` and entity name to your Event Hub instance. You can create a consumer group and get the connection string as well as the entity name from the [Azure portal](https://learn.microsoft.com/azure/event-hubs/event-hubs-get-connection-string#get-connection-string-from-the-portal).
 
 ```javascript
 const { EventHubProducerClient, EventHubConsumerClient } = require("@azure/event-hubs");
@@ -161,7 +162,7 @@ const producerClient = new EventHubProducerClient("my-connection-string", "my-ev
 const consumerClient = new EventHubConsumerClient(
   "my-consumer-group",
   "my-connection-string",
-  "my-event-hub"
+  "my-event-hub",
 );
 ```
 
@@ -177,13 +178,13 @@ const { EventHubProducerClient, EventHubConsumerClient } = require("@azure/event
 const producerClient = new EventHubProducerClient("my-connection-string-with-entity-path");
 const consumerClient = new EventHubConsumerClient(
   "my-consumer-group",
-  "my-connection-string-with-entity-path"
+  "my-connection-string-with-entity-path",
 );
 ```
 
 #### Use the Event Hubs namespace and Azure Identity
 
-This constructor overload takes the host name and entity name of your Event Hub instance and credential that implements the TokenCredential interface. This allows you to authenticate using an Azure Active Directory principal. There are implementations of the `TokenCredential` interface available in the [@azure/identity](https://www.npmjs.com/package/@azure/identity) package. The host name is of the format `<yournamespace>.servicebus.windows.net`. When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs, please refer to [the associated documentation](https://docs.microsoft.com/azure/event-hubs/authorize-access-azure-active-directory).
+This constructor overload takes the host name and entity name of your Event Hub instance and credential that implements the TokenCredential interface. This allows you to authenticate using an Azure Active Directory principal. There are implementations of the `TokenCredential` interface available in the [@azure/identity](https://www.npmjs.com/package/@azure/identity) package. The host name is of the format `<yournamespace>.servicebus.windows.net`. When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs, please refer to [the associated documentation](https://learn.microsoft.com/azure/event-hubs/authorize-access-azure-active-directory).
 
 ```javascript
 const { EventHubProducerClient, EventHubConsumerClient } = require("@azure/event-hubs");
@@ -195,7 +196,7 @@ const consumerClient = new EventHubConsumerClient(
   "my-consumer-group",
   "my-host-name",
   "my-event-hub",
-  credential
+  credential,
 );
 ```
 
@@ -209,7 +210,7 @@ const consumerClient = new EventHubConsumerClient(
 
 - A **consumer group** is a view of an entire Event Hub. Consumer groups enable multiple consuming applications to each have a separate view of the event stream, and to read the stream independently at their own pace and from their own position. There can be at most 5 concurrent readers on a partition per consumer group; however it is recommended that there is only one active consumer for a given partition and consumer group pairing. Each active reader receives all of the events from its partition; If there are multiple readers on the same partition, then they will receive duplicate events.
 
-For more concepts and deeper discussion, see: [Event Hubs Features](https://docs.microsoft.com/azure/event-hubs/event-hubs-features)
+For more concepts and deeper discussion, see: [Event Hubs Features](https://learn.microsoft.com/azure/event-hubs/event-hubs-features)
 
 ### Guidance around retries
 
@@ -280,10 +281,10 @@ In order to publish events, you'll need to create an `EventHubProducerClient`. W
 
 You may publish events to a specific partition, or allow the Event Hubs service to decide which partition events should be published to. It is recommended to use automatic routing when the publishing of events needs to be highly available or when event data should be distributed evenly among the partitions. In the example below, we will take advantage of automatic routing.
 
-- Create an `EventDataBatch` object using the [createBatch](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventhubproducerclient#createbatch-createbatchoptions-)
-- Add events to the batch using the [tryAdd](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventdatabatch#tryadd-eventdata--tryaddoptions-)
+- Create an `EventDataBatch` object using the [createBatch](https://learn.microsoft.com/javascript/api/@azure/event-hubs/eventhubproducerclient#createbatch-createbatchoptions-)
+- Add events to the batch using the [tryAdd](https://learn.microsoft.com/javascript/api/@azure/event-hubs/eventdatabatch#tryadd-eventdata--tryaddoptions-)
   method. You can do this until the maximum batch size limit is reached or until you are done adding the number of events you liked, whichever comes first. This method would return `false` to indicate that no more events can be added to the batch due to the max batch size being reached.
-- Send the batch of events using the [sendBatch](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventhubproducerclient#sendbatch-eventdatabatch--sendbatchoptions-) method.
+- Send the batch of events using the [sendBatch](https://learn.microsoft.com/javascript/api/@azure/event-hubs/eventhubproducerclient#sendbatch-eventdatabatch--sendbatchoptions-) method.
 
 In the below example, we attempt to send 10 events to Azure Event Hubs.
 
@@ -325,7 +326,7 @@ For example: `body: { "message": "Hello World" }`
 ### Consume events from an Event Hub
 
 To consume events from an Event Hub instance, you also need to know which consumer group you want to target.
-Once you know this, you are ready to create an [EventHubConsumerClient](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventhubconsumerclient). While the below example shows one way to create the client, see the
+Once you know this, you are ready to create an [EventHubConsumerClient](https://learn.microsoft.com/javascript/api/@azure/event-hubs/eventhubconsumerclient). While the below example shows one way to create the client, see the
 [Authenticate the client](#authenticate-the-client) section to learn other ways to instantiate the client.
 
 The `subscribe` method on the client has overloads which, combined with the constructor, can cater to several
@@ -352,13 +353,13 @@ async function main() {
   const client = new EventHubConsumerClient(
     "my-consumer-group",
     "connectionString",
-    "eventHubName"
+    "eventHubName",
   );
 
   // In this sample, we use the position of earliest available event to start from
   // Other common options to configure would be `maxBatchSize` and `maxWaitTimeInSeconds`
   const subscriptionOptions = {
-    startPosition: earliestEventPosition
+    startPosition: earliestEventPosition,
   };
 
   const subscription = client.subscribe(
@@ -368,9 +369,9 @@ async function main() {
       },
       processError: async (err, context) => {
         // error reporting/handling code here
-      }
+      },
     },
-    subscriptionOptions
+    subscriptionOptions,
   );
 
   // Wait for a few seconds to receive events before closing
@@ -424,7 +425,7 @@ async function main() {
     consumerGroup,
     eventHubConnectionString,
     eventHubName,
-    checkpointStore
+    checkpointStore,
   );
 
   const subscription = consumerClient.subscribe({
@@ -447,7 +448,7 @@ async function main() {
       // handle any errors that occur during the course of
       // this subscription
       console.log(`Errors in subscription to partition ${context.partitionId}: ${err}`);
-    }
+    },
   });
 
   // Wait for a few seconds to receive events before closing
@@ -461,7 +462,7 @@ async function main() {
 main();
 ```
 
-Please see [Balance partition load across multiple instances of your application](https://docs.microsoft.com/azure/event-hubs/event-processor-balance-partition-load)
+Please see [Balance partition load across multiple instances of your application](https://learn.microsoft.com/azure/event-hubs/event-processor-balance-partition-load)
 to learn more.
 
 #### Consume events from a single partition
@@ -481,14 +482,14 @@ async function main() {
   const client = new EventHubConsumerClient(
     "my-consumer-group",
     "connectionString",
-    "eventHubName"
+    "eventHubName",
   );
   const partitionIds = await client.getPartitionIds();
 
   // In this sample, we use the position of earliest available event to start from
   // Other common options to configure would be `maxBatchSize` and `maxWaitTimeInSeconds`
   const subscriptionOptions = {
-    startPosition: earliestEventPosition
+    startPosition: earliestEventPosition,
   };
 
   const subscription = client.subscribe(
@@ -499,9 +500,9 @@ async function main() {
       },
       processError: async (err, context) => {
         // error reporting/handling code here
-      }
+      },
     },
-    subscriptionOptions
+    subscriptionOptions,
   );
 
   // Wait for a few seconds to receive events before closing
@@ -522,7 +523,7 @@ The associated connection string will not have send claims,
 hence sending events is not possible.
 
 - Please notice that the connection string needs to be for an
-  [Event Hub-compatible endpoint](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin)
+  [Event Hub-compatible endpoint](https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin)
   (e.g. "Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name")
 
 ```javascript
@@ -531,7 +532,7 @@ const { EventHubConsumerClient } = require("@azure/event-hubs");
 async function main() {
   const client = new EventHubConsumerClient(
     "my-consumer-group",
-    "Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name"
+    "Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name",
   );
   await client.getEventHubProperties();
   // retrieve partitionIds from client.getEventHubProperties() or client.getPartitionIds()
@@ -598,7 +599,7 @@ export DEBUG=azure:*:(error|warning),rhea-promise:error,rhea:events,rhea:frames,
 
 Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/eventhub/event-hubs/samples)
 directory for detailed examples of how to use this library to send and receive events to/from
-[Event Hubs](https://docs.microsoft.com/azure/event-hubs/event-hubs-about).
+[Event Hubs](https://learn.microsoft.com/azure/event-hubs/event-hubs-about).
 
 ## Contributing
 

package/dist/commonjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.48.1"
+      "packageVersion": "7.49.1"
     }
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@azure/event-hubs",
   "sdk-type": "client",
-  "version": "5.13.0-alpha.20250107.2",
+  "version": "5.13.0-alpha.20250114.1",
   "description": "Azure Event Hubs SDK for JS.",
   "author": "Microsoft Corporation",
   "license": "MIT",
@@ -83,7 +83,7 @@
       "azure-event-hubs"
     ],
     "requiredResources": {
-      "Azure Event Hub": "https://docs.microsoft.com/azure/event-hubs/event-hubs-create"
+      "Azure Event Hub": "https://learn.microsoft.com/azure/event-hubs/event-hubs-create"
     }
   },
   "tshy": {