Cleaning up a Deployment

In some scenarios, it may be necessary to remove everything deployed by the AMBA solution. The instructions below detail execution of a PowerShell script to delete all resources deployed, including:

• Metric Alerts
• Activity Log Alerts
• Resource Groups (created for to contain alert resources)
• Policy Assignments
• Policy Definitions
• Policy Set Definitions
• Policy Assignment remediation identity role assignments

All resources deployed as part of the initial AMBA deployment and the resources created dynamically by ‘deploy if not exist’ policies are either tagged, marked in metadata, or in description (depending on what the resource supports) with the value _deployed_by_amba or _deployed_by_amba=True. This metadata is used to execute the cleanup of deployed resources; if it has been removed or modified the cleanup script will not include those resources.

It is highly recommended to thoroughly test the script before running on production environments. The sample scripts are not supported under any Microsoft standard support program or service. The sample scripts are provided AS IS without warranty of any kind. Microsoft further disclaims all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The entire risk arising out of the use or performance of the sample scripts and documentation remains with you. In no event shall Microsoft, its authors, or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the sample scripts or documentation, even if Microsoft has been advised of the possibility of such damages.

Follow the instructions below to download the cleanup script file. Alternatively, clone the repo from GitHub and ensure you are working from the latest version of the file by fetching the latest main branch.

1. Navigate AMBA project in GitHub
2. In the folder structure, browse to the patterns/alz/scripts directory
3. Open the Start-AMBACleanup.ps1 script file
4. Click the Raw button
5. Save the open file as Start-AMBACleanup.ps1

1. Open PowerShell
2. Install the Az.ResourceGraph module: Install-Module Az.ResourceGraph
3. Change directories to the location of the Start-AMBACleanup.ps1 script
4. Configure the $pseudoRootManagementGroup variable using the command below:

$pseudoRootManagementGroup = "The pseudo root management group id parenting the identity, management and connectivity management groups"

5. Sign in to the Azure with the Connect-AzAccount command. The account you sign in as needs to have permissions to remove Policy Assignments, Policy Definitions, and resources at the desired Management Group scope.

6. Execute the script using one of the options below:

   Since PowerShell scripts released as part of the ALZ pattern are not digitally signed they might require you to temporarily change the execution policy if not already set to Unrestricted. Before running the script, check the execution policy settings using this command:

   Get-ExecutionPolicy
   

   If the result is everything but Unrestricted, run the following command to change it to Unrestricted

   Set-ExecutionPolicy -ExecutionPolicy Unrestricted
   

   At this point, you should be able to run your scripts with no issues. After you finished, you can set the execution policy back to what it was if you like to do so.

   Generate a list of the resource IDs which would be deleted by this script:

   ./Start-AMBACleanup.ps1 -pseudoRootManagementGroup $pseudoRootManagementGroup -ReportOnly
   

   Show output of what would happen if deletes executed:

   ./Start-AMBACleanup.ps1 -pseudoRootManagementGroup $pseudoRootManagementGroup -WhatIf
   

   Delete all resources deployed by the ALZ-Monitor IaC without prompting for confirmation:

   ./Start-AMBACleanup.ps1 -pseudoRootManagementGroup $pseudoRootManagementGroup -Force