Extended removal logic to be more robust and in-depth

.azuredevops/pipelineTemplates/module.jobs.deploy.yml

@@ -278,7 +278,7 @@ jobs:
               pwsh: true
               inline: |
                 # Load used function
-                . (Join-Path '$(moduleRepoRoot)' '$(pipelineFunctionsPath)' 'resourceRemoval' 'Remove-DeployedModule.ps1')
+                . (Join-Path '$(moduleRepoRoot)' '$(pipelineFunctionsPath)' 'resourceRemoval' 'Initialize-DeploymentRemoval.ps1')
 
                 if(-not [String]::IsNullOrEmpty('${{ deploymentBlock.templateFilePath }}')) {
                   $templateFilePath = Join-Path '$(moduleRepoRoot)' '${{ deploymentBlock.templateFilePath }}'
@@ -289,14 +289,16 @@ jobs:
                     (Join-Path '$(ModuleRepoRoot)' '$(modulePath)' 'deploy.json')
                 }
 
-                $functionInput = @{
-                    deploymentName    = '$(deploymentName)'
-                    templateFilePath  = $templateFilePath
-                    resourceGroupName = '${{ parameters.resourceGroupName }}'
-                    verbose           = $true
-                }
+                if (-not [String]::IsNullOrEmpty('$(deploymentName)')) {
+                  $functionInput = @{
+                      DeploymentName    = '$(deploymentName)'
+                      TemplateFilePath  = $templateFilePath
+                      ResourceGroupName = '${{ parameters.resourceGroupName }}'
+                      Verbose           = $true
+                  }
 
-                Write-Verbose 'Invoke task with' -Verbose
-                Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+                  Write-Verbose 'Invoke task with' -Verbose
+                  Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
 
-                Remove-DeployedModule @functionInput
+                  Initialize-DeploymentRemoval @functionInput
+                }

.github/actions/templates/validateModuleDeployment/action.yml

@@ -143,23 +143,21 @@ runs:
     # -----------------
     - name: 'Remove [${{ inputs.templateFilePath }}] from parameters [${{ inputs.parameterFilePath }}]'
       shell: pwsh
-      if: ${{ always() && steps.deploy_step.outputs.deploymentName != '' }}
+      if: ${{ always() && inputs.removeDeployment == 'true' && steps.deploy_step.outputs.deploymentName != '' }}
       run: |
-        if('${{ inputs.removeDeployment }}' -eq 'true') {
-          # Load used function
-          . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'resourceRemoval' 'Remove-DeployedModule.ps1')
-
-          if(-not [String]::IsNullOrEmpty('${{ steps.deploy_step.outputs.deploymentName }}')) {
-            $functionInput = @{
-              deploymentName    = '${{ steps.deploy_step.outputs.deploymentName }}'
-              templateFilePath  = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
-              resourceGroupName = '${{ inputs.resourceGroupName }}'
-              verbose           = $true
-            }
-
-            Write-Verbose 'Invoke task with' -Verbose
-            Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
-
-            Remove-DeployedModule @functionInput
+        # Load used function
+        . (Join-Path $env:GITHUB_WORKSPACE 'utilities' 'pipelines' 'resourceRemoval' 'Initialize-DeploymentRemoval.ps1')
+
+        if (-not [String]::IsNullOrEmpty('${{ steps.deploy_step.outputs.deploymentName }}')) {
+          $functionInput = @{
+            DeploymentName    = '${{ steps.deploy_step.outputs.deploymentName }}'
+            TemplateFilePath  = Join-Path $env:GITHUB_WORKSPACE '${{ inputs.templateFilePath }}'
+            ResourceGroupName = '${{ inputs.resourceGroupName }}'
+            Verbose           = $true
           }
+
+          Write-Verbose 'Invoke task with' -Verbose
+          Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+
+          Initialize-DeploymentRemoval @functionInput
         }

.github/workflows/ms.insights.diagnosticsettings.yml

@@ -7,7 +7,7 @@ on:
         type: boolean
         description: 'Remove deployed module'
         required: false
-        default: 'false' # Needs custom removals script
+        default: 'true'
       versioningOption:
         type: choice
         description: 'The mode to handle the version increments [major|minor|patch]'

.github/workflows/ms.network.networkwatchers.yml

@@ -7,7 +7,7 @@ on:
         type: boolean
         description: 'Remove deployed module'
         required: false
-        default: 'false' # Required as a dependency + Only one Network Watcher can exist in the same location. If removed, a default would be created in a dedicated RG
+        default: 'false' # Only one Network Watcher can exist in the same location. If removed, a default would be created in a dedicated RG
       versioningOption:
         type: choice
         description: 'The mode to handle the version increments [major|minor|patch]'

docs/wiki/PipelinesDesign.md

@@ -95,7 +95,7 @@ Note that, for the deployments we have to account for certain [prerequisites](#p
 
 #### Removal
 
-The removal phase is strongly coupled with the previous deployment phase. Fundamentally, we want to remove any test-deployed resource after its test concluded. If we would not, we would generate unnecessary costs and may temper with any subsequent test. Some resources may require a dedicated logic to be removed. This logic should be stored alongside the generally utilized removal script in the `.utilities/pipelines/resourceRemoval` folder and be referenced by the `Remove-DeployedModule.ps1` script that orchestrates the removal.
+The removal phase is strongly coupled with the previous deployment phase. Fundamentally, we want to remove any test-deployed resource after its test concluded. If we would not, we would generate unnecessary costs and may temper with any subsequent test. Some resources may require a dedicated logic to be removed. This logic should be stored alongside the generally utilized removal script in the `.utilities/pipelines/resourceRemoval` folder and be referenced by the `Initialize-DeploymentRemoval.ps1` script that orchestrates the removal.
 
 Most of the removal scripts rely on the deployment name used during the preceding deployment step. Based on this name in combination with the template file path, the removal script find the corresponding deployment and removes all contained resources.