en-US/about_SPPublishServiceApplication.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
.NAME
    SPPublishServiceApplication

# Description
    
    **Type:** Distributed
    
    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
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the service application is provisioned.
    
.PARAMETER Name
    Key - string
    The name of the service application to publish

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present to ensure it runs on this server, or absent to ensure it is stopped

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


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