SqlServerNetwork: Add PsDscRunAsCredential parameter to examples (dsc…

…community#963) - Changes to SqlServerNetwork - Added sysadmin account parameter usage to the examples.
johlju · Dec 25, 2017 · 4e919b4 · 4e919b4
1 parent 62f7e92
commit 4e919b4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@
 - Changes to SqlAlias
   - Fixed issue where exception was thrown if reg keys did not exist
     ([issue #949](https://github.com/PowerShell/SqlServerDsc/issues/949)).
+- Changes to SqlServerNetwork
+  - Added sysadmin account parameter usage to the examples.
 - Changes to SqlServiceAccount
   - Default services are now properly detected
     ([issue #930](https://github.com/PowerShell/SqlServerDsc/issues/930)).

diff --git a/Examples/Resources/SqlServerNetwork/1-EnableTcpIpWithStaticPort.ps1 b/Examples/Resources/SqlServerNetwork/1-EnableTcpIpWithStaticPort.ps1
@@ -2,6 +2,7 @@
 .EXAMPLE
     This example will enable TCP/IP protocol and set the custom static port to 4509.
     When RestartService is set to $true the resource will also restart the SQL service.
+    The resource will be run as the account provided in $SystemAdministratorAccount.
 #>
 Configuration Example
 {
@@ -10,7 +11,7 @@ Configuration Example
         [Parameter(Mandatory = $true)]
         [System.Management.Automation.PSCredential]
         [System.Management.Automation.Credential()]
-        $SysAdminAccount
+        $SystemAdministratorAccount
     )
 
     Import-DscResource -ModuleName SqlServerDsc
@@ -19,12 +20,13 @@ Configuration Example
     {
         SqlServerNetwork 'ChangeTcpIpOnDefaultInstance'
         {
-            InstanceName   = 'MSSQLSERVER'
-            ProtocolName   = 'Tcp'
-            IsEnabled      = $true
-            TCPDynamicPort = $false
-            TCPPort        = 4509
-            RestartService = $true
+            InstanceName         = 'MSSQLSERVER'
+            ProtocolName         = 'Tcp'
+            IsEnabled            = $true
+            TCPDynamicPort       = $false
+            TCPPort              = 4509
+            RestartService       = $true
+            PsDscRunAsCredential = $SystemAdministratorAccount
         }
     }
 }
diff --git a/Examples/Resources/SqlServerNetwork/2-EnableTcpIpWithDynamicPort.ps1 b/Examples/Resources/SqlServerNetwork/2-EnableTcpIpWithDynamicPort.ps1
@@ -2,6 +2,7 @@
 .EXAMPLE
     This example will enable TCP/IP protocol and set the custom static port to 4509.
     When RestartService is set to $true the resource will also restart the SQL service.
+    The resource will be run as the account provided in $SystemAdministratorAccount.
 #>
 Configuration Example
 {
@@ -10,7 +11,7 @@ Configuration Example
         [Parameter(Mandatory = $true)]
         [System.Management.Automation.PSCredential]
         [System.Management.Automation.Credential()]
-        $SysAdminAccount
+        $SystemAdministratorAccount
     )
 
     Import-DscResource -ModuleName SqlServerDsc
@@ -19,11 +20,12 @@ Configuration Example
     {
         SqlServerNetwork 'ChangeTcpIpOnDefaultInstance'
         {
-            InstanceName   = 'MSSQLSERVER'
-            ProtocolName   = 'Tcp'
-            IsEnabled      = $true
-            TCPDynamicPort = $true
-            RestartService = $true
+            InstanceName         = 'MSSQLSERVER'
+            ProtocolName         = 'Tcp'
+            IsEnabled            = $true
+            TCPDynamicPort       = $true
+            RestartService       = $true
+            PsDscRunAsCredential = $SystemAdministratorAccount
         }
     }
 }