Set-SPServiceApplication

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Sets properties of a service application.

Syntax

Set-SPServiceApplication
   [-Identity] <SPServiceApplicationPipeBind>
   [-DefaultEndpoint <SPServiceEndpointPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-IisWebServiceApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
   [-ServiceApplicationProxyGroup <SPServiceApplicationProxyGroupPipeBind>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

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.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

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
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-DefaultEndpoint

Specifies the address of the default endpoint of the service application.

Type:	SPServiceEndpointPipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

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.

Type:	SPServiceApplicationPipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-IisWebServiceApplicationPool

Specifies the name or identity of the application pool used by the service application.

The IisWebServiceApplicationPool parameter only applies to Web Service applications.

Type:	SPIisWebServiceApplicationPoolPipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-ServiceApplicationProxyGroup

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.

Type:	SPServiceApplicationProxyGroupPipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition