functions/generated/WorkItemTracking/Remove-AdsWitField.ps1
|
function Remove-AdsWitField { <# .SYNOPSIS .DESCRIPTION Deletes the field. To undelete a filed, see "Update Field" API. .PARAMETER Organization The name of the Azure DevOps organization. .PARAMETER FieldNameOrRefName Field simple name or reference name .PARAMETER Project Project ID or project name .PARAMETER ApiVersion Version of the API to use. This should be set to '7.1-preview.2' to use this version of the api. .EXAMPLE PS C:\> Remove-AdsWitField -Organization $organization -FieldNameOrRefName $fieldnameorrefname -Project $project -ApiVersion $apiversion Deletes the field. To undelete a filed, see "Update Field" API. .LINK <unknown> #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding(DefaultParameterSetName = 'default')] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Organization, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $FieldNameOrRefName, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $Project, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default')] [string] $ApiVersion ) process { $__mapping = @{ 'ApiVersion' = 'api-version' } $__body = $PSBoundParameters | ConvertTo-Hashtable -Include @() -Mapping $__mapping $__query = $PSBoundParameters | ConvertTo-Hashtable -Include @('ApiVersion') -Mapping $__mapping $__header = $PSBoundParameters | ConvertTo-Hashtable -Include @() -Mapping $__mapping $__path = 'https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}' -Replace '{organization}',$Organization -Replace '{fieldNameOrRefName}',$FieldNameOrRefName -Replace '{project}',$Project Invoke-RestRequest -Path $__path -Method delete -Body $__body -Query $__query -Header $__header } } |