-
Notifications
You must be signed in to change notification settings - Fork 108
SPPublishServiceApplication
Brian Farnhill edited this page Sep 21, 2016
·
18 revisions
Parameters
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Name | Key | string | The name of the service application to publish | |
| Ensure | Write | string | Present to ensure it runs on this server, or absent to ensure it is stopped | Present, Absent |
| InstallAccount | Write | String | POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 |
Description
This resource is used to specify if a specific service application should be published (Ensure = "Present") or not published (Ensure = "Absent") on the current server. The name is the display name of the service application as shown in the Central Admin website.
You can publish the following service applications in a SharePoint Server 2013/2016 farm:
- Business Data Connectivity
- Machine Translation
- Managed Metadata
- User Profile
- Search
- Secure Store
Source: https://technet.microsoft.com/en-us/library/ff621100(v=office.15).aspx
Examples
Example 1
This example shows how to ensure that the managed metadata service is published within the farm.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc
node localhost {
SPPublishServiceApplication PublishManagedMetadataServiceApp
{
Name = "Managed Metadata Service Application"
Ensure = "Present"
InstallAccount = $SetupAccount
}
}
}
Example 2
This example shows how to ensure that the Secure Store Service is not published within the farm.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc
node localhost {
SPPublishServiceApplication UnpublishSecureStoreServiceApp
{
Name = "Secure Store Service Application"
Ensure = "Absent"
InstallAccount = $SetupAccount
}
}
}

- Home
- Getting Started
- Pre-requisites
- Installing the module
- Exporting SharePoint Configuration
- Creating Configuration Files
- Pre-created Examples
- Creating an Azure development environment
- Understanding Resources & Syntax
- Remote PowerShell Authentication
- Contributing to SharePointDsc
- Other useful modules for SharePoint DSC configurations