-
Notifications
You must be signed in to change notification settings - Fork 107
SPSearchServiceApp
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name | Key | String | The name of the search service application | |
ProxyName | Write | String | The proxy name, if not specified will be /Name of service app/ Proxy | |
ApplicationPool | Required | String | The application pool that it should run in | |
SearchCenterUrl | Write | String | The URL of the enterprise search center site collection | |
DatabaseName | Write | String | The name of the database (noting that some search databases will use this as a prefix) | |
DatabaseServer | Write | String | The server that host the databases for this service application | |
DefaultContentAccessAccount | Write | PSCredential | The default content access account for this search service app | |
CloudIndex | Write | Boolean | Should this search service application be a cloud based service app | |
AlertsEnabled | Write | Boolean | Should alerts be enabled for this search service application | |
Ensure | Write | String | Present if the service app should exist, absent if it should not |
Present , Absent
|
InstallAccount | Write | PSCredential | POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 | |
UseSQLAuthentication | Write | Boolean | Should SQL Server authentication be used to connect to the database? | |
DatabaseCredentials | Write | PSCredential | If using SQL authentication, the SQL credentials to use to connect to the instance |
Type: Distributed Requires CredSSP: No
This resource is responsible for provisioning the search service application. The current version lets you specify the database name and server, as well as the application pool. If the application pool is changed the DSC resource will set it back as per what is set in the resource. The database name parameter is used as the prefix for all search databases (so you will end up with one for the admin database which matches the name, and then "_analyticsreportingstore", "_crawlstore" and "_linkstore" databases as well).
The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned.
NOTE: The WindowsServiceAccount parameter is deprecated and no longer does anything. The functionality for changing this account has been moved to SPSearchServiceSettings.
This example creates a new search service app in the local farm
Configuration Example
{
param
(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc
node localhost
{
SPSearchServiceApp SearchServiceApp
{
Name = "Search Service Application"
DatabaseName = "SP_Search"
ApplicationPool = "SharePoint Service Applications"
PsDscRunAsCredential = $SetupAccount
}
}
}
This example removes a search service app in the local farm. The ApplicationPool parameter is still required but is not actually used, so its value does not matter.
Configuration Example
{
param
(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc
node localhost
{
SPSearchServiceApp SearchServiceApp
{
Name = "Search Service Application"
Ensure = "Absent"
ApplicationPool = "n/a"
PsDscRunAsCredential = $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