Skip to content

SPExcelServiceApp

Brian Farnhill edited this page Sep 21, 2016 · 21 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key string The name of the service application
ApplicationPool Required string The name of the application pool to run the service app in
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 Excel Services Application instances within the local SharePoint farm. The resource will provision and configure the Excel Services Service Application.

Examples

Example 1

This example shows how to deploy Excel Services to the local SharePoint farm.

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

    node localhost {
        SPExcelServiceApp ExcelServices
        {
            Name            = "Excel Services Service Application"
            ApplicationPool = "SharePoint Service Applications"
            InstallAccount  = $SetupAccount
        }
    }
}

Example 2

This example shows how to remove Excel Services from the local SharePoint farm. Here application pool is a required parameter, but it is not actually used when removing a service app and as such can be ignored and set to any value.

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

    node localhost {
        SPExcelServiceApp ExcelServices
        {
            Name            = "Excel Services Service Application"
            ApplicationPool = "n/a"
            Ensure          = "Absent"
            InstallAccount  = $SetupAccount
        }
    }
}
Clone this wiki locally