Remove-ADOField.ps1
|
function Remove-ADOField { <# .Synopsis Removes fields in Azure DevOps .Description Removes fields in Azure DevOps or Team Foundation Server. .Example Remove-ADOField -Name Cmdlet.Verb .Example Remove-ADOField -Name IsDCR .Link Get-ADOField .Link New-ADOField .Link Invoke-ADORestAPI #> [CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact='High')] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSPossibleIncorrectComparisonWithNull", "", Justification="Explicitly checking for nulls")] param( # The name or reference name of the field [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('FriendlyName', 'DisplayName', 'ReferenceName','SystemName')] [string] $Name, # The Organization [Parameter(Mandatory,ValueFromPipelineByPropertyName)] [Alias('Org')] [string] $Organization, # The Project [Parameter(ValueFromPipelineByPropertyName)] [string] $Project, # The server. By default https://dev.azure.com/. # To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). [Parameter(ValueFromPipelineByPropertyName)] [uri] $Server = "https://dev.azure.com/", # The api version. By default, 5.1. # If targeting TFS, this will need to change to match your server version. # See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops [string] $ApiVersion = "5.1", # A Personal Access Token [Alias('PAT')] [string] $PersonalAccessToken, # Specifies a user account that has permission to send the request. The default is the current user. # Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. [pscredential] [Management.Automation.CredentialAttribute()] $Credential, # Indicates that the cmdlet uses the credentials of the current user to send the web request. [Alias('UseDefaultCredential')] [switch] $UseDefaultCredentials, # Specifies that the cmdlet uses a proxy server for the request, rather than connecting directly to the Internet resource. Enter the URI of a network proxy server. [uri] $Proxy, # Specifies a user account that has permission to use the proxy server that is specified by the Proxy parameter. The default is the current user. # Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. # This parameter is valid only when the Proxy parameter is also used in the command. You cannot use the ProxyCredential and ProxyUseDefaultCredentials parameters in the same command. [pscredential] [Management.Automation.CredentialAttribute()] $ProxyCredential, # Indicates that the cmdlet uses the credentials of the current user to access the proxy server that is specified by the Proxy parameter. # This parameter is valid only when the Proxy parameter is also used in the command. You cannot use the ProxyCredential and ProxyUseDefaultCredentials parameters in the same command. [switch] $ProxyUseDefaultCredentials ) begin { #region Copy Invoke-ADORestAPI parameters $invokeParams = . $getInvokeParameters $PSBoundParameters #endregion Copy Invoke-ADORestAPI parameters } process { $uriBase = "$Server".TrimEnd('/'), $Organization, $(if ($Project) {$Project }) -ne $null -join '/' $uri = $uriBase, '_apis/wit/fields', "${name}?" -join '/' $uri += if ($ApiVersion) { "api-version=$ApiVersion" } $invokeParams.Uri = $uri $invokeParams.Method = 'DELETE' if (-not $PSCmdlet.ShouldProcess("DELETE $uri")) { return } Invoke-ADORestAPI @invokeParams } } |