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_SPAccessServiceApp

Spaccessserviceapp

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPAccessServiceApp 
 
# Description 
     
    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. 
     
.PARAMETER Name 
    Key - string 
    The name of the service application 
 
.PARAMETER ApplicationPool 
    Required - string 
    The name of the application pool to run the service app in 
 
.PARAMETER DatabaseServer 
    Required - string 
    The name of the database server to host Access Services databases 
 
.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 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

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