en-US/about_SPManagedMetaDataServiceApp.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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
.NAME
    SPManagedMetaDataServiceApp

# Description
    
    **Type:** Distributed
    
    Creates a managed metadata service application. The application pool property
    specifies which application pool it should use, and will reset the application
    back to this pool if it is changed after its initial provisioning. The
    database server and database name properties are only used during
    provisioning, and will not be altered as part of the ongoing operation of the
    set method.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the service application is provisioned.
    
    The content type hub url will be set or reset.
    
    The language settings (default and working) are only changed if they are part of
    the bound parameters. Otherwise they will not be altered.
    
.PARAMETER Name
    Key - string
    The name of the managed metadata service application

.PARAMETER ProxyName
    Write - string
    The proxy name, if not specified will be /Name of service app/ Proxy

.PARAMETER ApplicationPool
    Required - string
    The application pool that the service app will use

.PARAMETER DatabaseServer
    Write - string
    The name of the database server which will host the application

.PARAMETER DatabaseName
    Write - string
    The name of the database for the service application

.PARAMETER TermStoreAdministrators
    Write - string
    A list of the users/groups who are administrators of the term store

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present ensures service app exists, absent ensures it is removed

.PARAMETER ContentTypeHubUrl
    Write - string
    The URL of the content type hub for this app (only set when the app is provisioned)

.PARAMETER DefaultLanguage
    Write - UInt32
    The LCID of the default language (only set when the app is provisioned)

.PARAMETER Languages
    Write - UInt32
    The LCIDs of the working languages (only set when the app is provisioned)

.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 deploy the Managed Metadata service app to the local SharePoint farm.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPManagedMetaDataServiceApp ManagedMetadataServiceApp
            {
                Name              = "Managed Metadata Service Application"
                InstallAccount    = $SetupAccount
                ApplicationPool   = "SharePoint Service Applications"
                DatabaseServer    = "SQL.contoso.local"
                DatabaseName      = "SP_ManagedMetadata"
            }
        }
    }


.EXAMPLE

    This example shows how to remove a specific managed metadata service app from the 
    local SharePoint farm. Because Application pool parameter is required
    but is not acutally needed to remove the app, any text value can 
    be supplied for these as it will be ignored. 


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPManagedMetaDataServiceApp ManagedMetadataServiceApp
            {
                Name              = "Managed Metadata Service Application"
                InstallAccount    = $SetupAccount
                ApplicationPool   = "none"
                Ensure            = "Absent"
            }
        }
    }


.EXAMPLE
    This example shows how to deploy the Managed Metadata service app to the local SharePoint farm
    and also include a specific list of users to be the term store administrators.


    Configuration Example
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPManagedMetaDataServiceApp ManagedMetadataServiceApp
            {
                Name                    = "Managed Metadata Service Application"
                InstallAccount          = $SetupAccount
                ApplicationPool         = "SharePoint Service Applications"
                DatabaseServer          = "SQL.contoso.local"
                DatabaseName            = "SP_ManagedMetadata"
                TermStoreAdministrators = @(
                    "CONTOSO\user1",
                    "CONTOSO\user2"
                )
            }
        }
    }


.EXAMPLE
    This example shows how to deploy the Managed Metadata service app to the local SharePoint farm
    and also include a specific list of users to be the term store administrators.


    Configuration Example
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPManagedMetaDataServiceApp ManagedMetadataServiceApp
            {
                Name                    = "Managed Metadata Service Application"
                ApplicationPool         = "SharePoint Service Applications"
                DatabaseServer          = "SQL.contoso.local"
                DatabaseName            = "SP_ManagedMetadata"
                TermStoreAdministrators = @(
                    "CONTOSO\user1",
                    "CONTOSO\user2"
                )
                DefaultLanguage      = 1033
                Languages            = @(1031, 1033)
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to deploy the Managed Metadata service app to the local SharePoint farm
    and also include a specific list of users to be the term store administrators.


Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )
    Import-DscResource -ModuleName SharePointDsc

    node localhost {
        SPManagedMetaDataServiceApp ManagedMetadataServiceApp
        {
            Name                 = "Managed Metadata Service Application"
            PSDscRunAsCredential = $SetupAccount
            ApplicationPool      = "SharePoint Service Applications"
            DatabaseServer       = "SQL.contoso.local"
            DatabaseName         = "SP_ManagedMetadata"
            ContentTypeHubUrl    = "http://contoso.sharepoint.com/sites/ct"
        }
    }
}