Examples/xProcessSet_StopProcessConfig.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
58
59
60
61
62
63
64
65
66
67
68
<#PSScriptInfo
.VERSION 1.0.1
.GUID 215fd763-50ac-4b04-94cd-b125d6ba86d0
.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 stops one or more processes.
 
    .DESCRIPTION
        Configuration that stop one or more processes. Logs any output to the
        path 'C:\Output.log'.
 
    .PARAMETER Path
        One or more paths to the executable to stop the process for.
 
    .EXAMPLE
        xProcessSet_StopProcessConfig -Path @('C:\Windows\System32\cmd.exe', 'C:\TestPath\TestProcess.exe')
 
        Compiles a configuration that stops the processes with the executable
        at the file paths 'C:\Windows\cmd.exe' and 'C:\TestPath\TestProcess.exe'.
 
    .EXAMPLE
        Start-AzureRmAutomationDscCompilationJob -ResourceGroupName '<resource-group>' -AutomationAccountName '<automation-account>' -ConfigurationName 'xProcessSet_StopProcessConfig' -Parameters @{ Path = @('C:\Windows\System32\cmd.exe', 'C:\TestPath\TestProcess.exe') }
 
        Compiles a configuration in Azure Automation that stop the processes
        with the executable at the file paths 'C:\Windows\cmd.exe'
        and 'C:\TestPath\TestProcess.exe'.
 
        Replace the <resource-group> and <automation-account> with correct values.
#>

Configuration xProcessSet_StopProcessConfig
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String[]]
        $Path
    )

    Import-DscResource -ModuleName 'xPSDesiredStateConfiguration'

    Node localhost
    {
        xProcessSet 'StartProcess'
        {
            Path = $Path
            Ensure = 'Absent'
            StandardOutputPath = 'C:\Output.log'
        }
    }
}