Get-PnPSearchExternalConnection
SYNOPSIS
Required Permissions
- Microsoft Graph API: ExternalConnection.ReadWrite.OwnedBy, ExternalConnection.Read.All, or ExternalConnection.ReadWrite.All
Retrieves all connections to external datasources belonging to Microsoft Search
SYNTAX
Get-PnPSearchExternalConnection [-Identity <String>] [-Verbose] [-Connection <PnPConnection>]
DESCRIPTION
This cmdlet can be used to retrieve all connections to external datasources that are being indexed into Microsoft Search through a custom connector. Use Set-PnPSearchExternalItem to add items to the index for a connector.
EXAMPLES
EXAMPLE 1
Get-PnPSearchExternalConnection
This will return all connections to external datasources that are being indexed into Microsoft Search that exist within the tenant.
EXAMPLE 2
Get-PnPSearchExternalConnection -Identity "pnppowershell"
This will return the connection to the external datasource with the specified identity that is being indexed into Microsoft Search.
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
Unique identifier of the external connection in Microsoft Search. If not provided, all connections will be returned.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Verbose
When provided, additional debug statements will be shown while executing the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
RELATED LINKS
Get-PnPSearchSiteConnection - Retrieves external connections via the GCS API with detailed configuration (schema, crawl settings, identity configuration). Only returns published connections available for the connected site. Use this when you need connection details for configuring search verticals with New-PnPSearchVertical.