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_SPStateServiceApp

Spstateserviceapp

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPStateServiceApp 
 
# Description 
     
    This resource provisions an instance of the state service in to the local farm. 
    The database specific parameters are only used during initial provisioning of 
    the app, and will not change database settings beyond the initial deployment. 
     
.PARAMETER Name 
    Key - string 
    The name of the state service app 
 
.PARAMETER DatabaseCredentials 
    Write - String 
    The database credentials for accessing the database 
 
.PARAMETER DatabaseName 
    Required - string 
    The name of the database for the service app 
 
.PARAMETER DatabaseServer 
    Write - string 
    The name of the database server 
 
.PARAMETER Ensure 
    Write - string 
    Allowed values: Present, Absent 
    Present if the service app should exist, absent if it should not 
 
.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 state service application in the local farm 
 
 
    Configuration Example  
    { 
        param( 
            [Parameter(Mandatory = $true)] 
            [PSCredential] 
            $SetupAccount 
        ) 
        Import-DscResource -ModuleName SharePointDsc 
 
        node localhost { 
            SPStateServiceApp StateServiceApp 
            { 
                Name                 = "State Service Application" 
                DatabaseName         = "SP_State" 
                Ensure               = "Present" 
                PsDscRunAsCredential = $SetupAccount 
            } 
        } 
    }