Merge pull request #1214 from PowerShell/dev

Release of version 12.0.0.0 of SqlServerDsc

.github/ISSUE_TEMPLATE/General.md

@@ -0,0 +1,7 @@
+---
+name: General question or documentation update
+about: If you have a general question or documentation update suggestion around the resource module.
+---
+<!--
+    Your feedback and support is greatly appreciated, thanks for contributing!
+-->

.github/ISSUE_TEMPLATE/Problem_with_resource.md

@@ -0,0 +1,73 @@
+---
+name: Problem with a resource
+about: If you have a problem, bug, or enhancement with a resource in this resource module.
+---
+<!--
+    Your feedback and support is greatly appreciated, thanks for contributing!
+
+    ISSUE TITLE:
+    Please prefix the issue title with the resource name, e.g.
+    'ResourceName: Short description of my issue'
+
+    ISSUE DESCRIPTION (this template):
+    Please provide information regarding your issue under each header below.
+    Write N/A under any headers that do not apply to your issue, or if the
+    information is not available.
+
+    NOTE! Sensitive information should be obfuscated.
+
+    PLEASE KEEP THE HEADERS.
+
+    You may remove this comment block, and the other comment blocks,
+    but please keep the headers.
+-->
+#### Details of the scenario you tried and the problem that is occurring
+
+#### Verbose logs showing the problem
+
+#### Suggested solution to the issue
+
+#### The DSC configuration that is used to reproduce the issue (as detailed as possible)
+```powershell
+# insert configuration here
+```
+
+#### SQL Server edition and version the target node is running
+<!--
+    To help with this information, please run this command in SQL:
+    select @@version
+-->
+
+#### SQL Server PowerShell modules present on the target node
+<!--
+    To help with this information, please run this command:
+    Get-Module -Name '*sql*' -ListAvailable | ? Name -ne 'SqlServerDsc' | ft Name,Version,Path
+-->
+
+#### The operating system the target node is running
+<!--
+    Please provide as much as possible about the target node, for example
+    edition, version, build and language.
+    On OS with WMF 5.1 the following command can help get this information.
+
+    Get-ComputerInfo -Property @(
+        'OsName',
+        'OsOperatingSystemSKU',
+        'OSArchitecture',
+        'WindowsVersion',
+        'WindowsBuildLabEx',
+        'OsLanguage',
+        'OsMuiLanguages')
+-->
+
+#### Version and build of PowerShell the target node is running
+<!--
+    To help with this information, please run this command:
+    $PSVersionTable
+-->
+
+#### Version of the DSC module that was used ('dev' if using current dev branch)
+<!--
+    To help with this information, please run this command:
+    Get-Module -Name 'SqlServerDsc' -ListAvailable | ft Name,Version,Path
+-->

.github/ISSUE_TEMPLATE/Resource_proposal.md

@@ -0,0 +1,21 @@
+---
+name: New resource proposal
+about: If you have a new resource proposal that you think should be added to this resource module.
+---
+<!--
+    Thank you for contributing and making this resource module better!
+
+    ISSUE TITLE:
+    Please prefix the issue title with a proposed resource name,
+    e.g. 'NewResourceName: New resource proposal'
+
+    ISSUE DESCRIPTION (this template):
+    Please propose the new resource under each header below.
+
+    PLEASE KEEP THE HEADERS, but you may remove this comment block.
+-->
+### Description
+
+### Proposed properties
+
+### Special considerations or limitations

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,48 +6,45 @@
     at https://github.com/PowerShell/SqlServerDsc#contributing.
 
     Please prefix the PR title with the resource name,
-    i.e. 'SqlSetup: My short description'.
+    e.g. 'ResourceName: My short description'.
     If this is a breaking change, then also prefix the PR title
     with 'BREAKING CHANGE:',
-    i.e. 'BREAKING CHANGE: SqlSetup: My short description'.
+    e.g. 'BREAKING CHANGE: ResourceName: My short description'.
 
-    You may remove this and the other comments, but please keep the headers
-    and the task list.
+    You may remove this comment block, and the other comment blocks, but please
+    keep the headers and the task list.
 -->
 #### Pull Request (PR) description
 <!--
-    Replace this comment with a description of your pull request.
+    Replace this comment block with a description of your PR.
 -->
 
 #### This Pull Request (PR) fixes the following issues
 <!--
-    Replace this comment with the list of issues or n/a.
-    Use format:
-    Fixes #123
-    Fixes #124
+    If this PR does not fix an open issue, replace this comment block with None.
+    If this PR resolves one or more open issues, replace this comment block with
+    a list the issues using a GitHub closing keyword, e.g.:
+    - Fixes #123
+    - Fixes #124
 -->
 
 #### Task list
 <!--
-    To aid community reviewers in reviewing and merging your pull request (PR),
-    please take the time to run through the below checklist.
+    To aid community reviewers in reviewing and merging your PR, please take
+    the time to run through the below checklist and make sure your PR has
+    everything updated as required.
 
-    Change to [x] for each task in the task list that applies to your pull
-    request (PR). For those task that don't apply to you pull request (PR),
-    leave those as is.
+    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.
 -->
-- [ ] Added an entry under the Unreleased section in the CHANGELOG.md? Entry
-      should say what was changed, and how that affects users (if applicable).
-- [ ] Resource documentation added/updated in README.md?
+- [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
+      Entry should say what was changed, and how that affects users (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 Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
-- [ ] Integration tests added/updated (where possible)?
-      See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
-- [ ] New/changed code adheres to
-      [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md)
-      and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md)?
+      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 Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
+- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
+- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md).

CHANGELOG.md

@@ -2,6 +2,29 @@
 
 ## Unreleased
 
+## 12.0.0.0
+
+- Changes to SqlServerDatabaseMail
+  - DisplayName is now properly treated as display name
+    for the originating email address ([issue #1200](https://github.com/PowerShell/SqlServerDsc/issue/1200)).
+    [Nick Reilingh (@NReilingh)](https://github.com/NReilingh)
+    - DisplayName property now defaults to email address instead of server name.
+    - Minor improvements to documentation.
+- Changes to SqlAGDatabase
+  - Corrected reference to "PsDscRunAsAccount" in documentation
+    ([issue #1199](https://github.com/PowerShell/SqlServerDsc/issues/1199)).
+    [Nick Reilingh (@NReilingh)](https://github.com/NReilingh)
+- Changes to SqlDatabaseOwner
+  - BREAKING CHANGE: Support multiple instances on the same node.
+    The parameter InstanceName is now Key and cannot be omitted
+    ([issue #1197](https://github.com/PowerShell/SqlServerDsc/issues/1197)).
+- Changes to SqlSetup
+  - Added new parameters to allow to define the startup types for the Sql Engine
+    service, the Agent service, the Analysis service and the Integration Service.
+    The new optional parameters are respectively SqlSvcStartupType, AgtSvcStartupType,
+    AsSvcStartupType, IsSvcStartupType and RsSvcStartupType ([issue #1165](https://github.com/PowerShell/SqlServerDsc/issues/1165).
+    [Maxime Daniou (@mdaniou)](https://github.com/mdaniou)
+
 ## 11.4.0.0
 
 - Changes to SqlServerDsc

DSCResources/MSFT_SqlAGDatabase/MSFT_SqlAGDatabase.schema.mof

@@ -8,7 +8,7 @@ class MSFT_SqlAGDatabase : OMI_BaseResource
     [Required, Description("The path used to seed the availability group replicas. This should be a path that is accessible by all of the replicas")] String BackupPath;
     [Write, Description("Specifies the membership of the database(s) in the availability group. The options are: Present: The defined database(s) are added to the availability group. All other databases that may be a member of the availability group are ignored. Absent: The defined database(s) are removed from the availability group. All other databases that may be a member of the availability group are ignored. The default is 'Present'."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
     [Write, Description("When used with 'Ensure = 'Present'' it ensures the specified database(s) are the only databases that are a member of the specified Availability Group. This parameter is ignored when 'Ensure' is 'Absent'.")] Boolean Force;
-    [Write, Description("If set to $true, this ensures the database owner of the database on the primary replica is the owner of the database on all secondary replicas. This requires the database owner is available as a login on all replicas and that the PSDscRunAsAccount has impersonate permissions. If set to $false, the owner of the database will be the PSDscRunAsAccount. The default is '$true'")] Boolean MatchDatabaseOwner;
+    [Write, Description("If set to $true, this ensures the database owner of the database on the primary replica is the owner of the database on all secondary replicas. This requires the database owner is available as a login on all replicas and that the PsDscRunAsCredential has impersonate permissions. If set to $false, the owner of the database will be the PsDscRunAsCredential. The default is '$true'")] Boolean MatchDatabaseOwner;
     [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;
     [Read, Description("Determines if the current node is actively hosting the SQL Server instance.")] Boolean IsActiveNode;
 };

DSCResources/MSFT_SqlDatabaseOwner/MSFT_SqlDatabaseOwner.psm1

@@ -38,10 +38,10 @@ function Get-TargetResource
         [System.String]
         $ServerName = $env:COMPUTERNAME,
 
-        [Parameter()]
+        [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
-        $InstanceName = 'MSSQLSERVER'
+        $InstanceName
     )
 
     Write-Verbose -Message "Getting owner of database $Database"
@@ -116,10 +116,10 @@ function Set-TargetResource
         [System.String]
         $ServerName = $env:COMPUTERNAME,
 
-        [Parameter()]
+        [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
-        $InstanceName = 'MSSQLSERVER'
+        $InstanceName
     )
 
     Write-Verbose -Message "Setting owner $Name of database $Database"
@@ -191,10 +191,10 @@ function Test-TargetResource
         [System.String]
         $ServerName = $env:COMPUTERNAME,
 
-        [Parameter()]
+        [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
-        $InstanceName = 'MSSQLSERVER'
+        $InstanceName
     )
 
     Write-Verbose -Message "Testing owner $Name of database $Database"

DSCResources/MSFT_SqlDatabaseOwner/MSFT_SqlDatabaseOwner.schema.mof

@@ -4,5 +4,5 @@ class MSFT_SqlDatabaseOwner : OMI_BaseResource
     [Key, Description("The name of database to be configured.")] String Database;
     [Required, Description("The name of the login that will become a owner of the desired sql database.")] String Name;
     [Write, Description("The host name of the SQL Server to be configured.")] String ServerName;
-    [Write, Description("The name of the SQL instance to be configured.")] String InstanceName;
+    [Key, Description("The name of the SQL instance to be configured.")] String InstanceName;
 };

DSCResources/MSFT_SqlServerDatabaseMail/MSFT_SqlServerDatabaseMail.psm1

@@ -29,7 +29,7 @@ $script:localizedData = Get-LocalizedData -ResourceName 'MSFT_SqlServerDatabaseM
         sent.
 
     .PARAMETER ProfileName
-        The profile name of the Database Mail.
+        The name of the Database Mail profile.
 #>
 function Get-TargetResource
 {
@@ -205,18 +205,18 @@ function Get-TargetResource
         sent.
 
     .PARAMETER ProfileName
-        The profile name of the Database Mail.
+        The name of the Database Mail profile.
 
     .PARAMETER DisplayName
-        The display name of the outgoing mail server. Default value is the same
-        value assigned to parameter MailServerName.
+        The display name of the originating e-mail address.
+        Default value is the same value assigned to the EmailAddress parameter.
 
     .PARAMETER ReplyToAddress
         The e-mail address to which the receiver of e-mails will reply to.
         Default value is the same e-mail address assigned to parameter EmailAddress.
 
     .PARAMETER Description
-        The description of the Database Mail.
+        The description for the Database Mail profile and account.
 
     .PARAMETER LoggingLevel
         The logging level that the Database Mail will use. If not specified the
@@ -267,7 +267,7 @@ function Set-TargetResource
 
         [Parameter()]
         [System.String]
-        $DisplayName = $MailServerName,
+        $DisplayName = $EmailAddress,
 
         [Parameter()]
         [System.String]
@@ -606,18 +606,17 @@ function Set-TargetResource
         sent.
 
     .PARAMETER ProfileName
-        The profile name of the Database Mail.
+        The name of the Database Mail profile.
 
     .PARAMETER DisplayName
-        The display name of the outgoing mail server. Default value is the same
-        value assigned to parameter MailServerName.
+        The display name of the originating e-mail address.
 
     .PARAMETER ReplyToAddress
         The e-mail address to which the receiver of e-mails will reply to.
         Default value is the same e-mail address assigned to parameter EmailAddress.
 
     .PARAMETER Description
-        The description of the Database Mail.
+        The description for the Database Mail profile and account.
 
     .PARAMETER LoggingLevel
         The logging level that the Database Mail will use. If not specified the
@@ -664,7 +663,7 @@ function Test-TargetResource
 
         [Parameter()]
         [System.String]
-        $DisplayName = $MailServerName,
+        $DisplayName = $EmailAddress,
 
         [Parameter()]
         [System.String]