ado/core/projects/public/removeProject.ps1
|
function Remove-AdoProject { <# .SYNOPSIS Remove a project from an Azure DevOps organization. .DESCRIPTION This function removes a project from an Azure DevOps organization through REST API. .PARAMETER Project Mandatory. The project to remove. .PARAMETER ApiVersion Optional. The API version to use. .LINK https://learn.microsoft.com/en-us/rest/api/azure/devops/core/projects/delete .EXAMPLE Remove-AdoProject -Project $objProject #> [CmdletBinding()] [OutputType([String])] param ( [Parameter(Mandatory)] [object]$Project, [Parameter(Mandatory = $false)] [Alias('Api')] [ValidateSet('7.1', '7.2-preview.1')] [string]$ApiVersion = '7.2-preview.1' ) begin { Write-Verbose ('Command : {0}' -f $MyInvocation.MyCommand.Name) Write-Verbose (' ProjectId : {0}' -f $ProjectId) Write-Verbose (' ApiVersion : {0}' -f $ApiVersion) } process { try { $ErrorActionPreference = 'Stop' if (-not $global:AzDevOpsIsConnected) { throw 'Not connected to Azure DevOps. Please connect using Connect-AdoOrganization.' } $uriFormat = '{0}/_apis/projects/{1}?api-version={2}' $azDevOpsUri = ($uriFormat -f [uri]::new($global:AzDevOpsOrganization), [uri]::EscapeUriString($Project.Id), $ApiVersion) $params = @{ Method = 'DELETE' Uri = $azDevOpsUri Headers = $global:AzDevOpsHeaders } $response = Invoke-RestMethod @params -ContentType 'application/json' -Verbose:$VerbosePreference $status = $response.status while ($status -ne 'succeeded') { Write-Host 'Checking project deletion status...' Start-Sleep -Seconds 2 $response = Invoke-RestMethod -Method GET -Uri $response.url -Headers $global:AzDevOpsHeaders -Verbose:$VerbosePreference $status = $response.status if ($status -eq 'failed') { Write-Error -Message ('Project deletion failed {0}' -f $PSItem.Exception.Message) } } return ('Project {0} removed' -f $Project.Name) } catch { throw $_ } } end { Write-Verbose ('Exit : {0}' -f $MyInvocation.MyCommand.Name) } } |