Merge pull request #21 from microsoft/psl-dkm-us-11110

Implemented the validation for required fields

Author: pradeepjha-microsoft

Deployment/resourcedeployment.ps1

@@ -41,6 +41,35 @@ function successBanner(){
     Write-Host "             |_|            |___/                          "     
 }
 
+function failureBanner(){
+    Write-Host " _____             _                                  _     "
+    Write-Host "|  __ \           | |                                | |    "
+    Write-Host "| |  | | ___ _ __ | | ___  _   _ _ __ ___   ___ _ __ | |_   "
+    Write-Host "| |  | |/ _ \ '_ \| |/ _ \| | | | '_ ` _ \ / _ \ '_ \| __|  "
+    Write-Host "| |__| |  __/ |_) | | (_) | |_| | | | | | |  __/ | | | |_   "
+    Write-Host "|_____/ \___| .__/|_|\___/ \__, |_| |_| |_|\___|_| |_|\__|  "
+    Write-Host "            | |             __/ |                           "
+    Write-Host " ______    _|_|         _  |___/                            "
+    Write-Host "|  ____|  (_) |        | |                                  "
+    Write-Host "| |__ __ _ _| | ___  __| |                                  "
+    Write-Host "|  __/ _` | | |/ _ \/ _` |                                  "
+    Write-Host "| | | (_| | | |  __/ (_| |                                  "
+    Write-Host "|_|  \__,_|_|_|\___|\__,_|                                  "
+}
+
+# Common function to check if a variable is null or empty
+function ValidateVariableIsNullOrEmpty {
+    param (
+        [string]$variableValue, 
+        [string]$variableName
+    )
+ 
+    if ([string]::IsNullOrEmpty($variableValue)) {
+        Write-Host "Error: $variableName is null or empty." -ForegroundColor Red
+        failureBanner 
+        exit 1
+    }    
+}
 # Function to prompt for parameters with kind messages
 function PromptForParameters {
     param(
@@ -395,10 +424,33 @@ try {
     ###############################################################
     # Get the storage account key
     $storageAccountKey = az storage account keys list --account-name $deploymentResult.StorageAccountName --resource-group $deploymentResult.ResourceGroupName --query "[0].value" -o tsv
+    
+    # Validate if the storage account key is empty or null
+    ValidateVariableIsNullOrEmpty -variableValue $storageAccountKey -variableName "Storage account key"  
+    
     ## Construct the connection string manually
     $storageAccountConnectionString = "DefaultEndpointsProtocol=https;AccountName=$($deploymentResult.StorageAccountName);AccountKey=$storageAccountKey;EndpointSuffix=core.windows.net"
+    # Validate if the Storage Account Connection String is empty or null
+    ValidateVariableIsNullOrEmpty -variableValue $storageAccountConnectionString -variableName "Storage Account Connection String"
+    
     ## Assign the connection string to the deployment result object
-    $deploymentResult.StorageAccountConnectionString = $storageAccountConnectionString    
+    $deploymentResult.StorageAccountConnectionString = $storageAccountConnectionString  
+
+    # Check if ResourceGroupName is valid
+    ValidateVariableIsNullOrEmpty -variableValue $deploymentResult.ResourceGroupName -variableName "Resource group name"  
+   
+    # Check if AzCosmosDBName is valid
+    ValidateVariableIsNullOrEmpty -variableValue $deploymentResult.AzCosmosDBName -variableName "Az Cosmos DB name"  
+    
+    # Check if AzCognitiveServiceName is valid
+    ValidateVariableIsNullOrEmpty -variableValue $deploymentResult.AzCognitiveServiceName -variableName "Az Cognitive Service name"  
+    
+    # Check if AzSearchServiceName is valid
+    ValidateVariableIsNullOrEmpty -variableValue $deploymentResult.AzSearchServiceName -variableName "Az Search Service name"  
+    
+    # Check if AzOpenAiServiceName is valid
+    ValidateVariableIsNullOrEmpty -variableValue $deploymentResult.AzOpenAiServiceName -variableName "Az OpenAI Service name"  
+      
     # Get MongoDB connection string
     $deploymentResult.AzCosmosDBConnectionString = az cosmosdb keys list --name $deploymentResult.AzCosmosDBName --resource-group $deploymentResult.ResourceGroupName --type connection-strings --query "connectionStrings[0].connectionString" -o tsv
     # Get Azure Cognitive Service API Key
@@ -601,26 +653,49 @@ try {
     #  6-1. Get Az Network resource Name with the public IP address
     Write-Host "Assign DNS Name to the public IP address" -ForegroundColor Green
     $publicIpName=$(az network public-ip list --query "[?ipAddress=='$externalIP'].name" --output tsv)
-
     #  6-2. Generate Unique backend API fqdn Name - esgdocanalysis-3 digit random number with padding 0
     $dnsName = "kmgs$($(Get-Random -Minimum 0 -Maximum 9999).ToString("D4"))"
+    
+    # Validate if the AKS Resource Group Name, Public IP name and DNS Name are provided
+    ValidateVariableIsNullOrEmpty -variableValue $aksResourceGroupName -variableName "AKS Resource Group name"  
+    
+    ValidateVariableIsNullOrEmpty -variableValue $publicIpName -variableName "Public IP name" 
 
+    ValidateVariableIsNullOrEmpty -variableValue $dnsName -variableName "DNS Name" 
+    
     #  6-3. Assign DNS Name to the public IP address
     az network public-ip update --resource-group $aksResourceGroupName --name $publicIpName --dns-name $dnsName
-    #  6-4. Get FQDN for the public IP address    
-    $fqdn = az network public-ip show --resource-group $aksResourceGroupName --name $publicIpName --query "dnsSettings.fqdn" --output tsv
-    Write-Host "FQDN for the public IP address is: $fqdn" -ForegroundColor Green
 
+    #  6-4. Get FQDN for the public IP address
+    #$fqdn = az network public-ip show --resource-group $aksResourceGroupName --name $publicIpName --query "dnsSettings.fqdn" --output tsv
+     $fqdn = $null
+    # Validate if the FQDN is null or empty
+    ValidateVariableIsNullOrEmpty -variableValue $fqdn -variableName "FQDN"    
+        
     # 7. Assign the role for aks system assigned managed identity to App Configuration Data Reader role with the scope of Resourcegroup
     Write-Host "Assign the role for aks system assigned managed identity to App Configuration Data Reader role" -ForegroundColor Green
+    # Ensure that the required fields are not null or empty
+    ValidateVariableIsNullOrEmpty -variableValue $deploymentResult.ResourceGroupName -variableName "Resource group name"    
+    
+    ValidateVariableIsNullOrEmpty -variableValue $deploymentResult.AksName -variableName "AKS cluster name"    
+        
     # Get vmss resource group name
     $vmssResourceGroupName = $(az aks show --resource-group $deploymentResult.ResourceGroupName --name $deploymentResult.AksName --query nodeResourceGroup --output tsv)
+    
+    # Validate if vmss Resource Group Name is null or empty
+    ValidateVariableIsNullOrEmpty -variableValue $vmssResourceGroupName -variableName "VMSS resource group"    
+        
     # Get vmss name
     $vmssName = $(az vmss list --resource-group $vmssResourceGroupName --query "[0].name" --output tsv)
+    
+    # Validate if vmss Name is null or empty
+    ValidateVariableIsNullOrEmpty -variableValue $vmssName -variableName "VMSS name"    
+        
     # Create System Assigned Managed Identity
     $systemAssignedIdentity = $(az vmss identity assign --resource-group $vmssResourceGroupName --name $vmssName --query systemAssignedIdentity --output tsv)
 
-    
+    # Validate if System Assigned Identity is null or empty
+    ValidateVariableIsNullOrEmpty -variableValue $systemAssignedIdentity -variableName "System-assigned managed identity"    
 
     # Assign the role for aks system assigned managed identity to App Configuration Data Reader role with the scope of Resourcegroup
     az role assignment create --assignee $systemAssignedIdentity --role "App Configuration Data Reader" --scope $deploymentResult.ResourceGroupId