microsoft/azure-messaging-servicebus-emulator

关于

Azure Service Bus 模拟器 旨在为 Azure Service Bus 提供本地开发体验，使你能够在隔离环境中开发和测试代码，不受云环境干扰。

标签信息

bash
docker pull mcr.microsoft.com/azure-messaging/servicebus-emulator

• latest

相关仓库

更多详情可查看GitHub仓库：https://github.com/Azure/azure-service-bus-emulator-installer

配置

Azure Service Bus 模拟器依赖于 SQL Edge。以下部分说明如何运行 Service Bus 模拟器及进行配置更改。

使用方法

• 若要启动模拟器，需提供要使用的实体配置。将以下配置本地保存为 Config.json：

json
{
  "UserConfig": {
    "Namespaces": [
      {
        "Name": "sbemulatorns",
        "Queues": [
          {
            "Name": "queue.1",
            "Properties": {
              "DeadLetteringOnMessageExpiration": false,
              "DefaultMessageTimeToLive": "PT1H",
              "DuplicateDetectionHistoryTimeWindow": "PT20S",
              "ForwardDeadLetteredMessagesTo": "",
              "ForwardTo": "",
              "LockDuration": "PT1M",
              "MaxDeliveryCount": 10,
              "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": 10,
                  "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": 10,
                  "ForwardDeadLetteredMessagesTo": "",
                  "ForwardTo": "",
                  "RequiresSession": false
                },
                "Rules": [
                  {
                    "Name": "user-prop-filter-1",
                    "Properties": {
                      "FilterType": "Correlation",
                      "CorrelationFilter": {
                        "Properties": {
                          "prop3": "value3"
                        }
                      }
                    }
                  }
                ]
              },
              {
                "Name": "subscription.3",
                "Properties": {
                  "DeadLetteringOnMessageExpiration": false,
                  "DefaultMessageTimeToLive": "PT1H",
                  "LockDuration": "PT1M",
                  "MaxDeliveryCount": 10,
                  "ForwardDeadLetteredMessagesTo": "",
                  "ForwardTo": "",
                  "RequiresSession": false
                }
              }
            ]
          }
        ]
      }
    ],
    "Logging": {
      "Type": "File"
    }
  }
}

• 将以下 YAML 文件保存为 docker-compose.yml，以启动 Service Bus 模拟器容器：

yaml
name: microsoft-azure-servicebus-emulator
services:
  emulator:
    container_name: "servicebus-emulator"
    image: mcr.microsoft.com/azure-messaging/servicebus-emulator:latest
    volumes:
      - "${CONFIG_PATH}:/ServiceBus_Emulator/ConfigFiles/Config.json"
    ports:
      - "5672:5672"
    environment:
      SQL_SERVER: sqledge  
      MSSQL_SA_PASSWORD: ${MSSQL_SA_PASSWORD}
      ACCEPT_EULA: ${ACCEPT_EULA}
    depends_on:
      - sqledge
    networks:
      sb-emulator:
        aliases:
          - "sb-emulator"
  sqledge:
        container_name: "sqledge"
        image: "mcr.microsoft.com/azure-sql-edge:latest"
        networks:
          sb-emulator:
            aliases:
              - "sqledge"
        environment:
          ACCEPT_EULA: ${ACCEPT_EULA}
          MSSQL_SA_PASSWORD: ${MSSQL_SA_PASSWORD}
networks:
  sb-emulator:

• 创建 .env 文件声明 Service Bus 模拟器的环境变量，并确保设置以下所有环境变量：

# docker-compose.yml 中用户定义变量的环境文件

# 1. CONFIG_PATH: Config.json 文件路径
# 示例: CONFIG_PATH="C:\\Config\\Config.json"
CONFIG_PATH="<替换为 Config.json 文件的路径>"

# 2. ACCEPT_EULA: 传入 'Y' 表示接受 Azure SQL Edge 和 Azure Service Bus 模拟器的许可条款。
# Service Bus 模拟器许可协议：https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt
# SQL Edge 许可协议：https://go.microsoft.com/fwlink/?linkid=2139274
ACCEPT_EULA="N"

# 3. MSSQL_SA_PASSWORD 需由用户根据策略填写：https://learn.microsoft.com/zh-cn/sql/relational-databases/security/strong-passwords?view=sql-server-linux-ver16 
MSSQL_SA_PASSWORD: ""

注意事项：

• 向环境变量 "ACCEPT_EULA" 传入值 "Y"，即表示你确认并接受 https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt 和 Azure SQL Edge 的最终用户许可协议 (EULA) 条款。

• 确保 .env 文件与 docker-compose.yaml 文件位于同一目录。

• 设置 MSSQL_SA_PASSWORD 环境变量时，需使用至少 8 个字符的强密码，且符合 密码要求。

• 在 Windows 中指定文件路径时，需使用双反斜杠 (\\) 代替单反斜杠 (\)，以避免转义字符问题。

启动模拟器命令

bash
docker compose -f <DockerCompose文件路径> up -d

与模拟器交互

使用以下连接字符串与模拟器交互：

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

有关不同场景下连接字符串的变体，可参考 文档。

你也可参考 https://github.com/Azure/azure-service-bus-emulator-installer/tree/main/ServiceBus-Emulator/Scripts 中的自动化脚本运行模拟器。

支持

模拟器不提供官方支持。任何问题或建议请通过 https://github.com/Azure/azure-service-bus-emulator-installer/issues 的 GitHub issues 报告。

反馈

提供反馈请使用以下链接 反馈。

许可

• 微软容器***声明：容器许可信息
• Azure Service Bus 模拟器：https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt
• Azure SQL Edge Developer Edition：许可协议
  • SQL Edge 提供 Developer 和 Premium 版本，Service Bus 模拟器依赖于 Developer 版本，该版本授权用于开发和测试系统，不得用于生产环境。