.png)
New-SPEnterpriseSearchServiceApplicationProxy
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard | SharePoint Foundation 2013
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>]]
Parameters
1| 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. | ||
| Uri | Required | System.String | Specifies the URI to the search application to use for search. The type must be a valid URI, in the form file:\\server_name\searchapp. | ||
| 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.
| ||
| 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 |
Note: | 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 URI to the search application to use for search. The type must be a valid URI, in the form file:\\server_name\searchapp. | ||
| 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.
| ||
| 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 |
Detailed Description
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 search service application. The search service application proxy can be used by a web application or another service consumer to use the functionality that is provided by the search application.
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.
Input Types
Return Types
------------------EXAMPLE------------------
New-SPEnterpriseSearchServiceApplicationProxy -Name MyNewProxy -SearchApplication MySSA
This example adds a search service application proxy to a search service application named MySSA.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
