Skip to content

SPWebApplication

Brian Farnhill edited this page Sep 21, 2016 · 20 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key string The name of the web application
ApplicationPool Required string The name of the application pool to run this site in
ApplicationPoolAccount Required string The name of the managed account to run the app pool with
Url Required string The URL of the web application
AllowAnonymous Write boolean Should anonymous access be enabled for this web app
AuthenticationMethod Write string What authentication mode should be used for the web app NTLM, Kerberos
DatabaseName Write string The name of the first content database to be created with this web app
DatabaseServer Write string The name of the database server to host the default content DB
HostHeader Write string The host header to use for the web app
Path Write string The path on the local servers to host the IIS web site from
Port Write string The port to run the site on
UseSSL Write boolean Should this web app use SSL
Ensure Write string Present if the web app should exist, absent if it should not Present, Absent
InstallAccount Write string POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

This resource is responsible for creating a web application within the local SharePoint farm. The resource will provision the web application with all of the current settings, and then ensure that it stays part of the correct application pool beyond that (additional checking and setting of properties will be added in future releases).

Examples

Example 1

This example shows how to create a new web application in the local farm

Configuration Example 
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )
    Import-DscResource -ModuleName SharePointDsc

    node localhost {
        SPWebApplication HostNameSiteCollectionWebApp
        {
            Name                   = "SharePoint Sites"
            ApplicationPool        = "SharePoint Sites"
            ApplicationPoolAccount = "CONTOSO\svcSPWebApp"
            AllowAnonymous         = $false
            AuthenticationMethod   = "NTLM"
            DatabaseName           = "SP_Content_01"
            DatabaseServer         = "SQL.contoso.local\SQLINSTANCE"
            Url                    = "http://example.contoso.local"
            Port                   = 80
            Ensure                 = "Present"
            PsDscRunAsCredential   = $SetupAccount
        }
    }
}

Clone this wiki locally