ado/git/repositories/public/removeRepository.ps1
|
function Remove-AdoRepository { <# .SYNOPSIS Remove a repository from an Azure DevOps project. .DESCRIPTION This function removes a repository from an Azure DevOps project through REST API. .PARAMETER ProjectId Mandatory. The unique identifier or name of the project. .PARAMETER RepoId Mandatory. The unique identifier of the repository. .PARAMETER ApiVersion Optional. The API version to use. .LINK https://learn.microsoft.com/en-us/rest/api/azure/devops/git/repositories/delete?view=azure-devops .EXAMPLE Remove-AdoRepository -ProjectName 'my-project-001' -RepositoryId $repo.id #> [CmdletBinding()] [OutputType([boolean])] param ( [Parameter(Mandatory)] [Alias('ProjectName')] [string]$ProjectId, [Parameter(Mandatory)] [Alias('RepoId')] [string]$RepositoryId, [Parameter(Mandatory = $false)] [Alias('Api')] [ValidateSet('7.1', '7.2-preview.2')] [string]$ApiVersion = '7.1' ) begin { Write-Verbose ('Command : {0}' -f $MyInvocation.MyCommand.Name) Write-Verbose (' ProjectId : {0}' -f $ProjectId) Write-Verbose (' RepoId : {0}' -f $RepositoryId) 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}/{1}/_apis/git/repositories/{2}?api-version={3}' $azDevOpsUri = ($uriFormat -f [uri]::EscapeDataString($Organization), [uri]::EscapeDataString($ProjectId), $RepositoryId, $ApiVersion) $params = @{ Method = 'DELETE' Uri = $azDevOpsUri Headers = $global:AzDevOpsHeaders } Invoke-RestMethod @params -Verbose:$VerbosePreference | Out-Null return $true } catch { throw $_ } } end { Write-Verbose ('Exit : {0}' -f $MyInvocation.MyCommand.Name) } } |