Public/Core/Teams/Remove-AdoTeam.ps1
|
function Remove-AdoTeam { <# .SYNOPSIS Remove a team from an Azure DevOps project. .DESCRIPTION This function removes a team from an Azure DevOps project through REST API. .PARAMETER ProjectId Mandatory. The ID or name of the project. .PARAMETER TeamId Mandatory. The ID or name of the team. .PARAMETER ApiVersion Optional. The API version to use. .OUTPUTS System.Object The team details object. .LINK https://learn.microsoft.com/en-us/rest/api/azure/devops/core/teams/delete .EXAMPLE Remove-AdoTeam -ProjectId 'my-project' -TeamId 'my-team' Removes the specified team from the specified project. #> [CmdletBinding()] [OutputType([boolean])] param ( [Parameter(Mandatory)] [string]$ProjectId, [Parameter(Mandatory)] [string]$TeamId, [Parameter(Mandatory = $false)] [Alias('api')] [ValidateSet('5.1', '7.1-preview.4', '7.2-preview.3')] [string]$ApiVersion = '7.1' ) begin { Write-Debug ('Command : {0}' -f $MyInvocation.MyCommand.Name) Write-Debug (' ProjectId : {0}' -f $ProjectId) Write-Debug (' TeamId : {0}' -f $TeamId) Write-Debug (' 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}/teams/{2}?api-version={3}' $azDevOpsUri = ($uriFormat -f [uri]::new($global:AzDevOpsOrganization), [uri]::EscapeUriString($ProjectId), $TeamId, $ApiVersion) $params = @{ Method = 'DELETE' Uri = $azDevOpsUri Headers = ((ConvertFrom-SecureString -SecureString $global:AzDevOpsHeaders -AsPlainText) | ConvertFrom-Json -AsHashtable) } Invoke-RestMethod @params -Verbose:$VerbosePreference | Out-Null return $true } catch { throw $_ } } end { Write-Debug ('Exit : {0}' -f $MyInvocation.MyCommand.Name) } } |