functions/Remove-SPRListItem.ps1
|
Function Remove-SPRListItem { <# .SYNOPSIS Deletes items from a SharePoint list. .DESCRIPTION Deletes items from a SharePoint list. .PARAMETER List The human readable list name. So 'My List' as opposed to 'MyList', unless you named it MyList. .PARAMETER Web The human readable web name. So 'My Web' as opposed to 'MyWeb', unless you named it MyWeb. .PARAMETER Site The address to the site collection. You can also pass a hostname and it'll figure it out. Don't want to specify the Site or Credential every time? Use Connect-SPRSite to create a reusable connection. See Get-Help Connect-SPRsite for more information. .PARAMETER Credential Provide alternative credentials to the site collection. Otherwise, it will use default credentials. .PARAMETER Id Removes only rows with specific IDs. .PARAMETER InputObject Allows piping from Get-SPRListItem. .PARAMETER WhatIf If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run. .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .EXAMPLE Remove-SPRListItem -Site intranet.ad.local -List 'My List' Deletes all items from My List on intranet.ad.local. Prompts for confirmation. .EXAMPLE Get-SPRList -List 'My List' -Site intranet.ad.local | Remove-SPRListItem -Confirm:$false Deletes all items from My List on intranet.ad.local. Does not prompt for confirmation. .EXAMPLE Get-SPRListItem -Site intranet.ad.local -List 'My List' -Credential ad\user | Remove-SPRListItem -Confirm:$false Deletes all items from My List by logging into the webapp as ad\user. .EXAMPLE Remove-SPRListItem -Site intranet.ad.local -List 'My List' No actions are performed but informational messages will be displayed about the items that would be deleted from the My List list. #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, HelpMessage = "Human-readble SharePoint list name")] [string[]]$List, [Parameter(Position = 1, HelpMessage = "Human-readble SharePoint web name")] [string[]]$Web, [Parameter(Position = 2, HelpMessage = "SharePoint Site Collection")] [string]$Site, [PSCredential]$Credential, [int[]]$Id, [parameter(ValueFromPipeline)] [object[]]$InputObject, [switch]$EnableException ) process { if (-not $InputObject) { if ($Site) { $InputObject = Get-SPRListItem -Site $Site -Credential $Credential -List $List -Web $Web -Id $Id } elseif ($script:spsite) { $InputObject = Get-SPRListItem -List $List -Web $Web -Id $Id -Credential $Credential } else { Stop-PSFFunction -EnableException:$EnableException -Message "You must specify Site and List pipe in results from Get-SPRList" return } } if (-not $InputObject) { Stop-PSFFunction -EnableException:$EnableException -Message "No records to delete." return } if ($InputObject -is [Microsoft.SharePoint.Client.List]) { $InputObject = $InputObject | Get-SPRListItem } foreach ($item in $InputObject) { if (-not $item.ListObject) { Stop-PSFFunction -EnableException:$EnableException -Message "Invalid InputObject" -Continue } $thislist = $item.ListObject $title = $item.Title if (-not $title) { $title = $item.TemplateTitle } if ((Test-PSFShouldProcess -PSCmdlet $PSCmdlet -Target $thislist.Context.Url -Action "Removing record $($item.Id) ($title) from $($item.ListObject.Title)")) { try { $thislist.GetItemById($item.Id).DeleteObject() $script:spsite.ExecuteQuery() [pscustomobject]@{ Site = $thislist.Context List = $thislist.Title ItemId = $item.Id Title = $title Status = "Deleted" } } catch { Stop-PSFFunction -EnableException:$EnableException -Message "Failure" -ErrorRecord $_ } } } } } |