Examples/xPSEndpoint_RemoveConfig.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<#PSScriptInfo
.VERSION 1.0.1
.GUID 6a28a133-9d81-451b-a07f-eb9c61b4d283
.AUTHOR Microsoft Corporation
.COMPANYNAME Microsoft Corporation
.COPYRIGHT
.TAGS DSCConfiguration
.LICENSEURI https://github.com/PowerShell/xPSDesiredStateConfiguration/blob/master/LICENSE
.PROJECTURI https://github.com/PowerShell/xPSDesiredStateConfiguration
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
.EXTERNALSCRIPTDEPENDENCIES
.RELEASENOTES First version.
.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
#>


#Requires -module @{ModuleName = 'xPSDesiredStateConfiguration';ModuleVersion = '8.2.0.0'}

<#
    .SYNOPSIS
        Configuration that removes an existing session configuration endpoint.
 
    .DESCRIPTION
        Configuration that creates and registers a new session configuration
        endpoint.
 
    .PARAMETER Name
        The name of the session configuration.
 
    .EXAMPLE
        xPSEndpoint_RemoveConfig -Name 'MaintenanceShell'
 
        Compiles a configuration that removes the session configuration
        endpoint named 'MaintenanceShell'.
#>

configuration xPSEndpoint_RemoveConfig
{
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name
    )

    Import-DscResource -ModuleName 'xPSDesiredStateConfiguration'

    Node 'localhost'
    {
        xPSEndpoint 'RemoveEndpoint'
        {
            Name       = $Name
            Ensure     = 'Absent'
        }
    }
}