SqlServiceAccount: Parameter RestartService more descriptive (#962)

- Changes to SqlServiceAccount - Made the description of parameter RestartService more descriptive (issue #960).
dsccommunity · Dec 24, 2017 · 62f7e92 · 62f7e92
1 parent 65c1dc2
commit 62f7e92
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@
 - Changes to SqlServiceAccount
   - Default services are now properly detected
     ([issue #930](https://github.com/PowerShell/SqlServerDsc/issues/930)).
+  - Made the description of parameter RestartService more descriptive
+    ([issue #960](https://github.com/PowerShell/SqlServerDsc/issues/960)).
 
 ## 10.0.0.0
 

diff --git a/DSCResources/MSFT_SqlServiceAccount/MSFT_SqlServiceAccount.psm1 b/DSCResources/MSFT_SqlServiceAccount/MSFT_SqlServiceAccount.psm1
@@ -92,7 +92,8 @@ function Get-TargetResource
         Credential of the service account that should be used.
 
     .PARAMETER RestartService
-        Determines whether the service is automatically restarted.
+        Determines whether the service is automatically restarted when a change
+        to the configuration was needed.
 
     .PARAMETER Force
         Forces the service account to be updated.
@@ -164,7 +165,8 @@ function Test-TargetResource
         Credential of the service account that should be used.
 
     .PARAMETER RestartService
-        Determines whether the service is automatically restarted.
+        Determines whether the service is automatically restarted when a change
+        to the configuration was needed.
 
     .PARAMETER Force
         Forces the service account to be updated.

diff --git a/DSCResources/MSFT_SqlServiceAccount/MSFT_SqlServiceAccount.schema.mof b/DSCResources/MSFT_SqlServiceAccount/MSFT_SqlServiceAccount.schema.mof
@@ -5,6 +5,6 @@ class MSFT_SqlServiceAccount : OMI_BaseResource
     [Key, Description("Name of the SQL instance.")] String InstanceName;
     [Key, Description("Type of service being managed."), ValueMap {"DatabaseEngine","SQLServerAgent","Search","IntegrationServices","AnalysisServices","ReportingServices","SQLServerBrowser","NotificationServices"}, Values {"DatabaseEngine","SQLServerAgent","Search","IntegrationServices","AnalysisServices","ReportingServices","SQLServerBrowser","NotificationServices"}] String ServiceType;
     [Required, EmbeddedInstance("MSFT_Credential"), Description("The service account that should be used when running the service.")] String ServiceAccount;
-    [Write, Description("Determines whether the service is automatically restarted.")] Boolean RestartService;
+    [Write, Description("Determines whether the service is automatically restarted when a change to the configuration was needed.")] Boolean RestartService;
     [Write, Description("Forces the service account to be updated. Useful for password changes.")] Boolean Force;
 };
diff --git a/Examples/Resources/SqlServiceAccount/1-ConfigureServiceAccount-UserAccount.ps1 b/Examples/Resources/SqlServiceAccount/1-ConfigureServiceAccount-UserAccount.ps1
@@ -15,7 +15,7 @@ Configuration Example
     Import-DscResource -ModuleName SqlServerDsc
 
     Node localhost {
-        SqlServiceAccount SetServiceAcccount_User
+        SqlServiceAccount SetServiceAccount_User
         {
             ServerName     = 'TestServer'
             InstanceName   = 'MSSQLSERVER'

diff --git a/Examples/Resources/SqlServiceAccount/2-ConfigureServiceAccount-VirtualAccount.ps1 b/Examples/Resources/SqlServiceAccount/2-ConfigureServiceAccount-VirtualAccount.ps1
@@ -12,18 +12,18 @@ Configuration Example
     param(
         [Parameter(Mandatory = $true)]
         [PSCredential]
-        $ServiceAcccountCredential
+        $ServiceAccountCredential
     )
 
     Import-DscResource -ModuleName SqlServerDsc
 
     Node localhost {
-        SqlServiceAccount SetServiceAcccount_User
+        SqlServiceAccount SetServiceAccount_User
         {
             ServerName     = 'TestServer'
             InstanceName   = 'DSC'
             ServiceType    = 'DatabaseEngine'
-            ServiceAccount = $ServiceAcccountCredential
+            ServiceAccount = $ServiceAccountCredential
             RestartService = $true
             Force          = $true
         }

diff --git a/README.md b/README.md
@@ -1254,7 +1254,7 @@ Manage the service account for SQL Server services.
 * **`[PSCredential]` ServiceAccount** (Required): The service account that should
   be used when running the service.
 * **`[Boolean]` RestartService** (Write): Determines whether the service is
-  automatically restarted.
+  automatically restarted when a change to the configuration was needed.
 * **`[Boolean]` Force** (Write): Forces the service account to be updated.
   Useful for password changes. This will cause `Set-TargetResource` to be run on
   each consecutive run.