Get-SPEnterpriseSearchAdministrationComponent

Returns the administration component for a search service application.

Syntax

Get-SPEnterpriseSearchAdministrationComponent
   [-AssignmentCollection <SPAssignmentCollection>]
   -SearchApplication <SearchServiceApplicationPipeBind>
   [<CommonParameters>]

Description

The Get-SPEnterpriseSearchAdmininstrationComponent cmdlet retrieves an administration component for a search service application in order to update or delete it.

For permissions and the most current information about search cmdlets, see the online documentation, https://go.microsoft.com/fwlink/?LinkId=163185.

Examples

Example 1

$ssa = Get-SPEnterpriseSearchServiceApplication 'Search Service Application'
Get-SPEnterpriseSearchAdministrationComponent -SearchApplication $ssa

This example obtains an object reference to the administration component of 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-SearchApplication

Specifies the search application that contains the administration component.

The type must be a valid name (GUID), in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SearchServiceApplication object.

Type:SearchServiceApplicationPipeBind
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Inputs

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object