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_SPUserProfileServiceApp

Spuserprofileserviceapp

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPUserProfileServiceApp 
 
# 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. 
     
.PARAMETER Name 
    Key - string 
    The name of the user profile service 
 
.PARAMETER ProxyName 
    Write - string 
    The proxy name, if not specified will be /Name of service app/ Proxy 
 
.PARAMETER ApplicationPool 
    Required - string 
    The name of the application pool to run the service app in 
 
.PARAMETER FarmAccount 
    Write - String 
    The farm account to use when provisioning the app 
 
.PARAMETER MySiteHostLocation 
    Write - string 
    The URL of the my site host collection 
 
.PARAMETER ProfileDBName 
    Write - string 
    The name of the profile database 
 
.PARAMETER ProfileDBServer 
    Write - string 
    The name of the server to host the profile database 
 
.PARAMETER SocialDBName 
    Write - string 
    The name of the social database 
 
.PARAMETER SocialDBServer 
    Write - string 
    The name of the database server to host the social database 
 
.PARAMETER SyncDBName 
    Write - string 
    The name of the sync database 
 
.PARAMETER SyncDBServer 
    Write - string 
    The name of the database server to host the sync database 
 
.PARAMETER EnableNetBIOS 
    Write - boolean 
    Whether Farm should resolve NetBIOS domain names 
 
.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 adds a new user profile service application to the local farm 
 
 
    Configuration Example  
    { 
        param( 
            [Parameter(Mandatory = $true)] 
            [PSCredential] 
            $SetupAccount, 
 
            [Parameter(Mandatory = $true)] 
            [PSCredential] 
            $FarmAccount 
        ) 
        Import-DscResource -ModuleName SharePointDsc 
 
        node localhost { 
            SPUserProfileServiceApp 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" 
                EnableNetBIOS        = $false 
                FarmAccount          = $FarmAccount 
                PsDscRunAsCredential = $SetupAccount 
            } 
        } 
    }