DSCResources/DSC_WebSiteDefaults/en-US/about_WebSiteDefaults.help.txt

.NAME
    WebSiteDefaults
 
.DESCRIPTION
    The WebSiteDefaults DSC resource is used to...
 
    ## Requirements
 
    * Target machine must be running Windows Server 2012 R2 or later.
 
    ## Known issues
 
    All issues are not listed here, see https://github.com/dsccommunity/WebAdministration/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+WebSiteDefaults.
 
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Specifies the resource is a single instance, the value must be 'Yes'
 
.PARAMETER LogFormat
    Write - String
    Allowed values: W3C, IIS, NCSA, Custom
    sites/siteDefaults/logFile/logFormat
 
.PARAMETER LogDirectory
    Write - String
    sites/siteDefaults/logFile/directory
 
.PARAMETER TraceLogDirectory
    Write - String
    sites/siteDefaults/traceFailedRequestsLogging/directory
 
.PARAMETER DefaultApplicationPool
    Write - String
    sites/applicationDefaults/applicationPool
 
.PARAMETER AllowSubDirConfig
    Write - String
    Allowed values: true, false
    sites/virtualDirectoryDefaults/allowSubDirConfig
 
.EXAMPLE 1
 
An example of configuring the website default settings.
This examples show how to use WebSiteDefaults for configuring the website default settings.
 
Configuration Sample_WebSiteDefaults
{
    param
    (
        # Target nodes to apply the configuration
        [string[]]$NodeName = 'localhost'
    )
 
    # Import the module that defines custom resources
    Import-DscResource -Module WebAdministrationDsc
 
    Node $NodeName
    {
        WebSiteDefaults SiteDefaults
        {
            IsSingleInstance = 'Yes'
            LogFormat = 'IIS'
            LogDirectory = 'C:\inetpub\logs\LogFiles'
            TraceLogDirectory = 'C:\inetpub\logs\FailedReqLogFiles'
            DefaultApplicationPool = 'DefaultAppPool'
            AllowSubDirConfig = 'true'
        }
    }
}