Get-SPEnterpriseSearchServiceApplicationProxy

Returns the search service application proxy.

Syntax

Get-SPEnterpriseSearchServiceApplicationProxy
   [[-Identity] <SearchServiceApplicationProxyPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

This cmdlet reads the SearchServiceApplicationProxy object when the search service application proxy is created updated or deleted. If the Identity parameter is not specified, this cmdlet returns the search service application proxy collection for the farm.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

------------------EXAMPLE------------------

C:\PS>$ssaProxy = Get-SPEnterpriseSearchServiceApplicationProxy -Identity SsaProxy

This example obtains a reference to a search service application proxy with the name SsaProxy.

Optional 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
-Identity

Specifies the search service application proxy 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 proxy (for example, SearchServiceAppProxy1); or an instance of a valid SearchServiceApplicationProxy object.

Type:SearchServiceApplicationProxyPipeBind
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016