Functions/Remove-AtwsContactWebhookUdfField.ps1
|
#Requires -Version 5.0 <# .COPYRIGHT Copyright (c) ECIT Solutions AS. All rights reserved. Licensed under the MIT license. See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. #> Function Remove-AtwsContactWebhookUdfField { <# .SYNOPSIS This function deletes a ContactWebhookUdfField through the Autotask Web Services API. .DESCRIPTION This function deletes a ContactWebhookUdfField through the Autotask Web Services API. Entities that have fields that refer to the base entity of this CmdLet: .INPUTS [Autotask.ContactWebhookUdfField[]]. This function takes objects as input. Pipeline is supported. .OUTPUTS Nothing. This fuction just deletes the Autotask.ContactWebhookUdfField that was passed to the function. .EXAMPLE Remove-AtwsContactWebhookUdfField [-ParameterName] [Parameter value] .LINK New-AtwsContactWebhookUdfField .LINK Get-AtwsContactWebhookUdfField .LINK Set-AtwsContactWebhookUdfField #> [CmdLetBinding(SupportsShouldProcess = $true, DefaultParameterSetName='Input_Object', ConfirmImpact='Low')] Param ( # Any objects that should be deleted [Parameter( ParametersetName = 'Input_Object', ValueFromPipeline = $true )] [ValidateNotNullOrEmpty()] [Autotask.ContactWebhookUdfField[]] $InputObject, # The unique id of an object to delete [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [long[]] $Id ) begin { $entityName = 'ContactWebhookUdfField' # Enable modern -Debug behavior if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } else { # Respect configured preference $DebugPreference = $Script:Atws.Configuration.DebugPref } Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) if (!($PSCmdlet.MyInvocation.BoundParameters['Verbose'].IsPresent)) { # No local override of central preference. Load central preference $VerbosePreference = $Script:Atws.Configuration.VerbosePref } } process { # Collect copies of InputObject if passed any IDs # Has to collect in batches, or we are going to get the # dreaded 'too nested SQL' error If ($Id.count -gt 0) { $InputObject = @() for ($i = 0; $i -lt $Id.count; $i += 200) { $j = $i + 199 if ($j -ge $Id.count) { $j = $Id.count - 1 } # Create a filter with the current batch $Filter = 'Id -eq {0}' -F ($Id[$i .. $j] -join ' -or Id -eq ') $InputObject += Get-AtwsData -Entity $entityName -Filter $Filter } } Write-Verbose ('{0}: Deleting {1} object(s) from Autotask' -F $MyInvocation.MyCommand.Name, $InputObject.Count) if ($InputObject) { $caption = $MyInvocation.MyCommand.Name $verboseDescription = '{0}: About to delete {1} {2}(s). This action cannot be undone.' -F $caption, $InputObject.Count, $entityName $verboseWarning = '{0}: About to delete {1} {2}(s). This action cannot be undone. Do you want to continue?' -F $caption, $InputObject.Count, $entityName if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { try { Remove-AtwsData -Entity $InputObject } catch { # Write a debug message with detailed information to developers $reason = ("{0}: {1}" -f $_.CategoryInfo.Category, $_.CategoryInfo.Reason) $message = "{2}: {0}`r`n`r`nLine:{1}`r`n`r`nScript stacktrace:`r`n{3}" -f $_.Exception.Message, $_.InvocationInfo.Line, $reason, $_.ScriptStackTrace Write-Debug $message # Pass on the error, but locate it to this function $PSCmdlet.ThrowTerminatingError($_) return } } } } end { Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) } } |