BREAKING CHANGE: xWebSiteDefaults: Align to best practices

CHANGELOG.md

@@ -52,11 +52,13 @@
   - Moved MSFT_xWebVirtualDirectory localization strings to strings.psd1 ([issue #477](https://github.com/PowerShell/xWebAdministration/issues/477)).
 - Changes to xWebSiteDefaults
   - Move localization strings to strings.psd1 file ([issue #475](https://github.com/PowerShell/xWebAdministration/issues/475)).
+  - BREAKING CHANGE: Changed `ApplyTo` key parameter to `IsSingleInstance` to
+  bring the resource into compliance with published best practices. ([issue #457](https://github.com/PowerShell/xWebAdministration/issues/457))
 - Changes to xWebConfigProperty
   - Move localization strings to strings.psd1 file ([issue #473](https://github.com/PowerShell/xWebAdministration/issues/473)).
 - Changes to xWebConfigPropertyCollection
   - Move localization strings to strings.psd1 file ([issue #474](https://github.com/PowerShell/xWebAdministration/issues/474)).
-  
+
 ## 2.8.0.0
 
 - Fix multiple HTTPS bindings on one xWebsite receiving the first binding's certificate [#332](https://github.com/PowerShell/xWebAdministration/issues/332)

DSCResources/MSFT_xWebSiteDefaults/MSFT_xWebSiteDefaults.psm1

@@ -19,9 +19,9 @@ function Get-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet('Machine')]
+        [ValidateSet('Yes')]
         [String]
-        $ApplyTo
+        $IsSingleInstance
     )
 
     Assert-Module
@@ -33,7 +33,7 @@ function Get-TargetResource
         TraceLogDirectory      = ( Get-Value 'siteDefaults/traceFailedRequestsLogging' 'directory')
         DefaultApplicationPool = (Get-Value 'applicationDefaults' 'applicationPool')
         AllowSubDirConfig      = (Get-Value 'virtualDirectoryDefaults' 'allowSubDirConfig')
-        ApplyTo                = 'Machine'
+        IsSingleInstance       = 'Yes'
         LogDirectory           = (Get-Value 'siteDefaults/logFile' 'directory')
     }
 
@@ -56,8 +56,8 @@ function Set-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet('Machine')]
-        [String] $ApplyTo,
+        [ValidateSet('Yes')]
+        [String] $IsSingleInstance,
 
         [Parameter()]
         [ValidateSet('W3C','IIS','NCSA','Custom')]
@@ -100,8 +100,8 @@ function Test-TargetResource
     param
     (
         [Parameter(Mandatory = $true)]
-        [ValidateSet('Machine')]
-        [String] $ApplyTo,
+        [ValidateSet('Yes')]
+        [String] $IsSingleInstance,
 
         [Parameter()]
         [ValidateSet('W3C','IIS','NCSA','Custom')]

DSCResources/MSFT_xWebSiteDefaults/MSFT_xWebSiteDefaults.schema.mof

@@ -1,7 +1,7 @@
 [ClassVersion("1.0.0"), FriendlyName("xWebSiteDefaults")] 
 class MSFT_xWebSiteDefaults : OMI_BaseResource
 {
-  [Key, Description("Dummy value because we need a key, always 'Machine'"), ValueMap{"Machine"}, Values{"Machine"}] string ApplyTo;
+  [Key, Description("Specifies the resource is a single instance, the value must be 'Yes'"), ValueMap{"Yes"}, Values{"Yes"}] String IsSingleInstance;
   [write, Description("sites/siteDefaults/logFile/logFormat"), ValueMap{"W3C","IIS","NCSA","Custom"}, Values{"W3C","IIS","NCSA","Custom"}] string LogFormat;
   [write, Description("sites/siteDefaults/logFile/directory")] string LogDirectory;
   [write, Description("sites/siteDefaults/traceFailedRequestsLogging/directory")] string TraceLogDirectory;

Examples/Resources/xIisServerDefaults/Sample_xIisServerDefaults.ps1

@@ -13,7 +13,7 @@ configuration Sample_xIISServerDefaults
     {
         xWebSiteDefaults SiteDefaults
         {
-            ApplyTo           = 'Machine'
+            IsSingleInstance  = 'Yes'
             LogFormat         = 'IIS'
             AllowSubDirConfig = 'true'
         }

Examples/Resources/xWebSiteDefaults/Sample_xWebSiteDefaults.ps1

@@ -19,7 +19,7 @@ Configuration Sample_xWebSiteDefaults
     {
         xWebSiteDefaults SiteDefaults
         {
-            ApplyTo                = 'Machine'
+            IsSingleInstance       = 'Yes'
             LogFormat              = 'IIS'
             LogDirectory           = 'C:\inetpub\logs\LogFiles'
             TraceLogDirectory      = 'C:\inetpub\logs\FailedReqLogFiles'

README.md

@@ -267,7 +267,7 @@ This resource manages the IIS configuration section locking (overrideMode) to co
 
 ### xWebAppPoolDefaults
 
-* **ApplyTo**: Required Key value, always **Machine**
+* **IsSingleInstance**: Specifies the resource is a single instance, the value must be **Yes**
 * **ManagedRuntimeVersion**: CLR Version {v2.0|v4.0|} empty string for unmanaged.
 * **ApplicationPoolIdentity**: {ApplicationPoolIdentity | LocalService | LocalSystem | NetworkService}
 
@@ -928,7 +928,7 @@ configuration Sample_IISServerDefaults
     {
          xWebSiteDefaults SiteDefaults
          {
-            ApplyTo = 'Machine'
+            IsSingleInstance = 'Yes'
             LogFormat = 'IIS'
             LogTargetW3C = 'File,ETW'
             AllowSubDirConfig = 'true'

Tests/Integration/MSFT_xWebAppPoolDefaults.config.ps1

@@ -43,7 +43,7 @@ configuration MSFT_xWebAppPoolDefaults_LogFormat
 
     xWebSiteDefaults LogFormat
     {
-        ApplyTo = 'Machine'
+        IsSingleInstance = 'Yes'
         LogFormat = $env:PesterLogFormat
     }
 }
@@ -54,7 +54,7 @@ configuration MSFT_xWebAppPoolDefaults_DefaultPool
 
     xWebSiteDefaults DefaultPool
     {
-        ApplyTo = 'Machine'
+        IsSingleInstance = 'Yes'
         DefaultApplicationPool = $env:PesterDefaultPool
     }
 }

Tests/Integration/MSFT_xWebsiteDefaults.config.ps1

@@ -18,7 +18,7 @@ configuration MSFT_xWebsiteDefaults_Config
 
     xWebSiteDefaults virtualDirectoryDefaults
     {
-        ApplyTo = 'Machine'
+        IsSingleInstance = 'Yes'
         AllowSubDirConfig = "$env:PesterVirtualDirectoryDefaults"
     }
 }