SPAccessServiceApp

SPAccessServiceApp

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
DatabaseServer	Required	String	The name of the database server to host Access Services databases
Ensure	Write	String	Present ensures service app exists, absent ensures it is removed	Present, Absent

Description

Type: Distributed Requires CredSSP: No

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

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

NOTE: Since SharePoint Server Subscription Edition the Access Services does no longer exists. See What's deprecated or removed from SharePoint Server 2019 for more info.

Examples

Example 1

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

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

        Import-DscResource -ModuleName SharePointDsc

        node localhost
        {
            SPAccessServiceApp AccessServices
            {
                Name                 = "Access Services Service Application"
                ApplicationPool      = "SharePoint Service Applications"
                DatabaseServer       = "SQL.contoso.local\SQLINSTANCE"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }

Example 2

This example shows how to remove a specific Access Services 2013 from the local SharePoint farm. Because Application pool and database server are both required parameters, but are not acutally needed to remove the app, any text value can be supplied for these as they will be ignored.

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

        Import-DscResource -ModuleName SharePointDsc

        node localhost
        {
            SPAccessServiceApp AccessServices
            {
                Name                 = "Access Services Service Application"
                ApplicationPool      = "n/a"
                DatabaseServer       = "n/a"
                Ensure               = "Absent"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }