| external help file | applicable | schema |
|---|---|---|
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online |
2.0.0 |
Return user custom actions
Get-PnPCustomAction [-Identity <GuidPipeBind>]
[-Scope <CustomActionScope>]
[-ThrowExceptionIfCustomActionNotFound [<SwitchParameter>]]
[-Web <WebPipeBind>]
[-Includes <String[]>]
[-Connection <SPOnlineConnection>]Returns all or a specific user custom action
PS:> Get-PnPCustomActionReturns all custom actions of the current site.
PS:> Get-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2Returns the custom action with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'.
PS:> Get-PnPCustomAction -Scope webReturns all custom actions for the current web object.
Identity of the CustomAction to return. Omit to return all CustomActions.
Type: GuidPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: FalseSpecify properties to include when retrieving objects from the server.
Type: String[]
Parameter Sets:
Required: False
Position: 0
Accept pipeline input: FalseScope of the CustomAction, either Web, Site or All to return both
Type: CustomActionScope
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: FalseSwitch parameter if an exception should be thrown if the requested CustomAction does not exist (true) or if omitted, nothing will be returned in case the CustomAction does not exist
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: FalseThe web to apply the command to. Omit this parameter to use the current web.
Type: WebPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: FalseOptional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: SPOnlineConnection
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False