modules/deploy/dsc/ext/PsGallery/xSharePoint.0.10.0.0/en-us/about_xSPUserProfileServiceApp.help.txt

NAME
    xSPUserProfileServiceApp

PARAMETERS
    Name (Key, string)
    ApplicationPool (Required, string)
    FarmAccount (Required, String)
    InstallAccount (Write, String)
    MySiteHostLocation (Write, string)
    ProfileDBName (Write, string)
    ProfileDBServer (Write, string)
    SocialDBName (Write, string)
    SocialDBServer (Write, string)
    SyncDBName (Write, string)
    SyncDBServer (Write, string)

DESCRIPTION

This resource will provision an instance of the user profile service to the farm.
It creates the required databases using the parameters that are passed in to it (although these are only used during the initial provisioning).
The farm account is used during the provisioning of the service only (in the set method), and the install account is used in the get and test methods.
This is done to ensure that the databases are created with the correct schema owners and allow the user profile sync service to operate correctly.

EXAMPLE

    xSPUserProfileServiceApp UserProfileServiceApp
    {
        Name = "User Profile Service Application"
        ApplicationPool = "SharePoint Service Applications"
        MySiteHostLocation = "http://my.sharepoint.contoso.local"
        ProfileDBName = "SP_UserProfiles"
        ProfileDBServer = "SQL.contoso.local\SQLINSTANCE"
        SocialDBName = "SP_Social"
        SocialDBServer = "SQL.contoso.local\SQLINSTANCE"
        SyncDBName = "SP_ProfileSync"
        SyncDBServer = "SQL.contoso.local\SQLINSTANCE"
        FarmAccount = $FarmAccount
        PsDscRunAsCredential = $SetupAccount
    }