Public/Remove/Remove-HaloClientBatch.ps1
|
Function Remove-HaloClientBatch { <# .SYNOPSIS Removes multiple clients via the Halo API. .DESCRIPTION Function to send a batch of client removal requests to the Halo API .OUTPUTS Outputs an object containing the responses from the web requests. #> [CmdletBinding( SupportsShouldProcess = $True )] [OutputType([Object[]])] Param ( # Array of objects containing properties and values used to remove one or more clients. This should be an array of client ids. [Parameter( Mandatory = $True )] [Int64[]]$Clients, # How many objects to process at once before delaying. Default value is 100. [Int32]$BatchSize, # How long to wait between batch runs. Default value is 1 second. [Int32]$BatchWait ) Invoke-HaloPreFlightCheck try { if ($PSCmdlet.ShouldProcess('Clients', 'Delete')) { if ($Clients -is [Array]) { $BatchParams = @{ BatchInput = $Clients EntityType = 'Client' Operation = 'Remove' } if ($BatchSize) { $BatchParams.Size = $BatchSize } if ($BatchWait) { $BatchParams.Wait = $BatchWait } $BatchResults = Invoke-HaloBatchProcessor @BatchParams Return $BatchResults } else { throw 'Remove-HaloClientBatch requires an array of client ids to delete.' } } } catch { New-HaloError -ErrorRecord $_ } } |