Skip to content

Latest commit

 

History

History
59 lines (55 loc) · 4.02 KB

InvokePnPWebAction.md

File metadata and controls

59 lines (55 loc) · 4.02 KB

#Invoke-PnPWebAction Executes operations on web, lists and list items. ##Syntax

Invoke-PnPWebAction [-Webs <Web[]>]
                    [-WebAction <Action`1>]
                    [-ShouldProcessWebAction <Func`2>]
                    [-PostWebAction <Action`1>]
                    [-ShouldProcessPostWebAction <Func`2>]
                    [-WebProperties <String[]>]
                    [-ListAction <Action`1>]
                    [-ShouldProcessListAction <Func`2>]
                    [-PostListAction <Action`1>]
                    [-ShouldProcessPostListAction <Func`2>]
                    [-ListProperties <String[]>]
                    [-ListItemAction <Action`1>]
                    [-ShouldProcessListItemAction <Func`2>]
                    [-ListItemProperties <String[]>]
                    [-SubWebs [<SwitchParameter>]]
                    [-DisableStatisticsOutput [<SwitchParameter>]]
                    [-SkipCounting [<SwitchParameter>]]
                    [-Web <WebPipeBind>]

##Parameters

Parameter Type Required Description
DisableStatisticsOutput SwitchParameter False Will not output statistics after the operation
ListAction Action`1 False Function to be executed on the list. There is one input parameter of type List
ListItemAction Action`1 False Function to be executed on the list item. There is one input parameter of type ListItem
ListItemProperties String[] False The properties to load for list items.
ListProperties String[] False The properties to load for list.
PostListAction Action`1 False Function to be executed on the list, this will trigger after list items have been processed. There is one input parameter of type List
PostWebAction Action`1 False Function to be executed on the web, this will trigger after lists and list items have been processed. There is one input parameter of type Web
ShouldProcessListAction Func`2 False Function to be executed on the web that would determine if ListAction should be invoked, There is one input parameter of type List and the function should return a boolean value
ShouldProcessListItemAction Func`2 False Function to be executed on the web that would determine if ListItemAction should be invoked, There is one input parameter of type ListItem and the function should return a boolean value
ShouldProcessPostListAction Func`2 False Function to be executed on the web that would determine if PostListAction should be invoked, There is one input parameter of type List and the function should return a boolean value
ShouldProcessPostWebAction Func`2 False Function to be executed on the web that would determine if PostWebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value
ShouldProcessWebAction Func`2 False Function to be executed on the web that would determine if WebAction should be invoked, There is one input parameter of type Web and the function should return a boolean value
SkipCounting SwitchParameter False Will skip the counting process; by doing this you will not get an estimated time remaining
SubWebs SwitchParameter False Specify if sub webs will be processed
Web WebPipeBind False The web to apply the command to. Omit this parameter to use the current web.
WebAction Action`1 False Function to be executed on the web. There is one input parameter of type Web
WebProperties String[] False The properties to load for web.
Webs Web[] False Webs you want to process (for example different site collections), will use Web parameter if not specified
##Examples

###Example 1

PS:> Invoke-PnPWebAction -ListAction ${function:ListAction}

This will call the function ListAction on all the lists located on the current web.

###Example 2

PS:> Invoke-PnPWebAction -ShouldProcessListAction ${function:ShouldProcessList} -ListAction ${function:ListAction}

This will call the function ShouldProcessList, if it returns true the function ListAction will then be called. This will occur on all lists located on the current web