Search Results for

    Show / Hide Table of Contents

    Get-PnPEventReceiver

    SYNOPSIS

    Returns registered event receivers

    SYNTAX

    Get-PnPEventReceiver [-List <ListPipeBind>] [-Scope <EventReceiverScope>] [-Identity <EventReceiverPipeBind>] 
     [-Connection <PnPConnection>] [-Includes <String[]>] 
    

    DESCRIPTION

    Returns all registered or a specific event receiver

    EXAMPLES

    EXAMPLE 1

    Get-PnPEventReceiver
    

    This will return all registered event receivers on the current web

    EXAMPLE 2

    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

    Get-PnPEventReceiver -Identity MyReceiver
    

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

    EXAMPLE 4

    Get-PnPEventReceiver -List "ProjectList"
    

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

    EXAMPLE 5

    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

    Get-PnPEventReceiver -List "ProjectList" -Identity MyReceiver
    

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

    EXAMPLE 7

    Get-PnPEventReceiver -Scope Site
    

    This will return all the event receivers defined on the current site collection

    EXAMPLE 8

    Get-PnPEventReceiver -Scope Web
    

    This will return all the event receivers defined on the current site

    EXAMPLE 9

    Get-PnPEventReceiver -Scope All
    

    This will return all the event receivers defined on the current site and web

    PARAMETERS

    -Connection

    Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

    Type: PnPConnection
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Identity

    The Guid of the event receiver

    Type: EventReceiverPipeBind
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    -List

    The list object from which to get the event receiver object

    Type: ListPipeBind
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Scope

    The scope of the EventReceivers to retrieve

    Type: EventReceiverScope
    Parameter Sets: Scope
    Accepted values: Web, Site, All
    
    Required: False
    Position: Named
    Default value: Web
    Accept pipeline input: False
    Accept wildcard characters: False
    

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer