Export (0) Print
Expand All
Expand Minimize

New-SPEnterpriseSearchServiceApplicationProxy

 

Applies to: SharePoint Server 2013 Standard, SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2014-08-18

Adds a new search application proxy to a farm.

New-SPEnterpriseSearchServiceApplicationProxy [[-Name] <String>] -Uri <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-MergeWithDefaultPartition <SwitchParameter>] [-Partitioned <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
New-SPEnterpriseSearchServiceApplicationProxy [[-Name] <String>] -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-MergeWithDefaultPartition <SwitchParameter>] [-Partitioned <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

This cmdlet creates a proxy for a single search service application. Via the proxy, a web application or another service consumer can use the functionality the search application provides.

 

Parameter Required Type Description

Name

Required

System.String

Specifies the display name of the search application proxy to create.

The type must be a valid string, for example, SearchAppProxy1.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application to create a proxy for.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name; or a valid SearchServiceApplication object.

NoteNote:
If you specify this parameter, you aren't required to specify the Uri parameter.

Uri

Required

System.String

Specifies the URI of the search service application to create a proxy for.

The type must be a valid URI of an endpoint address. The endpoint address is available from the search service application object, in the form $ssa.Uri.AbsoluteUri.

NoteNote:
If you specify this parameter, you aren't required to specify the SearchApplication parameter.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

NoteNote:
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.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

MergeWithDefaultPartition

Optional

System.Management.Automation.SwitchParameter

Merges the index partition for the proxy with the default index partition collection for the search service application.

Partitioned

Optional

System.Management.Automation.SwitchParameter

Specifies that the search service application must use web-hosted mode. Web-hosted mode segregates results for a given hosted subscription.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

-----------------EXAMPLE 1------------------

$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "My_SSA_Name"

$SSAProxy = New-SPEnterpriseSearchServiceApplicationProxy -name "My_SSA_Proxy" -Uri $ssa.Uri.AbsoluteURI

In this example, we create a proxy for a search service application by specifying the URI to the search service application.

In the first line, we use the Get-SPEnterpriseSearchServiceApplication cmdlet to retrieve the search service application we want to create a proxy for. In the example, the search service application has the name "My_SSA_Name". If you don't specify the search service application to retrieve, and the farm has multiple search service applications, the Get-SPEnterpriseSearchServiceApplication cmdlet returns a list of all search service applications on the farm. This causes the proxy creation in the second line to fail.

In the second line, we use the New-SPEnterpriseSearchServiceApplication cmdlet to create a proxy named "My_SSA_Proxy" for the search service application named "My_SSA_Name". Because we specify the URI to the search service application, the cmdlet uses the first parameter set. The first parameter set doesn't require us to specify the search service application object.

-----------------EXAMPLE 2------------------

$ssa = Get-SPEnterpriseSearchServiceApplication -Identity "My_SSA_Name"

$SSAProxy = New-SPEnterpriseSearchServiceApplicationProxy -name "My_SSA_Proxy" -SearchApplication $ssa

In this example, we create a proxy for a search service application by specifying the search service application object.

In the first line, we use the Get-SPEnterpriseSearchServiceApplication cmdlet to retrieve the search service application object that we want to create a proxy for. In the example, the search service application has the name "My_SSA_Name".

In the second line, we use the New-SPEnterpriseSearchServiceApplication cmdlet to create a proxy named "My_SSA_Proxy" for the search service application named "My_SSA_Name". Because we specify the search service application object, the cmdlet uses the second parameter set. The second parameter set doesn't require us to specify the URI to the search service application.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft