refactor: Added comment about setting of env variable in Docker file

Prajwal-Microsoft · Prajwal-Microsoft · commit 213303ca9e03 · 2025-10-29T21:56:37.000+05:30
diff --git a/Services/src/esg-ai-doc-analysis/CFS.SK.Sustainability.AI/Services/Queue/AzureStorageQueueService.cs b/Services/src/esg-ai-doc-analysis/CFS.SK.Sustainability.AI/Services/Queue/AzureStorageQueueService.cs
@@ -84,7 +84,7 @@ public static Uri GetQueueUriFromConnectionString(string connectionString, strin
 
         public AzureStorageQueueService(Uri storageQueueUri, ILogger<AzureStorageQueueService> log)
         {
-            DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+            DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
             this._clientBuilder = queueName => new QueueClient(storageQueueUri, credential);
             this._log = log;
         }
diff --git a/Services/src/esg-ai-doc-analysis/CFS.SK.Sustainability.AI/Utils/StorageAccessUtil.cs b/Services/src/esg-ai-doc-analysis/CFS.SK.Sustainability.AI/Utils/StorageAccessUtil.cs
@@ -16,7 +16,7 @@ static public BlobServiceClient GetBlobClientFromConnectionString(string Connect
             var DefaultEndpointSuffix = "core.windows.net";
             var storageAccountName = ConnectionString.Split(';').FirstOrDefault(x => x.Contains("AccountName")).Split('=')[1];
             var storageAccountUri = new Uri($"https://{storageAccountName}.blob.{DefaultEndpointSuffix}");
-            DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+            DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
             return new BlobServiceClient(storageAccountUri, credential);
         }
 
diff --git a/Services/src/kernel-memory/extensions/AzureAIDocIntel/AzureAIDocIntelEngine.cs b/Services/src/kernel-memory/extensions/AzureAIDocIntel/AzureAIDocIntelEngine.cs
@@ -36,7 +36,7 @@ public AzureAIDocIntelEngine(
         switch (config.Auth)
         {
             case AzureAIDocIntelConfig.AuthTypes.AzureIdentity:
-                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
                 this._recognizerClient = new DocumentAnalysisClient(new Uri(config.Endpoint), credential);
                 break;
 
diff --git a/Services/src/kernel-memory/extensions/AzureAISearch/AzureAISearch/AzureAISearchMemory.cs b/Services/src/kernel-memory/extensions/AzureAISearch/AzureAISearch/AzureAISearchMemory.cs
@@ -67,7 +67,7 @@ public AzureAISearchMemory(
         switch (config.Auth)
         {
             case AzureAISearchConfig.AuthTypes.AzureIdentity:
-                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
                 this._adminClient = new SearchIndexClient(
                     new Uri(config.Endpoint),
                     credential,
diff --git a/Services/src/kernel-memory/extensions/AzureBlobs/AzureBlobsStorage.cs b/Services/src/kernel-memory/extensions/AzureBlobs/AzureBlobsStorage.cs
@@ -55,7 +55,7 @@ public AzureBlobsStorage(
             {
                 this.ValidateAccountName(config.Account);
                 var suffix = this.ValidateEndpointSuffix(config.EndpointSuffix);
-                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
                 client = new BlobServiceClient(new Uri($"https://{config.Account}.blob.{suffix}"), credential);
                 break;
             }
diff --git a/Services/src/kernel-memory/extensions/AzureOpenAI/AzureOpenAITextEmbeddingGenerator.cs b/Services/src/kernel-memory/extensions/AzureOpenAI/AzureOpenAITextEmbeddingGenerator.cs
@@ -71,7 +71,7 @@ public AzureOpenAITextEmbeddingGenerator(
         switch (config.Auth)
         {
             case AzureOpenAIConfig.AuthTypes.AzureIdentity:
-                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
                 this._client = new AzureOpenAITextEmbeddingGenerationService(
                     deploymentName: config.Deployment,
                     modelId: config.Deployment,
diff --git a/Services/src/kernel-memory/extensions/AzureOpenAI/AzureOpenAITextGenerator.cs b/Services/src/kernel-memory/extensions/AzureOpenAI/AzureOpenAITextGenerator.cs
@@ -114,7 +114,7 @@ public AzureOpenAITextGenerator(
         switch (config.Auth)
         {
             case AzureOpenAIConfig.AuthTypes.AzureIdentity:
-                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
                 this._client = new OpenAIClient(new Uri(config.Endpoint), credential, options);
                 break;
 
diff --git a/Services/src/kernel-memory/extensions/AzureQueues/AzureQueuesPipeline.cs b/Services/src/kernel-memory/extensions/AzureQueues/AzureQueuesPipeline.cs
@@ -100,7 +100,7 @@ public AzureQueuesPipeline(
 
             case AzureQueuesConfig.AuthTypes.AzureIdentity:
             {
-                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);
+                DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File
                 this.ValidateAccountName(config.Account);
                 var suffix = this.ValidateEndpointSuffix(config.EndpointSuffix);
                 this._clientBuilder = queueName => new QueueClient(new($"https://{config.Account}.queue.{suffix}/{queueName}"), credential);

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public static Uri GetQueueUriFromConnectionString(string connectionString, strin`
`84`	`84`
`85`	`85`	`public AzureStorageQueueService(Uri storageQueueUri, ILogger<AzureStorageQueueService> log)`
`86`	`86`	`{`
`87`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`87`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`88`	`88`	`this._clientBuilder = queueName => new QueueClient(storageQueueUri, credential);`
`89`	`89`	`this._log = log;`
`90`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ static public BlobServiceClient GetBlobClientFromConnectionString(string Connect`
`16`	`16`	`var DefaultEndpointSuffix = "core.windows.net";`
`17`	`17`	`var storageAccountName = ConnectionString.Split(';').FirstOrDefault(x => x.Contains("AccountName")).Split('=')[1];`
`18`	`18`	`var storageAccountUri = new Uri($"https://{storageAccountName}.blob.{DefaultEndpointSuffix}");`
`19`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`19`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`20`	`20`	`return new BlobServiceClient(storageAccountUri, credential);`
`21`	`21`	`}`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public AzureAIDocIntelEngine(`
`36`	`36`	`switch (config.Auth)`
`37`	`37`	`{`
`38`	`38`	`case AzureAIDocIntelConfig.AuthTypes.AzureIdentity:`
`39`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`39`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`40`	`40`	`this._recognizerClient = new DocumentAnalysisClient(new Uri(config.Endpoint), credential);`
`41`	`41`	`break;`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public AzureAISearchMemory(`
`67`	`67`	`switch (config.Auth)`
`68`	`68`	`{`
`69`	`69`	`case AzureAISearchConfig.AuthTypes.AzureIdentity:`
`70`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`70`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`71`	`71`	`this._adminClient = new SearchIndexClient(`
`72`	`72`	`new Uri(config.Endpoint),`
`73`	`73`	`credential,`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public AzureBlobsStorage(`
`55`	`55`	`{`
`56`	`56`	`this.ValidateAccountName(config.Account);`
`57`	`57`	`var suffix = this.ValidateEndpointSuffix(config.EndpointSuffix);`
`58`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`58`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`59`	`59`	`client = new BlobServiceClient(new Uri($"https://{config.Account}.blob.{suffix}"), credential);`
`60`	`60`	`break;`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public AzureOpenAITextEmbeddingGenerator(`
`71`	`71`	`switch (config.Auth)`
`72`	`72`	`{`
`73`	`73`	`case AzureOpenAIConfig.AuthTypes.AzureIdentity:`
`74`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`74`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`75`	`75`	`this._client = new AzureOpenAITextEmbeddingGenerationService(`
`76`	`76`	`deploymentName: config.Deployment,`
`77`	`77`	`modelId: config.Deployment,`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ public AzureOpenAITextGenerator(`
`114`	`114`	`switch (config.Auth)`
`115`	`115`	`{`
`116`	`116`	`case AzureOpenAIConfig.AuthTypes.AzureIdentity:`
`117`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`117`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`118`	`118`	`this._client = new OpenAIClient(new Uri(config.Endpoint), credential, options);`
`119`	`119`	`break;`
`120`	`120`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ public AzureQueuesPipeline(`
`100`	`100`
`101`	`101`	`case AzureQueuesConfig.AuthTypes.AzureIdentity:`
`102`	`102`	`{`
`103`		`- DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName);`
	`103`	`+ DefaultAzureCredential credential = new(DefaultAzureCredential.DefaultEnvironmentVariableName); // CodeQL [SM05137] Environment variable is set in Docker File`
`104`	`104`	`this.ValidateAccountName(config.Account);`
`105`	`105`	`var suffix = this.ValidateEndpointSuffix(config.EndpointSuffix);`
`106`	`106`	`this._clientBuilder = queueName => new QueueClient(new($"https://{config.Account}.queue.{suffix}/{queueName}"), credential);`