About Help

Choose a topic from the list on the left or search for a specific topic. Choose a topic from the list or search for a specific topic.
Cmdlets  Providers  Aliases  Modules
 

about_SPPerformancePointServiceApp

Spperformancepointserviceapp

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPPerformancePointServiceApp 
 
# 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. 
     
.PARAMETER Name 
    Key - string 
    The name of the service application 
 
.PARAMETER ProxyName 
    Write - string 
    The proxy name, if not specified will be /Name of service app/ Proxy 
 
.PARAMETER ApplicationPool 
    Required - string 
    The name of the application pool to run the service app in 
 
.PARAMETER DatabaseName 
    Write - string 
    The name of the database for the service app 
 
.PARAMETER DatabaseServer 
    Write - string 
    The name of the database server to host the database 
 
.PARAMETER Ensure 
    Write - string 
    Allowed values: Present, Absent 
    Present ensures service app exists, absent ensures it is removed 
 
.PARAMETER InstallAccount 
    Write - String 
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5 
 
 

.EXAMPLE

    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

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