SPPerformancePointServiceApp

SPPerformancePointServiceApp

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the service application
ProxyName	Write	String	The proxy name, if not specified will be /Name of service app/ Proxy
ApplicationPool	Required	String	The name of the application pool to run the service app in
DatabaseName	Write	String	The name of the database for the service app
DatabaseServer	Write	String	The name of the database server to host the database
Ensure	Write	String	Present ensures service app exists, absent ensures it is removed	Present, Absent
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

Description

Type: Distributed Requires CredSSP: No

This resource is responsible for creating Performance Point Service Application instances within the local SharePoint farm. The resource will provision and configure the Performance Point Service Application.

The default value for the Ensure parameter is Present. When not specifying this parameter, the service application is provisioned.

Examples

Example 1

This example creates a new performance point service app in the local farm.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPPerformancePointServiceApp PerformancePoint
        {
            Name                 = "Performance Point Service Application"
            ApplicationPool      = "SharePoint Web Services"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}

Example 2

This example removes the specific performance point service app from the local farm. The ApplicationPool parameter is still mandatory but it is not used, so the value can be anything.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPPerformancePointServiceApp PerformancePoint
        {
            Name                 = "Performance Point Service Application"
            ApplicationPool      = "n/a"
            Ensure               = "Absent"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}