197 lines
7.4 KiB
PowerShell
197 lines
7.4 KiB
PowerShell
#!/usr/bin/env pwsh
|
|
|
|
# Copyright (c) Microsoft Corporation. All rights reserved.
|
|
# Licensed under the MIT License.
|
|
|
|
#Requires -Version 6.0
|
|
#Requires -PSEdition Core
|
|
#Requires -Modules @{ModuleName='Az.Accounts'; ModuleVersion='1.6.4'}
|
|
#Requires -Modules @{ModuleName='Az.Resources'; ModuleVersion='1.8.0'}
|
|
|
|
[CmdletBinding(DefaultParameterSetName = 'Default', SupportsShouldProcess = $true, ConfirmImpact = 'Medium')]
|
|
param (
|
|
# Limit $BaseName to enough characters to be under limit plus prefixes, and https://docs.microsoft.com/azure/architecture/best-practices/resource-naming.
|
|
[Parameter(ParameterSetName = 'Default', Mandatory = $true, Position = 0)]
|
|
[Parameter(ParameterSetName = 'Default+Provisioner', Mandatory = $true, Position = 0)]
|
|
[ValidatePattern('^[-a-zA-Z0-9\.\(\)_]{0,80}(?<=[a-zA-Z0-9\(\)])$')]
|
|
[string] $BaseName,
|
|
|
|
[Parameter(ParameterSetName = 'ResourceGroup', Mandatory = $true)]
|
|
[Parameter(ParameterSetName = 'ResourceGroup+Provisioner', Mandatory = $true)]
|
|
[string] $ResourceGroupName,
|
|
|
|
[Parameter(ParameterSetName = 'Default+Provisioner', Mandatory = $true)]
|
|
[Parameter(ParameterSetName = 'ResourceGroup+Provisioner', Mandatory = $true)]
|
|
[ValidateNotNullOrEmpty()]
|
|
[string] $TenantId,
|
|
|
|
[Parameter(ParameterSetName = 'Default+Provisioner')]
|
|
[Parameter(ParameterSetName = 'ResourceGroup+Provisioner')]
|
|
[ValidatePattern('^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$')]
|
|
[string] $SubscriptionId,
|
|
|
|
[Parameter(ParameterSetName = 'Default+Provisioner', Mandatory = $true)]
|
|
[Parameter(ParameterSetName = 'ResourceGroup+Provisioner', Mandatory = $true)]
|
|
[ValidatePattern('^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$')]
|
|
[string] $ProvisionerApplicationId,
|
|
|
|
[Parameter(ParameterSetName = 'Default+Provisioner', Mandatory = $true)]
|
|
[Parameter(ParameterSetName = 'ResourceGroup+Provisioner', Mandatory = $true)]
|
|
[string] $ProvisionerApplicationSecret,
|
|
|
|
[Parameter()]
|
|
[string] $ServiceDirectory,
|
|
|
|
[Parameter()]
|
|
[ValidateSet('AzureCloud', 'AzureUSGovernment', 'AzureChinaCloud')]
|
|
[string] $Environment = 'AzureCloud',
|
|
|
|
[Parameter()]
|
|
[switch] $Force,
|
|
|
|
# Captures any arguments not declared here (no parameter errors)
|
|
[Parameter(ValueFromRemainingArguments = $true)]
|
|
$RemoveTestResourcesRemainingArguments
|
|
)
|
|
|
|
# By default stop for any error.
|
|
if (!$PSBoundParameters.ContainsKey('ErrorAction')) {
|
|
$ErrorActionPreference = 'Stop'
|
|
}
|
|
|
|
function Log($Message) {
|
|
Write-Host ('{0} - {1}' -f [DateTime]::Now.ToLongTimeString(), $Message)
|
|
}
|
|
|
|
function Retry([scriptblock] $Action, [int] $Attempts = 5) {
|
|
$attempt = 0
|
|
$sleep = 5
|
|
|
|
while ($attempt -lt $Attempts) {
|
|
try {
|
|
$attempt++
|
|
return $Action.Invoke()
|
|
} catch {
|
|
if ($attempt -lt $Attempts) {
|
|
$sleep *= 2
|
|
|
|
Write-Warning "Attempt $attempt failed: $_. Trying again in $sleep seconds..."
|
|
Start-Sleep -Seconds $sleep
|
|
} else {
|
|
Write-Error -ErrorRecord $_
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
# Support actions to invoke on exit.
|
|
$exitActions = @({
|
|
if ($exitActions.Count -gt 1) {
|
|
Write-Verbose 'Running registered exit actions.'
|
|
}
|
|
})
|
|
|
|
trap {
|
|
# Like using try..finally in PowerShell, but without keeping track of more braces or tabbing content.
|
|
$exitActions.Invoke()
|
|
}
|
|
|
|
if ($ProvisionerApplicationId) {
|
|
$null = Disable-AzContextAutosave -Scope Process
|
|
|
|
Log "Logging into service principal '$ProvisionerApplicationId'"
|
|
$provisionerSecret = ConvertTo-SecureString -String $ProvisionerApplicationSecret -AsPlainText -Force
|
|
$provisionerCredential = [System.Management.Automation.PSCredential]::new($ProvisionerApplicationId, $provisionerSecret)
|
|
|
|
# Use the given subscription ID if provided.
|
|
$subscriptionArgs = if ($SubscriptionId) {
|
|
@{SubscriptionId = $SubscriptionId}
|
|
}
|
|
|
|
$provisionerAccount = Retry {
|
|
Connect-AzAccount -Force:$Force -Tenant $TenantId -Credential $provisionerCredential -ServicePrincipal -Environment $Environment @subscriptionArgs
|
|
}
|
|
|
|
$exitActions += {
|
|
Write-Verbose "Logging out of service principal '$($provisionerAccount.Context.Account)'"
|
|
$null = Disconnect-AzAccount -AzureContext $provisionerAccount.Context
|
|
}
|
|
}
|
|
|
|
if (!$ResourceGroupName) {
|
|
# Format the resource group name like in New-TestResources.ps1.
|
|
$ResourceGroupName = "rg-$BaseName"
|
|
}
|
|
|
|
if (![string]::IsNullOrWhiteSpace($ServiceDirectory)) {
|
|
$root = [System.IO.Path]::Combine("$PSScriptRoot/../../../sdk", $ServiceDirectory) | Resolve-Path
|
|
$preRemovalScript = Join-Path -Path $root -ChildPath 'remove-test-resources-pre.ps1'
|
|
if (Test-Path $preRemovalScript) {
|
|
Log "Invoking pre resource removal script '$preRemovalScript'"
|
|
|
|
if (!$PSCmdlet.ParameterSetName.StartsWith('ResourceGroup')) {
|
|
$PSBoundParameters.Add('ResourceGroupName', $ResourceGroupName);
|
|
}
|
|
|
|
&$preRemovalScript @PSBoundParameters
|
|
}
|
|
}
|
|
|
|
Log "Deleting resource group '$ResourceGroupName'"
|
|
if (Retry { Remove-AzResourceGroup -Name "$ResourceGroupName" -Force:$Force }) {
|
|
Write-Verbose "Successfully deleted resource group '$ResourceGroupName'"
|
|
}
|
|
|
|
$exitActions.Invoke()
|
|
|
|
<#
|
|
.SYNOPSIS
|
|
Deletes the resource group deployed for a service directory from Azure.
|
|
.DESCRIPTION
|
|
Removes a resource group and all its resources previously deployed using
|
|
New-TestResources.ps1.
|
|
If you are not currently logged into an account in the Az PowerShell module,
|
|
you will be asked to log in with Connect-AzAccount. Alternatively, you (or a
|
|
build pipeline) can pass $ProvisionerApplicationId and
|
|
$ProvisionerApplicationSecret to authenticate a service principal with access to
|
|
create resources.
|
|
.PARAMETER BaseName
|
|
A name to use in the resource group and passed to the ARM template as 'baseName'.
|
|
This will delete the resource group named 'rg-<baseName>'
|
|
.PARAMETER ResourceGroupName
|
|
The name of the resource group to delete.
|
|
.PARAMETER TenantId
|
|
The tenant ID of a service principal when a provisioner is specified.
|
|
.PARAMETER SubscriptionId
|
|
Optional subscription ID to use for new resources when logging in as a
|
|
provisioner. You can also use Set-AzContext if not provisioning.
|
|
.PARAMETER ProvisionerApplicationId
|
|
A service principal ID to provision test resources when a provisioner is specified.
|
|
.PARAMETER ProvisionerApplicationSecret
|
|
A service principal secret (password) to provision test resources when a provisioner is specified.
|
|
.PARAMETER ServiceDirectory
|
|
A directory under 'sdk' in the repository root - optionally with subdirectories
|
|
specified - in which to discover pre removal script named 'remove-test-resources-pre.json'.
|
|
.PARAMETER Environment
|
|
Name of the cloud environment. The default is the Azure Public Cloud
|
|
('PublicCloud')
|
|
.PARAMETER Force
|
|
Force removal of resource group without asking for user confirmation
|
|
.EXAMPLE
|
|
Remove-TestResources.ps1 -BaseName 'uuid123' -Force
|
|
Use the currently logged-in account to delete the resource group by the name of
|
|
'rg-uuid123'
|
|
.EXAMPLE
|
|
Remove-TestResources.ps1 `
|
|
-ResourceGroupName "${env:AZURE_RESOURCEGROUP_NAME}" `
|
|
-TenantId '$(TenantId)' `
|
|
-ProvisionerApplicationId '$(AppId)' `
|
|
-ProvisionerApplicationSecret '$(AppSecret)' `
|
|
-Force `
|
|
-Verbose `
|
|
When run in the context of an Azure DevOps pipeline, this script removes the
|
|
resource group whose name is stored in the environment variable
|
|
AZURE_RESOURCEGROUP_NAME.
|
|
.LINK
|
|
New-TestResources.ps1
|
|
#> |