Skip to content

Latest commit

 

History

History
144 lines (106 loc) · 3.38 KB

Get-PnPEventReceiver.md

File metadata and controls

144 lines (106 loc) · 3.38 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Get-PnPEventReceiver

SYNOPSIS

Return registered eventreceivers

SYNTAX

List

Get-PnPEventReceiver [-List <ListPipeBind>]
                     [-Identity <EventReceiverPipeBind>]
                     [-Web <WebPipeBind>]
                     [-Connection <SPOnlineConnection>]

Get-PnPEventReceiver [-Identity <EventReceiverPipeBind>]
                     [-Web <WebPipeBind>]
                     [-Includes <String[]>]
                     [-Connection <SPOnlineConnection>]

DESCRIPTION

Returns all registered or a specific eventreceiver

EXAMPLES

------------------EXAMPLE 1------------------

PS:> Get-PnPEventReceiver

This will return all registered event receivers on the current web

------------------EXAMPLE 2------------------

PS:> Get-PnPEventReceiver -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22

This will return the event receiver with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22" from the current web

------------------EXAMPLE 3------------------

PS:> Get-PnPEventReceiver -Identity MyReceiver

This will return the event receiver with the provided ReceiverName "MyReceiver" from the current web

------------------EXAMPLE 4------------------

PS:> Get-PnPEventReceiver -List "ProjectList"

This will return all registered event receivers in the provided "ProjectList" list

------------------EXAMPLE 5------------------

PS:> Get-PnPEventReceiver -List "ProjectList" -Identity fb689d0e-eb99-4f13-beb3-86692fd39f22

This will return the event receiver in the provided "ProjectList" list with with the provided ReceiverId "fb689d0e-eb99-4f13-beb3-86692fd39f22"

------------------EXAMPLE 6------------------

PS:> Get-PnPEventReceiver -List "ProjectList" -Identity MyReceiver

This will return the event receiver in the "ProjectList" list with the provided ReceiverName "MyReceiver"

PARAMETERS

-Identity

The Guid of the event receiver

Type: EventReceiverPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: True

-Includes

Specify properties to include when retrieving objects from the server.

Type: String[]
Parameter Sets: 

Required: False
Position: 0
Accept pipeline input: False

-List

The list object from which to get the event receiver object

Type: ListPipeBind
Parameter Sets: List

Required: False
Position: Named
Accept pipeline input: False

-Web

The 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: False

-Connection

Optional 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

OUTPUTS

RELATED LINKS

SharePoint Developer Patterns and Practices