standardized Service Bus connection naming across the solution

hardik-desai-nhs · hardik-desai-nhs · commit d729d9216a4e · 2026-04-27T14:53:59.000+01:00
diff --git a/application/CohortManager/compose.cohort-distribution.yaml b/application/CohortManager/compose.cohort-distribution.yaml
@@ -11,7 +11,7 @@ services:
       args:
         BASE_IMAGE: ${FUNCTION_BASE_IMAGE}
     environment:
-      - ServiceBusConnectionString_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
+      - ServiceBusConnectionString_client_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
       - CohortDistributionTopic=cohort-distribution-topic
       - DistributeParticipantSubscription=distribute-participant-sub
       - AzureWebJobsStorage=${AZURITE_CONNECTION_STRING}
diff --git a/application/CohortManager/compose.core.yaml b/application/CohortManager/compose.core.yaml
@@ -109,7 +109,6 @@ services:
       args:
         BASE_IMAGE: ${FUNCTION_BASE_IMAGE}
     environment:
-      - ServiceBusConnectionString_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
       - ServiceBusConnectionString_client_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
       - CohortDistributionTopic=cohort-distribution-topic
       - ParticipantManagementTopic=participant-management-topic
@@ -131,7 +130,6 @@ services:
       - ExceptionFunctionURL=http://create-exception:7070/api/CreateException
       - ServiceNowParticipantManagementTopic=servicenow-participant-management-topic
       - ManageServiceNowParticipantSubscription=manage-servicenow-participant-sub
-      - ServiceBusConnectionString_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
       - ServiceBusConnectionString_client_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
       - RetrievePdsDemographicURL=http://retrieve-pds-demographic:8082/api/RetrievePDSDemographic
       - SendServiceNowMessageURL=http://servicenow-message-handler:9092/api/servicenow/send
@@ -210,7 +208,7 @@ services:
     environment:
       - AzureWebJobsStorage=${AZURITE_CONNECTION_STRING}
       - DtOsDatabaseConnectionString=Server=db,1433;Database=${DB_NAME};User Id=SA;Password=${PASSWORD};TrustServerCertificate=True
-      - ServiceBusConnectionString=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
+      - ServiceBusConnectionString_client_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
       - AuditTopicName=participant-audit-topic
       - AuditSubscription=audit-writer-sub
 
@@ -231,6 +229,7 @@ services:
       - DemographicDataServiceURL=http://participant-demographic-data-service:7993/api/ParticipantDemographicDataService/
       - ExceptionManagementDataServiceURL=http://exception-management-data-service:7911/api/ExceptionManagementDataService/
       - GPPracticeDataServiceURL=http://localhost:7999/api/GPPracticeDataService/
+      - ServiceBusConnectionString_client_internal=Endpoint=sb://service-bus;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SAS_KEY_VALUE;UseDevelopmentEmulator=true;
 
   update-exception:
     container_name: update-exception
diff --git a/application/CohortManager/src/Functions/CohortDistributionServices/DistributeParticipant/DistributeParticipant.cs b/application/CohortManager/src/Functions/CohortDistributionServices/DistributeParticipant/DistributeParticipant.cs
@@ -35,7 +35,7 @@ public DistributeParticipant(ILogger<DistributeParticipant> logger, IOptions<Dis
     /// <returns></returns>
     [Function("DistributeParticipant")]
     public async Task Run(
-   [ServiceBusTrigger(topicName: "%CohortDistributionTopic%", subscriptionName: "%DistributeParticipantSubscription%", Connection = "ServiceBusConnectionString_internal")]
+   [ServiceBusTrigger(topicName: "%CohortDistributionTopic%", subscriptionName: "%DistributeParticipantSubscription%", Connection = "ServiceBusConnectionString_client_internal")]
     string messageBody,
     [DurableClient] DurableTaskClient durableClient,
     FunctionContext functionContext)
diff --git a/application/CohortManager/src/Functions/ExceptionHandling/CreateException/CreateException.cs b/application/CohortManager/src/Functions/ExceptionHandling/CreateException/CreateException.cs
@@ -53,7 +53,7 @@ public async Task<HttpResponseData> RunAsync([HttpTrigger(AuthorizationLevel.Ano
 
     [Function("RunCreateException")]
     public async Task Run(
-      [ServiceBusTrigger(topicName: "%CreateExceptionTopic%", subscriptionName: "%ExceptionSubscription%", Connection = "ServiceBusConnectionString", AutoCompleteMessages = false)]
+      [ServiceBusTrigger(topicName: "%CreateExceptionTopic%", subscriptionName: "%ExceptionSubscription%", Connection = "ServiceBusConnectionString_client_internal", AutoCompleteMessages = false)]
         ServiceBusReceivedMessage message,
        ServiceBusMessageActions messageActions)
     {
diff --git a/application/CohortManager/src/Functions/ExceptionHandling/CreateException/CreateExceptionConfig.cs b/application/CohortManager/src/Functions/ExceptionHandling/CreateException/CreateExceptionConfig.cs
@@ -8,4 +8,6 @@ public class CreateExceptionConfig
     public required string ExceptionManagementDataServiceURL {get; set;}
     [Required]
     public required string DemographicDataServiceURL {get; set;}
+    [Required]
+    public required string ServiceBusConnectionString_client_internal { get; set; }
 }
diff --git a/application/CohortManager/src/Functions/ExceptionHandling/CreateException/Program.cs b/application/CohortManager/src/Functions/ExceptionHandling/CreateException/Program.cs
@@ -13,6 +13,7 @@
     .AddDataService<ExceptionManagement>(config.ExceptionManagementDataServiceURL)
     .AddDataService<ParticipantDemographic>(config.DemographicDataServiceURL)
     .Build()
+    .AddServiceBusClient(config.ServiceBusConnectionString_client_internal)
     .ConfigureFunctionsWebApplication()
     .ConfigureServices(services =>
     {
diff --git a/application/CohortManager/src/Functions/ParticipantManagementServices/ManageParticipant/ManageParticipant.cs b/application/CohortManager/src/Functions/ParticipantManagementServices/ManageParticipant/ManageParticipant.cs
@@ -36,7 +36,7 @@ public ManageParticipant(ILogger<ManageParticipant> logger,
     /// </summary>
     /// <param name="message">json string containing the participant record</param>
     [Function(nameof(ManageParticipant))]
-    public async Task Run([ServiceBusTrigger(topicName: "%ParticipantManagementTopic%", subscriptionName: "%ManageParticipantSubscription%", Connection = "ServiceBusConnectionString_internal")] string message)
+    public async Task Run([ServiceBusTrigger(topicName: "%ParticipantManagementTopic%", subscriptionName: "%ManageParticipantSubscription%", Connection = "ServiceBusConnectionString_client_internal")] string message)
     {
         var participantRecord = JsonSerializer.Deserialize<BasicParticipantCsvRecord>(message)!;
         Participant participant = participantRecord.Participant;
diff --git a/application/CohortManager/src/Functions/ParticipantManagementServices/ManageServiceNowParticipant/ManageServiceNowParticipantFunction.cs b/application/CohortManager/src/Functions/ParticipantManagementServices/ManageServiceNowParticipant/ManageServiceNowParticipantFunction.cs
@@ -46,7 +46,7 @@ public ManageServiceNowParticipantFunction(ILogger<ManageServiceNowParticipantFu
     /// </summary>
     /// <param name="serviceNowParticipant">The participant from ServiceNow</param>
     [Function(nameof(ManageServiceNowParticipantFunction))]
-    public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManagementTopic%", subscriptionName: "%ManageServiceNowParticipantSubscription%", Connection = "ServiceBusConnectionString_internal")] ServiceNowParticipant serviceNowParticipant)
+    public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManagementTopic%", subscriptionName: "%ManageServiceNowParticipantSubscription%", Connection = "ServiceBusConnectionString_client_internal")] ServiceNowParticipant serviceNowParticipant)
     {
         try
         {
diff --git a/application/CohortManager/src/Functions/Shared/Common/ExceptionServiceBusConfig.cs b/application/CohortManager/src/Functions/Shared/Common/ExceptionServiceBusConfig.cs
@@ -5,10 +5,10 @@ namespace Common;
 public class ExceptionServiceBusConfig
 {
     [Required]
-    public required string ServiceBusConnectionString { get; set; }
+    public required string ServiceBusConnectionString_client_internal { get; set; }
 
     [Required]
     public required string CreateExceptionTopic { get; set; }
 
     public bool UseServiceBus { get; set; } = false;
-}
+}
diff --git a/application/CohortManager/src/Functions/Shared/Common/Extensions/ExceptionHandlerServiceExtension.cs b/application/CohortManager/src/Functions/Shared/Common/Extensions/ExceptionHandlerServiceExtension.cs
@@ -19,7 +19,7 @@ public static IHostBuilder AddExceptionHandler(this IHostBuilder hostBuilder)
         if (useServiceBus)
         {
             hostBuilder.AddConfiguration<ExceptionServiceBusConfig>(out ExceptionServiceBusConfig config);
-            hostBuilder.AddKeyedAzureQueues(config.UseServiceBus, config.ServiceBusConnectionString, "Exception");
+            hostBuilder.AddKeyedAzureQueues(config.UseServiceBus, config.ServiceBusConnectionString_client_internal, "Exception");
             return hostBuilder.ConfigureServices(_ =>
             {
                 _.AddSingleton<IExceptionHandler, ExceptionHandler>();

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public async Task<HttpResponseData> RunAsync([HttpTrigger(AuthorizationLevel.Ano`
`53`	`53`
`54`	`54`	`[Function("RunCreateException")]`
`55`	`55`	`public async Task Run(`
`56`		`- [ServiceBusTrigger(topicName: "%CreateExceptionTopic%", subscriptionName: "%ExceptionSubscription%", Connection = "ServiceBusConnectionString", AutoCompleteMessages = false)]`
	`56`	`+ [ServiceBusTrigger(topicName: "%CreateExceptionTopic%", subscriptionName: "%ExceptionSubscription%", Connection = "ServiceBusConnectionString_client_internal", AutoCompleteMessages = false)]`
`57`	`57`	`ServiceBusReceivedMessage message,`
`58`	`58`	`ServiceBusMessageActions messageActions)`
`59`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,6 @@ public class CreateExceptionConfig`
`8`	`8`	`public required string ExceptionManagementDataServiceURL {get; set;}`
`9`	`9`	`[Required]`
`10`	`10`	`public required string DemographicDataServiceURL {get; set;}`
	`11`	`+ [Required]`
	`12`	`+ public required string ServiceBusConnectionString_client_internal { get; set; }`
`11`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`.AddDataService<ExceptionManagement>(config.ExceptionManagementDataServiceURL)`
`14`	`14`	`.AddDataService<ParticipantDemographic>(config.DemographicDataServiceURL)`
`15`	`15`	`.Build()`
	`16`	`+ .AddServiceBusClient(config.ServiceBusConnectionString_client_internal)`
`16`	`17`	`.ConfigureFunctionsWebApplication()`
`17`	`18`	`.ConfigureServices(services =>`
`18`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public ManageParticipant(ILogger<ManageParticipant> logger,`
`36`	`36`	`/// </summary>`
`37`	`37`	`/// <param name="message">json string containing the participant record</param>`
`38`	`38`	`[Function(nameof(ManageParticipant))]`
`39`		`- public async Task Run([ServiceBusTrigger(topicName: "%ParticipantManagementTopic%", subscriptionName: "%ManageParticipantSubscription%", Connection = "ServiceBusConnectionString_internal")] string message)`
	`39`	`+ public async Task Run([ServiceBusTrigger(topicName: "%ParticipantManagementTopic%", subscriptionName: "%ManageParticipantSubscription%", Connection = "ServiceBusConnectionString_client_internal")] string message)`
`40`	`40`	`{`
`41`	`41`	`var participantRecord = JsonSerializer.Deserialize<BasicParticipantCsvRecord>(message)!;`
`42`	`42`	`Participant participant = participantRecord.Participant;`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public ManageServiceNowParticipantFunction(ILogger<ManageServiceNowParticipantFu`
`46`	`46`	`/// </summary>`
`47`	`47`	`/// <param name="serviceNowParticipant">The participant from ServiceNow</param>`
`48`	`48`	`[Function(nameof(ManageServiceNowParticipantFunction))]`
`49`		`- public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManagementTopic%", subscriptionName: "%ManageServiceNowParticipantSubscription%", Connection = "ServiceBusConnectionString_internal")] ServiceNowParticipant serviceNowParticipant)`
	`49`	`+ public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManagementTopic%", subscriptionName: "%ManageServiceNowParticipantSubscription%", Connection = "ServiceBusConnectionString_client_internal")] ServiceNowParticipant serviceNowParticipant)`
`50`	`50`	`{`
`51`	`51`	`try`
`52`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public static IHostBuilder AddExceptionHandler(this IHostBuilder hostBuilder)`
`19`	`19`	`if (useServiceBus)`
`20`	`20`	`{`
`21`	`21`	`hostBuilder.AddConfiguration<ExceptionServiceBusConfig>(out ExceptionServiceBusConfig config);`
`22`		`- hostBuilder.AddKeyedAzureQueues(config.UseServiceBus, config.ServiceBusConnectionString, "Exception");`
	`22`	`+ hostBuilder.AddKeyedAzureQueues(config.UseServiceBus, config.ServiceBusConnectionString_client_internal, "Exception");`
`23`	`23`	`return hostBuilder.ConfigureServices(_ =>`
`24`	`24`	`{`
`25`	`25`	`_.AddSingleton<IExceptionHandler, ExceptionHandler>();`