Skip to content

SPPerformancePointServiceApp

Brian Farnhill edited this page Dec 9, 2016 · 19 revisions

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
InstallAccount Write String POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

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.

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"
            InstallAccount  = $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"
            InstallAccount  = $SetupAccount
        }
    }
}
Clone this wiki locally