Testa lokalt med hjälp av Azure Service Bus-emulatorn

2025-08-26

Den här artikeln sammanfattar stegen för att utveckla och testa lokalt med hjälp av Azure Service Bus-emulatorn.

Förutsättningar

Docker Desktop
Minimikrav för maskinvara:
- 2 GB RAM-minne
- 5 GB diskutrymme
konfiguration av Windows-undersystem för Linux (WSL) (endast för Windows):
- Installera WSL
- Konfigurera Docker att använda WSL

Kommentar

Innan du fortsätter med stegen i den här artikeln kontrollerar du att Docker Desktop fungerar i bakgrunden.

Kör emulatorn

Om du vill köra Service Bus-emulatorn kan du använda ett automatiserat skript eller en Linux-container:

Automatiserat skript
Docker (Linux-container)

Innan du kör ett automatiserat skript klonar du emulatorns GitHub-installationsplats lokalt.

Windows

Använd följande steg för att köra Service Bus-emulatorn lokalt i Windows:

Öppna PowerShell och navigera till katalogen där den gemensamma skriptmappen klonas med hjälp av cd:
```
cd <path to your common scripts folder> # Update this path
```
Utfärda wsl-kommandot för att öppna WSL i den här katalogen.
```
wsl
```
Kör installationsskriptet./LaunchEmulator.sh. När skriptet körs skapas två containrar: Service Bus-emulatorn och SQL Server Linux (ett beroende för emulatorn).
```
./Launchemulator.sh 
```

Linux och macOS

Så här kör du Service Bus-emulatorn lokalt i Linux eller macOS:

Kör installationsskriptet LaunchEmulator.sh. När skriptet körs skapas två containrar: Service Bus-emulatorn och SQL Server Linux (ett beroende för emulatorn).

Om du vill starta emulatorn anger du en konfiguration för de entiteter som du vill använda. Spara följande JSON-fil lokalt som config.json:

  {
 "UserConfig": {
   "Namespaces": [
     {
       "Name": "sbemulatorns",
       "Queues": [
         {
           "Name": "queue.1",
           "Properties": {
             "DeadLetteringOnMessageExpiration": false,
             "DefaultMessageTimeToLive": "PT1H",
             "DuplicateDetectionHistoryTimeWindow": "PT20S",
             "ForwardDeadLetteredMessagesTo": "",
             "ForwardTo": "",
             "LockDuration": "PT1M",
             "MaxDeliveryCount": 3,
             "RequiresDuplicateDetection": false,
             "RequiresSession": false
           }
         }
       ],

       "Topics": [
         {
           "Name": "topic.1",
           "Properties": {
             "DefaultMessageTimeToLive": "PT1H",
             "DuplicateDetectionHistoryTimeWindow": "PT20S",
             "RequiresDuplicateDetection": false
           },
           "Subscriptions": [
             {
               "Name": "subscription.1",
               "Properties": {
                 "DeadLetteringOnMessageExpiration": false,
                 "DefaultMessageTimeToLive": "PT1H",
                 "LockDuration": "PT1M",
                 "MaxDeliveryCount": 3,
                 "ForwardDeadLetteredMessagesTo": "",
                 "ForwardTo": "",
                 "RequiresSession": false
               },
               "Rules": [
                 {
                   "Name": "app-prop-filter-1",
                   "Properties": {
                     "FilterType": "Correlation",
                     "CorrelationFilter": {
                    "ContentType": "application/text",
                    "CorrelationId": "id1",
                    "Label": "subject1",
                    "MessageId": "msgid1",
                    "ReplyTo": "someQueue",
                    "ReplyToSessionId": "sessionId",
                    "SessionId": "session1",
                    "To": "xyz"
                  }
                   }
                 }
               ]
             },
             {
               "Name": "subscription.2",
               "Properties": {
                 "DeadLetteringOnMessageExpiration": false,
                 "DefaultMessageTimeToLive": "PT1H",
                 "LockDuration": "PT1M",
                 "MaxDeliveryCount": 3,
                 "ForwardDeadLetteredMessagesTo": "",
                 "ForwardTo": "",
                 "RequiresSession": false
               },
               "Rules": [
                 {
                   "Name": "user-prop-filter-1",
                   "Properties": {
                     "FilterType": "Correlation",
                     "CorrelationFilter": {
                       "Properties": {
                         "prop1": "value1"
                       }
                     }
                   }
                 }
               ]
             },
             {
               "Name": "subscription.3",
               "Properties": {
                 "DeadLetteringOnMessageExpiration": false,
                 "DefaultMessageTimeToLive": "PT1H",
                 "LockDuration": "PT1M",
                 "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'"
                     }
                   }
                 }
               ]
             }
           ]
         }
       ]
     }
   ],
   "Logging": {
     "Type": "File"
   }
 }
}

2.To starta containrar för Service Bus-emulatorn sparar du följande .yaml-fil som docker-compose.yaml

Kommentar

Service Bus-emulatorn använder port 5672 som standard. Om du har anpassat konfigurationen för att använda en annan port uppdaterar du portinställningen i YAML-filen.

name: microsoft-azure-servicebus-emulator
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: mssql
      MSSQL_SA_PASSWORD: "${MSSQL_SA_PASSWORD}"  # Password should be same as what is set for SQL Server Linux 
      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:
      - mssql
    networks:
      sb-emulator:
        aliases:
          - "sb-emulator"
  mssql:
        container_name: "mssql"
        image: "mcr.microsoft.com/mssql/server:2022-latest"
        networks:
          sb-emulator:
            aliases:
              - "mssql"
        environment:
          ACCEPT_EULA: ${ACCEPT_EULA}
          MSSQL_SA_PASSWORD: "${MSSQL_SA_PASSWORD}" # To be filled by user as per policy : https://free.blessedness.top/en-us/sql/relational-databases/security/strong-passwords?view=sql-server-linux-ver16 

networks:
  sb-emulator:

Skapa .env-filen för att deklarera miljövariablerna för Service Bus-emulatorn och se till att alla följande miljövariabler har angetts.

# Environment file for user defined variables in docker-compose.yml

# 1. CONFIG_PATH: Path to Config.json file
# Ex: CONFIG_PATH="C:\\Config\\Config.json"
CONFIG_PATH="<Replace with path to Config.json file>"

# 2. ACCEPT_EULA: Pass 'Y' to accept license terms for SQL Server Linux and Azure Service Bus emulator.
# Service Bus emulator EULA : https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt
# SQL Server Linux EULA : https://go.microsoft.com/fwlink/?LinkId=746388
ACCEPT_EULA="N"

# 3. MSSQL_SA_PASSWORD to be filled by user as per policy
MSSQL_SA_PASSWORD=""

Viktigt!

Genom att skicka värdet "Y" till miljövariabeln "ACCEPT_EULA" bekräftar och godkänner du villkoren i licensavtalet för slutanvändare (EULA) för både Azure Service Bus-emulatorn och SQL Server Linux.
Se till att placera .env-filen i samma katalog till docker-compose.yaml-filen.
Ange MSSQL_SA_PASSWORD miljövariabeln till ett starkt lösenord på minst åtta tecken som uppfyller lösenordskraven.
När du anger filsökvägar i Windows använder du dubbla omvänt snedstreck (\\) i stället för enkla omvänt snedstreck (\) för att undvika problem med escape-tecken.

Kör följande kommando för att köra emulatorn:


    docker compose -f <PathToDockerComposeFile> up -d

När stegen har slutförts kan du hitta containrarna som körs i Docker.

Skärmbild som visar Service Bus-emulatorn som körs i en container.

Interagera med emulatorn

Som standard använder emulatorn config.json konfigurationsfil. Du kan konfigurera entiteter genom att göra ändringar i konfigurationsfilen. Mer information finns i Göra konfigurationsändringar

Du kan använda följande anslutningssträng för att ansluta till Service Bus-emulatorn:

När emulatorcontainern och det interagerande programmet körs internt på den lokala datorn använder du följande anslutningssträng:

"Endpoint=sb://localhost;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

Program (containerbaserade/icke-containerbaserade) på den olika datorn och samma lokala nätverk kan interagera med emulatorn med hjälp av datorns IPv4-adress. Använd följande anslutningssträng:

"Endpoint=sb://192.168.y.z;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

Programcontainrar i samma bryggnätverk kan interagera med emulatorn med hjälp av dess alias eller IP. Följande anslutningssträng förutsätter att namnet på emulatorcontainern är "servicebus-emulator":

"Endpoint=sb://servicebus-emulator;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

Programcontainrar i det olika bryggnätverket kan interagera med emulatorn med hjälp av "host.docker.internal" som värd. Använd följande anslutningssträng:

"Endpoint=sb://host.docker.internal;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;"

Du kan använda de senaste klient-SDK:erna för att interagera med Service Bus-emulatorn på olika programmeringsspråk. Kom igång genom att läsa Service Bus-emulatorexemplen på GitHub.

Översikt över Azure Service Bus-emulatorn

Feedback

Var den här sidan till hjälp?