.png)
Publish-SPServiceApplication
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Shares the specified local service application outside the farm.
Publish-SPServiceApplication [-Identity] <SPServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-InfoLink <Uri>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind | Specifies the GUID of the service application to share outside the farm. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. | ||
| 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 | ||
| Description | Optional | System.String | Describes the service application to share outside the farm. If no value is specified, the value is left blank. | ||
| InfoLink | Optional | System.Uri | Specifies the link to more information about the service application to share outside the farm. If no link is specified, no link is made available. The type must be a valid URL, in the form http://server_name/Site_Name/page_name. | ||
| 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
The Publish-SPServiceApplication cmdlet publishes the local service application, specified by the Identity parameter, outside the farm.
Input Types
Return Types
------------------EXAMPLE-----------------------
Publish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 –Description "Connect to this TestServiceApplcation of you want to use FeatureA in your farm" –InfoLink http://testurl
This example publishes a service application to another farm.
The service application GUID is unique to every farm. You can run the Get-SPServiceApplication cmdlet to see the GUID of the service applications, and then use the result from the Get-SPServiceApplication cmdlet for other SPServiceApplication cmdlets; for example, Grant-SPServiceApplication.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
