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_SPWebApplication

Spwebapplication

SharePointDSC
 

SHORT DESCRIPTION

 

.NAME

    SPWebApplication 
 
# 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 
     
.PARAMETER Name 
    Key - string 
    The name of the web application 
 
.PARAMETER ApplicationPool 
    Required - string 
    The name of the application pool to run this site in 
 
.PARAMETER ApplicationPoolAccount 
    Required - string 
    The name of the managed account to run the app pool with 
 
.PARAMETER Url 
    Required - string 
    The URL of the web application 
 
.PARAMETER AllowAnonymous 
    Write - boolean 
    Should anonymous access be enabled for this web app 
 
.PARAMETER AuthenticationMethod 
    Write - string 
    Allowed values: NTLM, Kerberos 
    What authentication mode should be used for the web app 
 
.PARAMETER DatabaseName 
    Write - string 
    The name of the first content database to be created with this web app 
 
.PARAMETER DatabaseServer 
    Write - string 
    The name of the database server to host the default content DB 
 
.PARAMETER HostHeader 
    Write - string 
    The host header to use for the web app 
 
.PARAMETER Path 
    Write - string 
    The path on the local servers to host the IIS web site from 
 
.PARAMETER Port 
    Write - string 
    The port to run the site on 
 
.PARAMETER UseSSL 
    Write - boolean 
    Should this web app use SSL 
 
.PARAMETER Ensure 
    Write - string 
    Allowed values: Present, Absent 
    Present if the web 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 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 
            } 
        } 
    }