SqlServerEndpoint : Add parameter "Owner"

CHANGELOG.md

@@ -38,6 +38,11 @@
   - Updated the integration test to stop the named instance while installing
     the other instances to mitigate
     [issue #1260](https://github.com/PowerShell/SqlServerDsc/issues/1260).
+- Changes to SqlServerEndpoint
+  - Add the optional parameter Owner. The default owner remains the login used
+  for the creation of the endpoint
+    ([issue #1251](https://github.com/PowerShell/SqlServerDsc/issues/1251).
+    [Maxime Daniou (@mdaniou)](https://github.com/mdaniou)
 
 ## 12.2.0.0
 

DSCResources/MSFT_SqlServerEndpoint/MSFT_SqlServerEndpoint.psm1

@@ -40,6 +40,7 @@ function Get-TargetResource
         EndpointName = ''
         Port         = ''
         IpAddress    = ''
+        Owner        = ''
     }
 
     $sqlServerObject = Connect-SQL -ServerName $ServerName -InstanceName $InstanceName
@@ -61,13 +62,15 @@ function Get-TargetResource
             $getTargetResourceReturnValues.EndpointName = $endpointObject.Name
             $getTargetResourceReturnValues.Port = $endpointObject.Protocol.Tcp.ListenerPort
             $getTargetResourceReturnValues.IpAddress = $endpointObject.Protocol.Tcp.ListenerIPAddress
+            $getTargetResourceReturnValues.Owner = $endpointObject.Owner
         }
         else
         {
             $getTargetResourceReturnValues.Ensure = 'Absent'
             $getTargetResourceReturnValues.EndpointName = ''
             $getTargetResourceReturnValues.Port = ''
             $getTargetResourceReturnValues.IpAddress = ''
+            $getTargetResourceReturnValues.Owner = ''
         }
     }
     else
@@ -101,6 +104,9 @@ function Get-TargetResource
 
     .PARAMETER IpAddress
         The network IP address the endpoint is listening on. Defaults to '0.0.0.0' which means listen on any valid IP address.
+
+    .PARAMETER Owner
+        The owner of the endpoint. Default is the login used for the creation.
 #>
 function Set-TargetResource
 {
@@ -130,7 +136,11 @@ function Set-TargetResource
 
         [Parameter()]
         [System.String]
-        $IpAddress = '0.0.0.0'
+        $IpAddress = '0.0.0.0',
+
+        [Parameter()]
+        [System.String]
+        $Owner
     )
 
     $getTargetResourceResult = Get-TargetResource -EndpointName $EndpointName -ServerName $ServerName -InstanceName $InstanceName
@@ -147,6 +157,12 @@ function Set-TargetResource
             $endpointObject.ProtocolType = [Microsoft.SqlServer.Management.Smo.ProtocolType]::Tcp
             $endpointObject.Protocol.Tcp.ListenerPort = $Port
             $endpointObject.Protocol.Tcp.ListenerIPAddress = $IpAddress
+
+            if ($PSBoundParameters.ContainsKey('Owner'))
+            {
+                $endpointObject.Owner = $Owner
+            }
+
             $endpointObject.Payload.DatabaseMirroring.ServerMirroringRole = [Microsoft.SqlServer.Management.Smo.ServerMirroringRole]::All
             $endpointObject.Payload.DatabaseMirroring.EndpointEncryption = [Microsoft.SqlServer.Management.Smo.EndpointEncryption]::Required
             $endpointObject.Payload.DatabaseMirroring.EndpointEncryptionAlgorithm = [Microsoft.SqlServer.Management.Smo.EndpointEncryptionAlgorithm]::Aes
@@ -172,6 +188,13 @@ function Set-TargetResource
                     $endpointObject.Protocol.Tcp.ListenerPort = $Port
                     $endpointObject.Alter()
                 }
+
+                if ($endpointObject.Owner -ne $Owner)
+                {
+                    Write-Verbose -Message ('Updating endpoint {0} Owner to {1}.' -f $EndpointName, $Owner)
+                    $endpointObject.Owner = $Owner
+                    $endpointObject.Alter()
+                }
             }
             else
             {
@@ -222,6 +245,9 @@ function Set-TargetResource
 
     .PARAMETER IpAddress
         The network IP address the endpoint is listening on. Defaults to '0.0.0.0' which means listen on any valid IP address.
+
+    .PARAMETER Owner
+        The owner of the endpoint. Default is the login used for the creation.
 #>
 function Test-TargetResource
 {
@@ -252,7 +278,11 @@ function Test-TargetResource
 
         [Parameter()]
         [System.String]
-        $IpAddress = '0.0.0.0'
+        $IpAddress = '0.0.0.0',
+
+        [Parameter()]
+        [System.String]
+        $Owner
     )
 
     $getTargetResourceResult = Get-TargetResource -EndpointName $EndpointName -ServerName $ServerName -InstanceName $InstanceName
@@ -262,13 +292,17 @@ function Test-TargetResource
 
         if ($getTargetResourceResult.Ensure -eq 'Present' `
                 -and (
-                $getTargetResourceResult.Port -ne $Port `
+                        $getTargetResourceResult.Port -ne $Port `
                     -or $getTargetResourceResult.IpAddress -ne $IpAddress
-            )
+                )
         )
         {
             $result = $false
         }
+        elseif ($getTargetResourceResult.Ensure -eq 'Present' -and $Owner)
+        {
+            $result = $false
+        }
     }
     else
     {

DSCResources/MSFT_SqlServerEndpoint/MSFT_SqlServerEndpoint.schema.mof

@@ -7,4 +7,5 @@ class MSFT_SqlServerEndpoint : OMI_BaseResource
     [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 network IP address the endpoint is listening on. Default the endpoint will listen on any valid IP address.")] String IpAddress;
+    [Write, Description("The owner of the endpoint. Default is the login used for the creation.")] String Owner;
 };

Examples/Resources/SqlServerEndpoint/2-CreateEndpointWithSpecificPortAndIPAddress.ps1 → Examples/Resources/SqlServerEndpoint/2-CreateEndpointWithSpecificPortIPAddressOwner.ps1

@@ -1,6 +1,6 @@
 <#
     .EXAMPLE
-        This example will add a Database Mirror endpoint with a specific listener port and a specific listener IP address.
+        This example will add a Database Mirror endpoint with specific listener port, listener IP address and owner.
 #>
 Configuration Example
 {
@@ -22,6 +22,7 @@ Configuration Example
             EndpointName         = 'HADR'
             Port                 = 9001
             IpAddress            = '192.168.0.20'
+            Owner                = 'sa'
 
             ServerName           = 'server1.company.local'
             InstanceName         = 'INST1'

README.md

@@ -1041,11 +1041,13 @@ the resource [**SqlServerEndpointPermission**](#sqlserverendpointpermission).
 * **`[String]` InstanceName** _(Key)_: The name of the SQL instance to be configured.
 * **`[String]` IpAddress** _(Write)_: The network IP address the endpoint is listening
   on. Defaults to '0.0.0.0' which means listen on any valid IP address.
+* **`[String]` Owner** _(Write)_: The owner of the endpoint. Default is the
+  login used for the creation.
 
 #### Examples
 
 * [Create an endpoint with default values](/Examples/Resources/SqlServerEndpoint/1-CreateEndpointWithDefaultValues.ps1)
-* [Create an endpoint with specific port and IP address](/Examples/Resources/SqlServerEndpoint/2-CreateEndpointWithSpecificPortAndIPAddress.ps1)
+* [Create an endpoint with specific port and IP address](/Examples/Resources/SqlServerEndpoint/2-CreateEndpointWithSpecificPortIPAddressOwner.ps1)
 * [Remove an endpoint](/Examples/Resources/SqlServerEndpoint/3-RemoveEndpoint.ps1)
 
 #### Known issues