Adding new examples for the DSC resources in this module (#74)

CHANGELOG.md

@@ -5,6 +5,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- xRemoteDesktopSessionHost
+  - New examples for the resources
+
 ### Changed
 
 - xRemoteDesktopSessionHost

source/DSCResources/MSFT_xRDServer/MSFT_xRDServer.schema.mof

@@ -10,4 +10,3 @@ class MSFT_xRDServer : OMI_BaseResource
 
     [write] string GatewayExternalFqdn;
 };
-

source/DSCResources/MSFT_xRDSessionCollectionConfiguration/MSFT_xRDSessionCollectionConfiguration.psm1

@@ -398,4 +398,3 @@ function Test-TargetResource
 }
 
 Export-ModuleMember -Function *-TargetResource
-

source/Examples/README.md

@@ -2,3 +2,15 @@
 
 This will help to understand how to setup certain scenarios with the
 xRemoteDesktopSessionHost resource module.
+
+## Resource examples
+
+These are the links to the examples for each individual resource.
+
+- [xRDGatewayConfiguration](Resources/xRDGatewayConfiguration)
+- [xRDLicenseConfiguration](Resources/xRDLicenseConfiguration)
+- [xRDRemoteApp](Resources/xRDRemoteApp)
+- [xRDServer](Resources/xRDServer)
+- [xRDSessionCollection](Resources/xRDSessionCollection)
+- [xRDSessionCollectionConfiguration](Resources/xRDSessionCollectionConfiguration)
+- [xRDSessionDeployment](Resources/xRDSessionDeployment)

source/Examples/Resources/xRDGatewayConfiguration/1-CreateGatewayConfiguration.ps1

@@ -0,0 +1,22 @@
+<#
+    .DESCRIPTION
+        This example shows how to ensure that the Remote Desktop Gateway is setup.
+#>
+
+Configuration Example
+{
+    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
+
+    Node localhost {
+
+        xRDGatewayConfiguration MyGateway {
+            ConnectionBroker = 'connectionbroker.server.fqdn'
+            GatewayServer = 'gateway.server.fqdn'
+            GatewayMode = 'Automatic'
+            ExternalFqdn = 'gateway.external.fqdn'
+            LogonMethod = 'AllowUserToSelectDuringConnection'
+            UseCachedCredentials = $false
+            BypassLocal = $false
+        }
+    }
+}

source/Examples/Resources/xRDLicenseConfiguration/1-CreateLicenseServer.ps1

@@ -0,0 +1,19 @@
+<#
+    .DESCRIPTION
+        This example shows how to ensure that the Remote Desktop Licensing is setup in the correct mode.
+#>
+
+Configuration Example
+{
+
+    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
+
+    Node localhost {
+
+        xRDLicenseConfiguration MyLicenseServer {
+            ConnectionBroker = 'connectionbroker.server.fqdn'
+            LicenseMode = 'PerUser'
+            LicenseServer = 'license.server.fqdn'
+        }
+    }
+}

source/Examples/Resources/xRDRemoteApp/1-CreateRemoteApp.ps1

@@ -0,0 +1,27 @@
+<#
+    .DESCRIPTION
+        This example shows how to ensure deploy PowerShell as a RemoteApp.
+#>
+
+Configuration Example
+{
+
+    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
+
+    Node localhost {
+
+        xRDRemoteApp 'Notepad' {
+            Alias = 'PowerShell without Profile'
+            CollectionName = 'BD_Python_Apps'
+            CommandLineSetting = 'Require'
+            DisplayName = 'PowerShell'
+            FilePath = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
+            FolderName = ''
+            IconPath = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
+            RequiredCommandLine = '-noprofile'
+            ShowInWebAccess = $True
+            UserGroups = ''
+            FileVirtualPath = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
+        }
+    }
+}

source/Examples/Resources/xRDServer/1-JoinRDSHost.ps1

@@ -0,0 +1,19 @@
+<#
+    .DESCRIPTION
+        This example shows how to join a RDSH host to a deployment.
+#>
+
+Configuration Example
+{
+
+    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
+
+    Node localhost {
+
+        xRDServer RemoteDesktopSessionHost {
+            ConnectionBroker = 'connectionbroker.server.fqdn'
+            Server = 'sessionhost.server.fqdn'
+            Role = 'RDS-RD-Server'
+        }
+    }
+}

source/Examples/Resources/xRDSessionCollection/1-CreateSessionCollection.ps1

@@ -0,0 +1,19 @@
+<#
+    .DESCRIPTION
+        This example shows how to ensure a session collection is created.
+#>
+
+Configuration Example
+{
+    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
+
+    Node localhost {
+
+        xRDSessionCollection 'MyCollection' {
+            CollectionName = 'ExampleApplications'
+            SessionHost = 'sessionhost.server.fqdn'
+            ConnectionBroker = 'connectionbroker.server.fqdn'
+            CollectionDescription = 'A collection to deploy example applications'
+        }
+    }
+}

source/Examples/Resources/xRDSessionCollectionConfiguration/1-ConfigureSessionCollection.ps1

@@ -0,0 +1,36 @@
+<#
+    .DESCRIPTION
+        This example shows how to ensure a session collection is configured.
+#>
+
+Configuration Example
+{
+    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
+
+    Node localhost {
+
+        xRDSessionCollectionConfiguration 'ExampleApplications' {
+            CollectionName = 'ExampleApplications'
+            CollectionDescription = 'A collection to deploy example applications'
+            ConnectionBroker = 'connectionbroker.server.fqdn'
+            UserGroup = 'DOMAIN\AllowedUsersGroup'
+            ActiveSessionLimitMin = 0
+            BrokenConnectionAction = 'Disconnect'
+            AutomaticReconnectionEnabled = $True
+            DisconnectedSessionLimitMin = 30
+            IdleSessionLimitMin = 1440 # One day
+            TemporaryFoldersDeletedOnExit = $True
+            RDEasyPrintDriverEnabled = 0
+            MaxRedirectedMonitors = 16
+            ClientPrinterRedirected = 0
+            ClientDeviceRedirectionOptions = 'AudioVideoPlayBack, AudioRecording, Clipboard'
+            ClientPrinterAsDefault = 0
+            AuthenticateUsingNLA = $True
+            EncryptionLevel = 'High'
+            SecurityLayer = 'SSL'
+            EnableUserProfileDisk = $True
+            DiskPath = '\\file.server.fqdn\RDSProfileShare'
+            MaxUserProfileDiskSizeGB = 5
+        }
+    }
+}

source/Examples/Resources/xRDSessionDeployment/1-CreateSessionDeployment.ps1

@@ -0,0 +1,18 @@
+<#
+    .DESCRIPTION
+        This example shows how to ensure a session deployment is created.
+#>
+
+Configuration Example
+{
+    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
+
+    Node localhost {
+
+        xRDSessionDeployment RDSDeployment {
+            SessionHost = 'rdsessionhost.server.fqdn'
+            ConnectionBroker = 'connectionbroker.server.fqdn'
+            WebAccessServer =  'webaccess.server.fqdn'
+        }
+    }
+}

source/Modules/xRemoteDesktopSessionHostCommon.psd1

@@ -124,4 +124,3 @@ PrivateData = @{
 # DefaultCommandPrefix = ''
 
 }
-

source/xRemoteDesktopSessionHost.psd1

@@ -68,10 +68,3 @@
 
     } # End of PrivateData hashtable
 }
-
-
-
-
-
-
-