SqlServerDsc: Minor changes too schema property descriptions (dsccomm…

…unity#1577)

- SqlServerDsc
  - Minor changes too schema property descriptions to generate documentation
    correctly.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 <!--
     Thanks for submitting a Pull Request (PR) to this project.
     Your contribution to this project is greatly appreciated!
-    
+
     Please prefix the PR title with the resource name,
     e.g. 'ResourceName: My short description'.
     If this is a breaking change, then also prefix the PR title
@@ -36,18 +36,17 @@
     everything updated as required.
 
     Change to [x] for each task in the task list that applies to your PR.
-    For those task that don't apply to you PR, leave those as is.
+    For those task that don't apply to you PR, leave those unchecked.
 -->
 - [ ] Added an entry to the change log under the Unreleased section of the
       file CHANGELOG.md. Entry should say what was changed and how that
       affects users (if applicable), and reference the issue being resolved
       (if applicable).
-- [ ] Resource documentation added/updated in README.md.
-- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
-      and comment-based help.
-- [ ] Comment-based help added/updated.
-- [ ] Localization strings added/updated in all localization files as appropriate.
-- [ ] Examples appropriately added/updated.
-- [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
-- [ ] Integration tests added/updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
-- [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).
+- [ ] Resource documentation updated in the resource's README.md.
+- [ ] Resource parameter descriptions updated in schema.mof.
+- [ ] Comment-based help updated, including parameter descriptions.
+- [ ] Localization strings updated.
+- [ ] Examples updated.
+- [ ] Unit tests updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
+- [ ] Integration tests updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
+- [ ] Code changes adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).

CHANGELOG.md

@@ -18,6 +18,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Update resource parameter documentation ([issue #1568](https://github.com/dsccommunity/SqlServerDsc/issues/1568)).
   - Documentation is now published to the GitHub Wiki.
     - Deploy task was updated with the correct name.
+  - Minor changes too schema property descriptions to generate documentation
+    correctly.
+  - Updated task list in the PULL_REQUEST_TEMPLATE.md.
   - The documentation in CONTRIBUTING.md has been somewhat updated.
   - Update documentation around design pattern for accounts that does not
     use passwords ([issue #378](https://github.com/dsccommunity/SqlServerDsc/issues/378))

source/DSCResources/DSC_SqlAG/DSC_SqlAG.schema.mof

@@ -4,8 +4,8 @@ class DSC_SqlAG : OMI_BaseResource
     [Key, Description("Specifies the name of the availability group.")] String Name;
     [Required, Description("Hostname of the SQL Server to be configured.")] String ServerName;
     [Key, Description("Name of the SQL instance to be configured.")] String InstanceName;
-    [Write, Description("Specifies if the availability group should be present or absent. Default is Present."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
-    [Write, Description("Specifies the automated backup preference for the availability group. When creating a group the default is None."), ValueMap{"Primary","SecondaryOnly","Secondary","None"}, Values{"Primary","SecondaryOnly","Secondary","None"}] String AutomatedBackupPreference;
+    [Write, Description("Specifies if the availability group should be present or absent. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("Specifies the automated backup preference for the availability group. When creating a group the default is 'None'."), ValueMap{"Primary","SecondaryOnly","Secondary","None"}, Values{"Primary","SecondaryOnly","Secondary","None"}] String AutomatedBackupPreference;
     [Write, Description("Specifies the replica availability mode. When creating a group the default is 'AsynchronousCommit'."), ValueMap{"AsynchronousCommit","SynchronousCommit"}, Values{"AsynchronousCommit","SynchronousCommit"}] String AvailabilityMode;
     [Write, Description("Specifies the desired priority of the replicas in performing backups. The acceptable values for this parameter are: integers from 0 through 100. Of the set of replicas which are online and available, the replica that has the highest priority performs the backup. When creating a group the default is 50.")] UInt32 BackupPriority;
     [Write, Description("Specifies the type of availability group is Basic. This is only available is SQL Server 2016 and later and is ignored when applied to previous versions.")] Boolean BasicAvailabilityGroup;

source/DSCResources/DSC_SqlAGReplica/DSC_SqlAGReplica.schema.mof

@@ -1,19 +1,19 @@
 [ClassVersion("1.0.0.0"), FriendlyName("SqlAGReplica")]
 class DSC_SqlAGReplica : OMI_BaseResource
 {
-    [Key, Description("The name of the availability group replica. For named instances this must be in the following format ServerName\\InstanceName.")] String Name;
+    [Key, Description("The name of the availability group replica. For named instances this must be in the following format 'ServerName\\InstanceName'.")] String Name;
     [Key, Description("The name of the availability group.")] String AvailabilityGroupName;
     [Required, Description("Hostname of the SQL Server to be configured.")] String ServerName;
     [Key, Description("Name of the SQL instance to be configured.")] String InstanceName;
     [Write, Description("Hostname of the SQL Server where the primary replica is expected to be active. If the primary replica is not found here, the resource will attempt to find the host that holds the primary replica and connect to it.")] String PrimaryReplicaServerName;
     [Write, Description("Name of the SQL instance where the primary replica lives.")] String PrimaryReplicaInstanceName;
-    [Write, Description("Specifies if the availability group replica should be present or absent. Default is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("Specifies if the availability group replica should be present or absent. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
     [Write, Description("Specifies the replica availability mode. When creating a replica the default is 'AsynchronousCommit'."), ValueMap{"AsynchronousCommit","SynchronousCommit"}, Values{"AsynchronousCommit","SynchronousCommit"}] String AvailabilityMode;
     [Write, Description("Specifies the desired priority of the replicas in performing backups. The acceptable values for this parameter are: integers from 0 through 100. Of the set of replicas which are online and available, the replica that has the highest priority performs the backup. When creating a replica the default is 50.")] UInt32 BackupPriority;
     [Write, Description("Specifies how the availability replica handles connections when in the primary role."), ValueMap{"AllowAllConnections","AllowReadWriteConnections"}, Values{"AllowAllConnections","AllowReadWriteConnections"}] String ConnectionModeInPrimaryRole;
     [Write, Description("Specifies how the availability replica handles connections when in the secondary role."), ValueMap{"AllowNoConnections","AllowReadIntentConnectionsOnly","AllowAllConnections"}, Values{"AllowNoConnections","AllowReadIntentConnectionsOnly","AllowAllConnections"}] String ConnectionModeInSecondaryRole;
     [Write, Description("Specifies the hostname or IP address of the availability group replica endpoint. When creating a group the default is the instance network name which is set in the code because the value can only be determined when connected to the SQL Instance.")] String EndpointHostName;
-    [Write, Description("Specifies the failover mode. When creating a replica the default is 'Manual'."), ValueMap{"Automatic","Manual"}, Values{"Automatic","Manual"}] String FailoverMode;
+    [Write, Description("Specifies the failover mode. When creating a replica the default value is 'Manual'."), ValueMap{"Automatic","Manual"}, Values{"Automatic","Manual"}] String FailoverMode;
     [Write, Description("Specifies the fully-qualified domain name (FQDN) and port to use when routing to the replica for read only connections.")] String ReadOnlyRoutingConnectionUrl;
     [Write, Description("Specifies an ordered list of replica server names that represent the probe sequence for connection director to use when redirecting read-only connections through this availability replica. This parameter applies if the availability replica is the current primary replica of the availability group.")] String ReadOnlyRoutingList[];
     [Write, Description("Specifies that the resource will only determine if a change is needed if the target node is the active host of the SQL Server instance.")] Boolean ProcessOnlyOnActiveNode;

source/DSCResources/DSC_SqlAgentAlert/DSC_SqlAgentAlert.schema.mof

@@ -2,8 +2,8 @@
 class DSC_SqlAgentAlert : OMI_BaseResource
 {
     [Key, Description("The name of the SQL Agent Alert.")] String Name;
-    [Write, Description("Specifies if the SQL Agent Alert should be present or absent. Default is Present."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
-    [Write, Description("The host name of the SQL Server to be configured. Default is $env:COMPUTERNAME.")] String ServerName;
+    [Write, Description("Specifies if the SQL Agent Alert should be present or absent. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;
     [Key, Description("The name of the SQL instance to be configured.")] String InstanceName;
     [Write, Description("The severity of the SQL Agent Alert.")] String Severity;
     [Write, Description("The message id of the SQL Agent Alert.")] String MessageId;

source/DSCResources/DSC_SqlAgentFailsafe/DSC_SqlAgentFailsafe.schema.mof

@@ -2,8 +2,8 @@
 class DSC_SqlAgentFailsafe : OMI_BaseResource
 {
     [Required, Description("The name of the SQL Agent Failsafe Operator.")] String Name;
-    [Write, Description("Specifies if the SQL Agent Failsafe Operator should be present or absent. Default is Present."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
-    [Write, Description("The host name of the SQL Server to be configured. Default is $env:COMPUTERNAME.")] String ServerName;
+    [Write, Description("Specifies if the SQL Agent Failsafe Operator should be present or absent. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;
     [Key, Description("The name of the SQL instance to be configured.")] String InstanceName;
-    [Write, Description("The method of notification for the Failsafe Operator. The default is none."), ValueMap{"None","NotifyEmail","Pager","NetSend","NotifyAll"}, Values{"None","NotifyEmail","Pager","NetSend","NotifyAll"}] String NotificationMethod;
+    [Write, Description("The method of notification for the Failsafe Operator. The default value is 'None'."), ValueMap{"None","NotifyEmail","Pager","NetSend","NotifyAll"}, Values{"None","NotifyEmail","Pager","NetSend","NotifyAll"}] String NotificationMethod;
 };

source/DSCResources/DSC_SqlAgentOperator/DSC_SqlAgentOperator.schema.mof

@@ -2,8 +2,8 @@
 class DSC_SqlAgentOperator : OMI_BaseResource
 {
     [Key, Description("The name of the SQL Agent Operator.")] String Name;
-    [Write, Description("Specifies if the SQL Agent Operator should be present or absent. Default is Present."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
-    [Write, Description("The host name of the SQL Server to be configured. Default is $env:COMPUTERNAME.")] String ServerName;
+    [Write, Description("Specifies if the SQL Agent Operator should be present or absent. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;
     [Key, Description("The name of the SQL instance to be configured.")] String InstanceName;
     [Write, Description("The email address to be used for the SQL Agent Operator.")] String EmailAddress;
 };

source/DSCResources/DSC_SqlDatabaseDefaultLocation/DSC_SqlDatabaseDefaultLocation.schema.mof

@@ -2,7 +2,7 @@
 class DSC_SqlDatabaseDefaultLocation : OMI_BaseResource
 {
     [Key, Description("The name of the SQL instance to be configured.")] String InstanceName;
-    [Key, Description("The type of database default location to be configured. { Data | Log | Backup }"), ValueMap{"Data","Log","Backup"}, Values{"Data","Log","Backup"}] String Type;
+    [Key, Description("The type of database default location to be configured."), ValueMap{"Data","Log","Backup"}, Values{"Data","Log","Backup"}] String Type;
     [Required, Description("The path to the default directory to be configured.")] String Path;
     [Write, Description("The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;
     [Write, Description("If set to $true then SQL Server and dependent services will be restarted if a change to the configuration is made. The default value is $false.")] Boolean RestartService;

source/DSCResources/DSC_SqlEndpointPermission/DSC_SqlEndpointPermission.schema.mof

@@ -7,6 +7,6 @@ class DSC_SqlEndpointPermission : OMI_BaseResource
     [Required, Description("The name of the endpoint.")] String Name;
     [Write, Description("The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;
     [Write, Description("If the permission should be present or absent. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
-    [Write, Description("The permission to set for the login. Valid value for permission are only 'CONNECT'."), ValueMap{"CONNECT"}, Values{"CONNECT"}] String Permission;
+    [Write, Description("The permission to set for the login. Valid value for permission is only 'CONNECT'."), ValueMap{"CONNECT"}, Values{"CONNECT"}] String Permission;
 };
 

source/DSCResources/DSC_SqlLogin/DSC_SqlLogin.schema.mof

@@ -4,7 +4,7 @@ class DSC_SqlLogin : OMI_BaseResource
     [Key, Description("The name of the login.")] String Name;
     [Key, Description("Name of the SQL instance to be configured.")] String InstanceName;
     [Write, Description("The specified login should be Present or Absent. Default is Present."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
-    [Write, Description("The type of login to be created. If LoginType is 'WindowsUser' or 'WindowsGroup' then provide the name in the format DOMAIN\\name. Default is WindowsUser. Unsupported login types are Certificate, AsymmetricKey, ExternalUser, and ExternalGroup."),
+    [Write, Description("The type of login to be created. If LoginType is 'WindowsUser' or 'WindowsGroup' then provide the name in the format DOMAIN\\name. Default is WindowsUser. The login types Certificate, AsymmetricKey, ExternalUser, and ExternalGroup are not yet implemented and will currently throw an exception if used."),
         ValueMap{"WindowsUser","WindowsGroup","SqlLogin","Certificate","AsymmetricKey","ExternalUser","ExternalGroup"},
         Values{"WindowsUser","WindowsGroup","SqlLogin","Certificate","AsymmetricKey","ExternalUser","ExternalGroup"}] String LoginType;
     [Write, Description("The hostname of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;

source/DSCResources/DSC_SqlMemory/DSC_SqlMemory.schema.mof

@@ -3,7 +3,7 @@ class DSC_SqlMemory : OMI_BaseResource
 {
     [Key, Description("The name of the SQL instance to be configured.")] String InstanceName;
     [Write, Description("The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.")] String ServerName;
-    [Write, Description("When set to 'Present' then min and max memory will be set to either the value in parameter MinMemory and MaxMemory or dynamically configured when parameter DynamicAlloc is set to $true. When set to 'Absent' min and max memory will be set to default values. Default value is Present."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("When set to 'Present' then min and max memory will be set to either the value in parameter MinMemory and MaxMemory or dynamically configured when parameter DynamicAlloc is set to $true. When set to 'Absent' min and max memory will be set to default values. Default value is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
     [Write, Description("If set to $true then max memory will be dynamically configured. When this is set parameter is set to $true, the parameter MaxMemory must be set to $null or not be configured. Default value is $false.")] Boolean DynamicAlloc;
     [Write, Description("Minimum amount of memory, in MB, in the buffer pool used by the instance of SQL Server.")] SInt32 MinMemory;
     [Write, Description("Maximum amount of memory, in MB, in the buffer pool used by the instance of SQL Server.")] SInt32 MaxMemory;

source/DSCResources/DSC_SqlProtocolTcpIp/DSC_SqlProtocolTcpIp.schema.mof

@@ -2,11 +2,11 @@
 class DSC_SqlProtocolTcpIp : OMI_BaseResource
 {
     [Key, Description("Specifies the name of the SQL Server instance to manage the IP address group for.")] String InstanceName;
-    [Key, Description("Specifies the name of the IP address group in the TCP/IP protocol, e.g. 'IP1', 'IP2' etc., or 'IPAll'.")] String IpAddressGroup;
+    [Key, Description("Specifies the name of the IP address group in the TCP/IP protocol, e.g. `'IP1'`, 'IP2' etc., or 'IPAll'.")] String IpAddressGroup;
     [Write, Description("Specifies the host name of the SQL Server to be configured. If the SQL Server belongs to a cluster or availability group specify the host name for the listener or cluster group. Default value is $env:COMPUTERNAME.")] String ServerName;
     [Write, Description("Specified if the IP address group should be enabled or disabled. Only used if the IP address group is not set to 'IPAll'. If not specified, the existing value will not be changed.")] Boolean Enabled;
     [Write, Description("Specifies the IP address for the IP adress group. Only used if the IP address group is not set to 'IPAll'. If not specified, the existing value will not be changed.")] String IpAddress;
-    [Write, Description("Specifies whether the SQL Server instance should use a dynamic port. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter TcpPort.")] Boolean UseTcpDynamicPort;
+    [Write, Description("Specifies whether the SQL Server instance should use a dynamic port. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter _TcpPort_.")] Boolean UseTcpDynamicPort;
     [Write, Description("Specifies the TCP port(s) that SQL Server should be listening on. If the IP address should listen on more than one port, list all ports as a string value with the port numbers separated with a comma, e.g. '1433,1500,1501'. This parameter is limited to 2047 characters. If not specified, the existing value will not be changed. This parameter is not allowed to be used at the same time as the parameter UseTcpDynamicPort.")] String TcpPort;
     [Write, Description("If set to $true then the any attempt by the resource to restart the service is suppressed. The default value is $false.")] Boolean SuppressRestart;
     [Write, Description("Timeout value for restarting the SQL Server services. The default value is 120 seconds.")] UInt16 RestartTimeout;