Clean-up script for workload orchestration

This script is used to clean up resources in a specified Azure resource group. It provides options to selectively delete specific resource types. By default, no resources are deleted unless explicitly specified for safety.

For more information about deleting resources created with workload orchestration, see Delete resources in workload orchestration.

Prerequisites

Set up your environment for workload orchestration. If you haven't, go to Prepare your environment for workload orchestration to set up the prerequisites.

Note

You need to have the necessary permissions to delete resources in the specified resource group. For most cases, by default your alias will have permission.

Run the clean-up script

In the ZIP folder you downloaded as part of Prepare your environment for workload orchestration, you can find the PowerShell script RGCleanScript.ps1 that allows you to clean up resources in a specified Azure resource group. This script is useful for removing all resources created with workload orchestration, including sites, targets, configurations, schemas, and solutions.

You execute the script by running the following command in PowerShell, replacing <YourResourceGroupName> with the name of your resource group. You can also specify which resources to delete by using the optional parameters.

# Clean only specific resources (safe by default - nothing is deleted unless explicitly specified)
.\RGCleanScript.ps1 -resourceGroupName <YourResourceGroupName> [-deleteSite $true] [-deleteTarget $true] 

# Clean all resources at once
.\RGCleanScript.ps1 -resourceGroupName <YourResourceGroupName> -deleteAll $true

# Clean all deployed instances
.\RGCleanScript.ps1 -resourceGroupName <YourResourceGroupName> [-deleteInstance $true]

The RGCleanScript.ps1 script contains the following parameters, which you can set to customize the cleanup process:

Parameter	Required/Optional	Type	Description
resourceGroupName	Required	string	The name of the resource group to clean.
subscriptionId	Optional	string	Subscription ID for resources (For Microsoft.Edge). Defaults to the subscription shown by az cli.
contextSubscriptionId	Optional	string	Subscription ID where context is present (For Microsoft.Edge). Defaults to az cli subscription.
contextResourceGroupName	Optional	string	Resource group of the Context (For Microsoft.Edge).
contextName	Optional	string	Name of the Context (For Microsoft.Edge).
deleteSite	Optional	bool	Delete site resources. Default is false.
deleteTarget	Optional	bool	Delete target resources. Default is false.
deleteConfiguration	Optional	bool	Delete CM created configuration resources. Default is false.
deleteSchema	Optional	bool	Delete schema/dynamic schema resources. Default is false.
deleteConfigTemplate	Optional	bool	Delete user created config template resources. Default is false.
deleteSolution	Optional	bool	Delete solution template resources. Default is false.
deleteInstance	Optional	bool	Delete application instances. Default is false.
deleteAks	Optional	bool	Delete AKS cluster resources. Default is false.
deleteManagedIdentity	Optional	bool	Delete managed identity resources. Default is false.
deleteMicrosoftEdge	Optional	bool	Delete Microsoft Edge resources. Default is false.
deleteAll	Optional	bool	Delete all resources (sets all delete parameters to true). Default is false.