.png)
Set-SPServiceApplication
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Sets properties of a service application.
Set-SPServiceApplication [-Identity] <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DefaultEndpoint <SPServiceEndpointPipeBind>] [-IisWebServiceApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-ServiceApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind | Specifies the service application to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPServiceApplication object. | ||
| DefaultEndpoint | Optional | Microsoft.SharePoint.PowerShell.SPServiceEndpointPipeBind | Specifies the address of the default endpoint of the service application. | ||
| 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.
| ||
| IisWebServiceApplicationPool | Optional | Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind | Specifies the name or identity of the application pool used by the service application. The IisWebServiceApplicationPool parameter only applies to Web Service applications. | ||
| ServiceApplicationProxyGroup | Optional | Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyGroupPipeBind | Specifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If the ServiceApplicationProxyGroup parameter is not specified, the farm’s default proxy group is 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 | ||
| 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: Detailed Description
Use the Set-SPServiceApplication cmdlet to set various properties of a service application such as the default endpoint, and the application pool used by the service application.
Input Types
Return Types
---------------------EXAMPLE----------------
$serviceapp = Get-SPServiceApplication "My Service App"
Set-SPServiceApplication $serviceapp –DefaultEndpoint https
This example sets the default endpoint of the service application to be https.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
