Merge pull request #295275 from Saglodha/Emulator-freshchanges

JillGrant615 · web-flow · commit e96720b72b5f · 2025-03-11T09:31:25.000-06:00
Update event-hubs-emulator-whats-new.md
diff --git a/articles/event-hubs/event-hubs-emulator-whats-new.md b/articles/event-hubs/event-hubs-emulator-whats-new.md
@@ -19,15 +19,20 @@ This article provides a detailed overview of the enhancements introduced in the
 > Kindly report any problems or suggestions in the emulator's [GitHub installer repository](https://github.com/Azure/azure-event-hubs-emulator-installer/issues).
 
 
-## Latest version ``2.0.1``
+## Latest version ``2.1.0``
 
-> *Released November 19th, 2024*
+> *Released March 11th, 2025*
 
-This release introduces Apache Kafka support in Event Hubs emulator. 
-- The producer and consumer APIs are now compatible with the Event Hubs emulator.
+This release introduces health check API in Event Hubs emulator. 
+- Health check API can be accessed at *http://localhost:5300/health*
 
 ## Previous releases
 
+### ``2.0.1`` (November 19th,2024)
+
+This release introduces Apache Kafka support in Event Hubs emulator. 
+- The producer and consumer APIs are now compatible with the Event Hubs emulator.
+
 ### ``1.2.4`` (July 1st,2024)
 
 This release provides enhanced connectivity fixes for Emulator. 
diff --git a/articles/event-hubs/test-locally-with-event-hub-emulator.md b/articles/event-hubs/test-locally-with-event-hub-emulator.md
@@ -33,13 +33,20 @@ Before you run an automated script, clone the emulator's [GitHub installer repos
 
 ### Windows
 
-Use the following steps to run the Event Hubs emulator locally on Windows:
-
-1. Allow the execution of unsigned scripts by running this command in the PowerShell window:
-
-   `$>Start-Process powershell -Verb RunAs -ArgumentList 'Set-ExecutionPolicy Bypass –Scope CurrentUser'`
-
-1. Run the setup script *LaunchEmulator.ps1*. Running the script brings up two containers: the Event Hubs emulator and Azurite (a dependency for the emulator).
+Use the following steps to run the Event Hubs emulator locally on Windows.
+
+1. **Open PowerShell** and navigate to the directory where the [common](https://github.com/Azure/azure-event-hubs-emulator-installer/tree/main/EventHub-Emulator/Scripts/Common) scripts folder is cloned using `cd`:
+   ```powershell
+   cd <path to your common scripts folder> # Update this path
+      
+2. Issue wsl command to open WSL at this directory.
+   ```powershell
+   wsl
+
+3. **Run the setup script** *./LaunchEmulator.sh* Running the script brings up two containers: the Event Hubs emulator and Azurite (a dependency for the emulator).
+   ```bash
+   ./Launchemulator.sh
+ 
 
 ### Linux and macOS
 
@@ -81,41 +88,45 @@ To run the Event Hubs emulator locally on Linux or macOS:
 
 2. To spin up containers for Event Hubs emulator, Save the following .yaml file as *docker-compose.yaml*.
 
-   ```
-   name: microsoft-azure-eventhubs
-   services:
-     emulator:
-       container_name: "eventhubs-emulator"
-       image: "mcr.microsoft.com/azure-messaging/eventhubs-emulator:latest"
-       volumes:
-         - "${CONFIG_PATH}:/Eventhubs_Emulator/ConfigFiles/Config.json"
-       ports:
-         - "5672:5672"
-         - "9092:9092"
-       environment:
-         BLOB_SERVER: azurite
-         METADATA_SERVER: azurite
-         ACCEPT_EULA: ${ACCEPT_EULA}
-       depends_on:
-         - azurite
-       networks:
-         eh-emulator:
-           aliases:
-             - "eventhubs-emulator"
-     azurite:
-       container_name: "azurite"
-       image: "mcr.microsoft.com/azure-storage/azurite:latest"
-       ports:
-         - "10000:10000"
-         - "10001:10001"
-         - "10002:10002"
-       networks:
-         eh-emulator:
-           aliases:
-             - "azurite"
-   networks:
-     eh-emulator:
-   ```
+  ```
+  name: microsoft-azure-eventhubs
+  services:
+  emulator:
+    container_name: "eventhubs-emulator"
+    image: "mcr.microsoft.com/azure-messaging/eventhubs-emulator:latest"
+    pull_policy: always
+    volumes:
+      - "${CONFIG_PATH}:/Eventhubs_Emulator/ConfigFiles/Config.json"
+    ports:
+      - "5672:5672"
+      - "9092:9092"
+      - "5300:5300" 
+    environment:
+      BLOB_SERVER: azurite
+      METADATA_SERVER: azurite
+      ACCEPT_EULA: ${ACCEPT_EULA}
+    depends_on:
+      - azurite
+    networks:
+      eh-emulator:
+        aliases:
+          - "eventhubs-emulator"
+  azurite:
+    container_name: "azurite"
+    image: "mcr.microsoft.com/azure-storage/azurite:latest"
+    pull_policy: always
+    ports:
+      - "10000:10000"
+      - "10001:10001"
+      - "10002:10002"
+    networks:
+      eh-emulator:
+        aliases:
+          - "azurite"
+networks:
+  eh-emulator:
+
+```
 
 3. Create an .env file to declare the environment variables for the Event Hubs emulator:
 
diff --git a/articles/service-bus-messaging/overview-emulator.md b/articles/service-bus-messaging/overview-emulator.md
@@ -73,13 +73,17 @@ Like the Service bus cloud service, the emulator provides the following quotas f
 | Number of entities(queues/topics) in a namespace| 50| Yes
 | Number of Subscriptions per topic | 50 | Yes
 | Number of correlation filters per topic | 1000 | Yes 
+| Number of SQL Filters | 20 | Yes
+| Length of filter condition or rule action string | 1024 | Yes
+| Number of expressions per rule action | 32 | Yes  
 | Number of concurrent connections to namespace| 10 |Yes
 | Number of concurrent receive requests on entity (queue/Topic) or subscription entity | 200 |Yes
 | Message size  | 256 KB |No
 | Queue or topic size  | 100 MB | No
 | Message Time to Live | 1hr | Yes
 
 
+
 ## Quota configuration changes
 
 By default, the emulator runs with the [config.json](https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/ServiceBus-Emulator/Config/Config.json) configuration file. You can configure the quotas associated with Service bus by editing this file in the following ways, based on your needs:
diff --git a/articles/service-bus-messaging/service-bus-emulator-whats-new.md b/articles/service-bus-messaging/service-bus-emulator-whats-new.md
@@ -18,6 +18,19 @@ This article provides a detailed overview of the enhancements introduced in the
 >
 > Kindly report any problems or suggestions in the emulator's [GitHub installer repository](https://github.com/Azure/azure-service-bus-emulator-installer/issues).
 
+## Latest version ``1.1.2``
+
+> *Released March 11th, 2025*
+
+This release introduces new features, bug fixes for Service Bus emulator. The details are as follows:
+
+- SQL Actions and Filters are now compatible with Service bus emulator.
+- Provides Health check API in Service Bus emulator. It can be accessed at *http://localhost:5300/health*
+- Provides user configurable health check interval for SQL.
+- Added support for updating LockDuration to a minimum of 5 seconds.
+- Other bug fixes.
+
+## Previous releases
 
 ### ``1.0.1`` (19th November,2024)
 
diff --git a/articles/service-bus-messaging/test-locally-with-service-bus-emulator.md b/articles/service-bus-messaging/test-locally-with-service-bus-emulator.md
@@ -35,11 +35,17 @@ Before you run an automated script, clone the emulator's [GitHub installer repos
 
 Use the following steps to run the Service Bus emulator locally on Windows:
 
-1. Allow the execution of unsigned scripts by running this command in the PowerShell window:
-
-   `$>Start-Process powershell -Verb RunAs -ArgumentList 'Set-ExecutionPolicy Bypass –Scope CurrentUser'`
-
-1. Run the setup script [LaunchEmulator.ps1](https://github.com/Azure/azure-service-bus-emulator-installer/tree/main/ServiceBus-Emulator/Scripts/Windows). Running the script brings up two containers: the Service Bus emulator and Sql Edge (a dependency for the emulator).
+1. **Open PowerShell** and navigate to the directory where the [common](https://github.com/Azure/azure-service-bus-emulator-installer/tree/main/ServiceBus-Emulator/Scripts/Common) scripts folder is cloned using `cd`:
+   ```powershell
+   cd <path to your common scripts folder> # Update this path
+      
+2. Issue wsl command to open WSL at this directory.
+   ```powershell
+   wsl
+
+3. **Run the setup script** *./LaunchEmulator.sh*.Running the script brings up two containers: the Service Bus emulator and Sql Edge (a dependency for the emulator).
+   ```bash
+   ./Launchemulator.sh 
 
 ### Linux and macOS
 
@@ -51,9 +57,10 @@ To run the Service Bus emulator locally on Linux or macOS:
 
 1. To start the emulator, supply a configuration for the entities that you want to use. Save the following JSON file locally as _config.json_:
 
-   ```JSON
+
+ ```JSON
    {
-   "UserConfig": {
+  "UserConfig": {
     "Namespaces": [
       {
         "Name": "sbemulatorns",
@@ -67,7 +74,7 @@ To run the Service Bus emulator locally on Linux or macOS:
               "ForwardDeadLetteredMessagesTo": "",
               "ForwardTo": "",
               "LockDuration": "PT1M",
-              "MaxDeliveryCount": 10,
+              "MaxDeliveryCount": 3,
               "RequiresDuplicateDetection": false,
               "RequiresSession": false
             }
@@ -89,7 +96,7 @@ To run the Service Bus emulator locally on Linux or macOS:
                   "DeadLetteringOnMessageExpiration": false,
                   "DefaultMessageTimeToLive": "PT1H",
                   "LockDuration": "PT1M",
-                  "MaxDeliveryCount": 10,
+                  "MaxDeliveryCount": 3,
                   "ForwardDeadLetteredMessagesTo": "",
                   "ForwardTo": "",
                   "RequiresSession": false
@@ -100,15 +107,15 @@ To run the Service Bus emulator locally on Linux or macOS:
                     "Properties": {
                       "FilterType": "Correlation",
                       "CorrelationFilter": {
-                        "ContentType": "application/text",
-                        "CorrelationId": "id1",
-                        "Label": "subject1",
-                        "MessageId": "msgid1",
-                        "ReplyTo": "someQueue",
-                        "ReplyToSessionId": "sessionId",
-                        "SessionId": "session1",
-                        "To": "xyz"
-                      }
+                     "ContentType": "application/text",
+                     "CorrelationId": "id1",
+                     "Label": "subject1",
+                     "MessageId": "msgid1",
+                     "ReplyTo": "someQueue",
+                     "ReplyToSessionId": "sessionId",
+                     "SessionId": "session1",
+                     "To": "xyz"
+                   }
                     }
                   }
                 ]
@@ -119,7 +126,7 @@ To run the Service Bus emulator locally on Linux or macOS:
                   "DeadLetteringOnMessageExpiration": false,
                   "DefaultMessageTimeToLive": "PT1H",
                   "LockDuration": "PT1M",
-                  "MaxDeliveryCount": 10,
+                  "MaxDeliveryCount": 3,
                   "ForwardDeadLetteredMessagesTo": "",
                   "ForwardTo": "",
                   "RequiresSession": false
@@ -131,7 +138,7 @@ To run the Service Bus emulator locally on Linux or macOS:
                       "FilterType": "Correlation",
                       "CorrelationFilter": {
                         "Properties": {
-                          "prop3": "value3"
+                          "prop1": "value1"
                         }
                       }
                     }
@@ -144,11 +151,37 @@ To run the Service Bus emulator locally on Linux or macOS:
                   "DeadLetteringOnMessageExpiration": false,
                   "DefaultMessageTimeToLive": "PT1H",
                   "LockDuration": "PT1M",
-                  "MaxDeliveryCount": 10,
+                  "MaxDeliveryCount": 3,
                   "ForwardDeadLetteredMessagesTo": "",
                   "ForwardTo": "",
                   "RequiresSession": false
                 }
+              },
+              {
+                "Name": "subscription.4",
+                "Properties": {
+                  "DeadLetteringOnMessageExpiration": false,
+                  "DefaultMessageTimeToLive": "PT1H",
+                  "LockDuration": "PT1M",
+                  "MaxDeliveryCount": 3,
+                  "ForwardDeadLetteredMessagesTo": "",
+                  "ForwardTo": "",
+                  "RequiresSession": false
+                },
+                "Rules": [
+                  {
+                    "Name": "sql-filter-1",
+                    "Properties": {
+                      "FilterType": "Sql",
+                      "SqlFilter": {
+                        "SqlExpression": "sys.MessageId = '123456' AND userProp1 = 'value1'"
+                      },
+                      "Action" : {
+                        "SqlExpression": "SET sys.To = 'Entity'"
+                      }
+                    }
+                  }
+                ]
               }
             ]
           }
@@ -158,10 +191,9 @@ To run the Service Bus emulator locally on Linux or macOS:
     "Logging": {
       "Type": "File"
     }
-   }
-   }
-
-   ```
+  }
+}
+```
 
 2.To spin up containers for Service Bus emulator, save the following .yaml file as _docker-compose.yaml_
 
@@ -174,14 +206,17 @@ services:
   emulator:
     container_name: "servicebus-emulator"
     image: mcr.microsoft.com/azure-messaging/servicebus-emulator:latest
+    pull_policy: always
     volumes:
       - "${CONFIG_PATH}:/ServiceBus_Emulator/ConfigFiles/Config.json"
     ports:
       - "5672:5672"
+      - "5300:5300"
     environment:
-      SQL_SERVER: sqledge  
-      MSSQL_SA_PASSWORD: ${MSSQL_SA_PASSWORD}
+      SQL_SERVER: sqledge
+      MSSQL_SA_PASSWORD: "${SQL_PASSWORD}"  # Password should be same as what is set for SQL Edge  
       ACCEPT_EULA: ${ACCEPT_EULA}
+      SQL_WAIT_INTERVAL: ${SQL_WAIT_INTERVAL} # Optional: Time in seconds to wait for SQL to be ready (default is 15 seconds)
     depends_on:
       - sqledge
     networks:
@@ -197,9 +232,11 @@ services:
               - "sqledge"
         environment:
           ACCEPT_EULA: ${ACCEPT_EULA}
-          MSSQL_SA_PASSWORD: ${MSSQL_SA_PASSWORD}
+          MSSQL_SA_PASSWORD: "${SQL_PASSWORD}" # To be filled by user as per policy : https://learn.microsoft.com/en-us/sql/relational-databases/security/strong-passwords?view=sql-server-linux-ver16 
+
 networks:
   sb-emulator:
+
 ```
 
 3. Create .env file to declare the environment variables for Service Bus emulator and ensure all of the following environment variables are set.
