SPWebApplication

SPWebApplication

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
UseClassic	Write	boolean	Create the web application with Classic authentication (only used during creation of a new web application)
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
Ensure	Write	string	Present if the web app should exist, absent if it should not	Present, Absent
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

Type: Distributed

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)

The default value for the Ensure parameter is Present. When not specifying this parameter, the web application is provisioned.

NOTE: When using Host Header Site Collections, do not use the HostHeader parameter in SPWebApplication. This will set the specified host header on your IIS site and prevent the site from listening for the URL of the Host Header Site Collection. If you want to change the IIS website binding settings, please use the xWebsite resource in the xWebAdministration module.

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
                DatabaseName           = "SP_Content_01"
                DatabaseServer         = "SQL.contoso.local\SQLINSTANCE"
                Url                    = "http://example.contoso.local"
                Port                   = 80
                Ensure                 = "Present"
                PsDscRunAsCredential   = $SetupAccount
            }
        }
    }