SqlServerDsc: Fix style of examples (#1005)

- Changes to SqlServerDsc - Style changes in all examples, removing type [System.Management.Automation.Credential()] from credential parameters (issue #1003), and renamed the credential parameter so it is not using abbreviation.
dsccommunity · Jan 9, 2018 · e8eaf91 · e8eaf91
1 parent b699be3
commit e8eaf91
Show file tree

Hide file tree

Showing 70 changed files with 195 additions and 258 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -35,6 +35,9 @@
  - Resources that did not have a description in the README.md now has one.
  - Resources that missed links to the examples in the README.md now has those
  links.
+ - Style changes in all examples, removing type [System.Management.Automation.Credential()]
+ from credential parameters ([issue #1003](https://github.com/PowerShell/SqlServerDsc/issues/1003)),
+ and renamed the credential parameter so it is not using abbreviation.
 - Changes to SqlAlias
  - Fixed issue where exception was thrown if reg keys did not exist
  ([issue #949](https://github.com/PowerShell/SqlServerDsc/issues/949)).

diff --git a/Examples/Resources/SqlAG/1-CreateAvailabilityGroup.ps1 b/Examples/Resources/SqlAG/1-CreateAvailabilityGroup.ps1
@@ -32,8 +32,8 @@ Configuration Example
 {
  param(
  [Parameter(Mandatory = $true)]
- [PSCredential]
- $SysAdminAccount
+ [System.Management.Automation.PSCredential]
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -47,7 +47,7 @@ Configuration Example
  LoginType = 'WindowsUser'
  ServerName = $Node.NodeName
  InstanceName = $Node.InstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Add the required permissions to the cluster service login
@@ -59,7 +59,7 @@ Configuration Example
  InstanceName = $Node.InstanceName
  Principal = 'NT SERVICE\ClusSvc'
  Permission = 'AlterAnyAvailabilityGroup', 'ViewServerState'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Create a DatabaseMirroring endpoint
@@ -70,7 +70,7 @@ Configuration Example
  Port = 5022
  ServerName = $Node.NodeName
  InstanceName = $Node.InstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  if ( $Node.Role -eq 'PrimaryReplica' )
@@ -83,7 +83,7 @@ Configuration Example
  InstanceName = $Node.InstanceName
  ServerName = $Node.NodeName
  DependsOn = '[SqlServerEndpoint]HADREndpoint', '[SqlServerPermission]AddNTServiceClusSvcPermissions'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
  }

diff --git a/Examples/Resources/SqlAG/2-RemoveAvailabilityGroup.ps1 b/Examples/Resources/SqlAG/2-RemoveAvailabilityGroup.ps1
@@ -32,8 +32,8 @@ Configuration Example
 {
  param(
  [Parameter(Mandatory = $true)]
- [PSCredential]
- $SysAdminAccount
+ [System.Management.Automation.PSCredential]
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -48,7 +48,7 @@ Configuration Example
  Name = 'TestAG'
  InstanceName = $Node.InstanceName
  ServerName = $Node.NodeName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
  }

diff --git a/Examples/Resources/SqlAG/3-CreateAvailabilityGroupDetailed.ps1 b/Examples/Resources/SqlAG/3-CreateAvailabilityGroupDetailed.ps1
@@ -50,8 +50,8 @@ Configuration Example
 {
  param(
  [Parameter(Mandatory = $true)]
- [PSCredential]
- $SysAdminAccount
+ [System.Management.Automation.PSCredential]
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -65,7 +65,7 @@ Configuration Example
  LoginType = 'WindowsUser'
  ServerName = $Node.NodeName
  InstanceName = $Node.InstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Add the required permissions to the cluster service login
@@ -77,7 +77,7 @@ Configuration Example
  InstanceName = $Node.InstanceName
  Principal = 'NT SERVICE\ClusSvc'
  Permission = 'AlterAnyAvailabilityGroup', 'ViewServerState'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Create a DatabaseMirroring endpoint
@@ -88,7 +88,7 @@ Configuration Example
  Port = 5022
  ServerName = $Node.NodeName
  InstanceName = $Node.InstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  if ( $Node.Role -eq 'PrimaryReplica' )
@@ -116,7 +116,7 @@ Configuration Example
  DtcSupportEnabled = $Node.DtcSupportEnabled
 
  DependsOn = '[SqlServerEndpoint]HADREndpoint', '[SqlServerPermission]AddNTServiceClusSvcPermissions'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
  }

diff --git a/Examples/Resources/SqlAGDatabase/1-AddDatabaseToAvailabilityGroup.ps1 b/Examples/Resources/SqlAGDatabase/1-AddDatabaseToAvailabilityGroup.ps1
@@ -42,8 +42,8 @@ Configuration Example
 {
  param(
  [Parameter(Mandatory = $true)]
- [PSCredential]
- $SysAdminAccount
+ [System.Management.Automation.PSCredential]
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -57,7 +57,7 @@ Configuration Example
  LoginType = 'WindowsUser'
  ServerName = $Node.NodeName
  InstanceName = $Node.SQLInstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Add the required permissions to the cluster service login
@@ -69,7 +69,7 @@ Configuration Example
  InstanceName = $Node.SqlInstanceName
  Principal = 'NT SERVICE\ClusSvc'
  Permission = 'AlterAnyAvailabilityGroup', 'ViewServerState'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Create a DatabaseMirroring endpoint
@@ -80,7 +80,7 @@ Configuration Example
  Port = 5022
  ServerName = $Node.NodeName
  InstanceName = $Node.SQLInstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  if ( $Node.Role -eq 'PrimaryReplica' )
@@ -93,7 +93,7 @@ Configuration Example
  InstanceName = $Node.SQLInstanceName
  ServerName = $Node.NodeName
  DependsOn = '[SqlServerEndpoint]HADREndpoint', '[SqlServerPermission]AddNTServiceClusSvcPermissions'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 
@@ -123,7 +123,7 @@ Configuration Example
  ServerName = $Node.NodeName
  Ensure = 'Present'
  ProcessOnlyOnActiveNode = $true
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
  }

diff --git a/Examples/Resources/SqlAGDatabase/2-RemoveDatabaseFromAvailabilityGroup.ps1 b/Examples/Resources/SqlAGDatabase/2-RemoveDatabaseFromAvailabilityGroup.ps1
@@ -38,8 +38,8 @@ Configuration Example
 {
  param(
  [Parameter(Mandatory = $true)]
- [PSCredential]
- $SysAdminAccount
+ [System.Management.Automation.PSCredential]
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -53,7 +53,7 @@ Configuration Example
  LoginType = 'WindowsUser'
  ServerName = $Node.NodeName
  InstanceName = $Node.SQLInstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Add the required permissions to the cluster service login
@@ -65,7 +65,7 @@ Configuration Example
  InstanceName = $Node.SqlInstanceName
  Principal = 'NT SERVICE\ClusSvc'
  Permission = 'AlterAnyAvailabilityGroup', 'ViewServerState'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Create a DatabaseMirroring endpoint
@@ -76,7 +76,7 @@ Configuration Example
  Port = 5022
  ServerName = $Node.NodeName
  InstanceName = $Node.SQLInstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  if ( $Node.Role -eq 'PrimaryReplica' )
@@ -89,7 +89,7 @@ Configuration Example
  InstanceName = $Node.SQLInstanceName
  ServerName = $Node.NodeName
  DependsOn = '[SqlServerEndpoint]HADREndpoint', '[SqlServerPermission]AddNTServiceClusSvcPermissions'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 
@@ -118,7 +118,7 @@ Configuration Example
  InstanceName = $Node.SQLInstanceName
  ServerName = $Node.NodeName
  Ensure = 'Absent'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
  }

diff --git a/Examples/Resources/SqlAGDatabase/3-MatchDefinedDatabaseInAvailabilityGroup.ps1 b/Examples/Resources/SqlAGDatabase/3-MatchDefinedDatabaseInAvailabilityGroup.ps1
@@ -38,8 +38,8 @@ Configuration Example
 {
  param(
  [Parameter(Mandatory = $true)]
- [PSCredential]
- $SysAdminAccount
+ [System.Management.Automation.PSCredential]
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -53,7 +53,7 @@ Configuration Example
  LoginType = 'WindowsUser'
  ServerName = $Node.NodeName
  InstanceName = $Node.SQLInstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Add the required permissions to the cluster service login
@@ -65,7 +65,7 @@ Configuration Example
  InstanceName = $Node.SqlInstanceName
  Principal = 'NT SERVICE\ClusSvc'
  Permission = 'AlterAnyAvailabilityGroup', 'ViewServerState'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  # Create a DatabaseMirroring endpoint
@@ -76,7 +76,7 @@ Configuration Example
  Port = 5022
  ServerName = $Node.NodeName
  InstanceName = $Node.SQLInstanceName
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
 
  if ( $Node.Role -eq 'PrimaryReplica' )
@@ -89,7 +89,7 @@ Configuration Example
  InstanceName = $Node.SQLInstanceName
  ServerName = $Node.NodeName
  DependsOn = '[SqlServerEndpoint]HADREndpoint', '[SqlServerPermission]AddNTServiceClusSvcPermissions'
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 
@@ -119,7 +119,7 @@ Configuration Example
  ServerName = $Node.NodeName
  Ensure = 'Present'
  Force = $true
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
  }

diff --git a/Examples/Resources/SqlAGListener/1-AddAvailabilityGroupListenerWithSameNameAsVCO.ps1 b/Examples/Resources/SqlAGListener/1-AddAvailabilityGroupListenerWithSameNameAsVCO.ps1
@@ -8,8 +8,7 @@ Configuration Example
  (
  [Parameter(Mandatory = $true)]
  [System.Management.Automation.PSCredential]
- [System.Management.Automation.Credential()]
- $SysAdminAccount
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -26,7 +25,7 @@ Configuration Example
  IpAddress = '192.168.0.73/255.255.255.0'
  Port = 5301
 
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 }
diff --git a/Examples/Resources/SqlAGListener/2-AddAvailabilityGroupListenerWithDifferentNameAsVCO.ps1 b/Examples/Resources/SqlAGListener/2-AddAvailabilityGroupListenerWithDifferentNameAsVCO.ps1
@@ -8,8 +8,7 @@ Configuration Example
  (
  [Parameter(Mandatory = $true)]
  [System.Management.Automation.PSCredential]
- [System.Management.Automation.Credential()]
- $SysAdminAccount
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -26,7 +25,7 @@ Configuration Example
  IpAddress = '192.168.0.74/255.255.255.0'
  Port = 5302
 
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 }
diff --git a/Examples/Resources/SqlAGListener/3-RemoveAvailabilityGroupListenerWithSameNameAsVCO.ps1 b/Examples/Resources/SqlAGListener/3-RemoveAvailabilityGroupListenerWithSameNameAsVCO.ps1
@@ -8,8 +8,7 @@ Configuration Example
  (
  [Parameter(Mandatory = $true)]
  [System.Management.Automation.PSCredential]
- [System.Management.Automation.Credential()]
- $SysAdminAccount
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -24,7 +23,7 @@ Configuration Example
  AvailabilityGroup = 'AvailabilityGroup-01'
  Name = 'AG-01'
 
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 }
diff --git a/Examples/Resources/SqlAGListener/4-RemoveAvailabilityGroupListenerWithDifferentNameAsVCO.ps1 b/Examples/Resources/SqlAGListener/4-RemoveAvailabilityGroupListenerWithDifferentNameAsVCO.ps1
@@ -8,8 +8,7 @@ Configuration Example
  (
  [Parameter(Mandatory = $true)]
  [System.Management.Automation.PSCredential]
- [System.Management.Automation.Credential()]
- $SysAdminAccount
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -24,7 +23,7 @@ Configuration Example
  AvailabilityGroup = 'AG-01'
  Name = "AG-01"
 
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 }
diff --git a/...esources/SqlAGListener/5-AddAvailabilityGroupListenerUsingDHCPWithDefaultServerSubnet.ps1 b/...esources/SqlAGListener/5-AddAvailabilityGroupListenerUsingDHCPWithDefaultServerSubnet.ps1
@@ -8,8 +8,7 @@ Configuration Example
  (
  [Parameter(Mandatory = $true)]
  [System.Management.Automation.PSCredential]
- [System.Management.Automation.Credential()]
- $SysAdminAccount
+ $SqlAdministratorCredential
  )
 
  Import-DscResource -ModuleName SqlServerDsc
@@ -26,7 +25,7 @@ Configuration Example
  DHCP = $true # Also not specifying parameter DHCP will default to using DHCP with the default server subnet.
  Port = 5301
 
- PsDscRunAsCredential = $SysAdminAccount
+ PsDscRunAsCredential = $SqlAdministratorCredential
  }
  }
 }