Edit

Share via


Get-SPEnterpriseSearchCrawlLogReadPermission

Retrieves the list of users with permission to access the crawl log information.

Syntax

Default (Default)

Get-SPEnterpriseSearchCrawlLogReadPermission
    -SearchApplication <SearchServiceApplicationPipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Tenant <Guid>]
    [<CommonParameters>]

Description

Only the Search Service Application administrator can use the Get-SPEnterpriseSearchCrawlLogReadPermission cmdlet.

The Search Service Application administrator uses the cmdlet to retrieve a list of users with permission to view the crawl log information. The administrator can choose to limit this list to users with permission to view crawl log information from a particular tenant.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

EXAMPLE

$ssa = Get-SPEnterpriseSearchServiceApplication
Get-SPEnterpriseSearchCrawlLogReadPermission -SearchApplication $ssa -Tenant '00000000-0000-0000-0000-000000000001'

This example retrieves a list of users who have permission to view the crawl log information for a tenant with id '00000000-0000-0000-0000-000000000001' on the search application referenced by $ssa.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-SearchApplication

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the name of the search application for which to list crawl log permissions. The type must be a valid GUID, of the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object.

Parameter properties

Type:SearchServiceApplicationPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Tenant

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies that the list of users shall be within the scope of this tenant. The type must be a valid GUID of the form 12345678-90ab-cdef-1234-567890bcdefgh.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.