Get-SPEnterpriseSearchServiceApplication
Returns the search service application for a farm.
Syntax
Get-SPEnterpriseSearchServiceApplication
[[-Identity] <SearchServiceApplicationPipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
Description
This cmdlet retrieves the SearchServiceApplication object.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
------------------EXAMPLE------------------
Get-SPEnterpriseSearchServiceApplication -Identity 'Search Service Application'
This example obtains a reference to a search service application named 'Search Service Application'.
Parameters
-AssignmentCollection
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.
Type: | SPAssignmentCollection |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Identity
Specifies the search service application to retrieve.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a search service application (for example, MySearchApp); or an instance of a valid SearchServiceApplication object.
Type: | SearchServiceApplicationPipeBind |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |