Search-TssEventPipeline - rename of Get-TssEventPipelineList

thycotic-ps · Aug 2, 2021 · e9fcf83 · e9fcf83
1 parent 1f2303b
commit e9fcf83
Show file tree

Hide file tree

Showing 3 changed files with 292 additions and 0 deletions.
diff --git a/docs/commands/event-pipeline/Search-TssEventPipeline.md b/docs/commands/event-pipeline/Search-TssEventPipeline.md
@@ -0,0 +1,159 @@
+# Search-TssEventPipeline
+
+## SYNOPSIS
+Get a list of Event Pipeline Policies
+
+## SYNTAX
+
+```
+Search-TssEventPipeline [-TssSession] <Session> [-PipelinePolicyId <Int32>] [-PipelineName <String>]
+ [-EventEntityType <EventEntityTypeId>] [-IncludeInactive] [-ExcludeActive] [-SortBy <String>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+Get a list of Event Pipeline Policies
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Search-TssEventPipeline -TssSession $session
+```
+
+Return a list of all active Event Pipeline Policies
+
+### EXAMPLE 2
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Search-TssEventPipeline -TssSession $session -IncludeInactive
+```
+
+Return a list of all active and inactive Event Pipeline Policies
+
+## PARAMETERS
+
+### -TssSession
+TssSession object created by New-TssSession for authentication
+
+```yaml
+Type: Session
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -PipelinePolicyId
+Event Pipeline Policy ID
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PipelineName
+Event Pipeline Name
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -EventEntityType
+Event Entity Type
+
+```yaml
+Type: EventEntityTypeId
+Parameter Sets: (All)
+Aliases:
+Accepted values: User, Folder, Role, RolePermission, Configuration, Group, IpAddressRange, Secret, UnlimitedAdmin, ExportSecrets, ImportSecrets, UserAudit, SecretTemplate, Licenses, ScriptPowerShell, SecretPolicy, ScriptSsh, ScriptSsql, Encryption, Site, Engine, SiteConnector, SecurityAnalyticsConfiguration, DualControl, Tls, PasswordChanger, CharacterSet, PasswordRequirement, Domain, BackupConfiguration, SecretServerSettings, AutoExport
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -IncludeInactive
+Include inactive policies
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ExcludeActive
+Exclude Active policies
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SortBy
+Sort by specific property, default EventPipelineName
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: EventPipelineName
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+### Thycotic.PowerShell.EventPipeline.List
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Search-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Search-TssEventPipeline)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Search-TssEventPipeline.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Search-TssEventPipeline.ps1)
+
diff --git a/src/functions/event-pipeline/Search-TssEventPipeline.ps1 b/src/functions/event-pipeline/Search-TssEventPipeline.ps1
@@ -0,0 +1,109 @@
+function Search-TssEventPipeline {
+    <#
+    .SYNOPSIS
+    Get a list of Event Pipeline Policies
+
+    .DESCRIPTION
+    Get a list of Event Pipeline Policies
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Search-TssEventPipeline -TssSession $session
+
+    Return a list of all active Event Pipeline Policies
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Search-TssEventPipeline -TssSession $session -IncludeInactive
+
+    Return a list of all active and inactive Event Pipeline Policies
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Search-TssEventPipeline
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Search-TssEventPipeline.ps1
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [CmdletBinding()]
+    [OutputType('Thycotic.PowerShell.EventPipeline.List')]
+    param (
+        # TssSession object created by New-TssSession for authentication
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [Thycotic.PowerShell.Authentication.Session]
+        $TssSession,
+
+        # Event Pipeline Policy ID
+        [int]
+        $PipelinePolicyId,
+
+        # Event Pipeline Name
+        [Parameter()]
+        [string]
+        $PipelineName,
+
+        # Event Entity Type
+        [Thycotic.PowerShell.Enums.EventEntityTypeId]
+        $EventEntityType,
+
+        # Include inactive policies
+        [switch]
+        $IncludeInactive,
+
+        # Exclude Active policies
+        [switch]
+        $ExcludeActive,
+
+        # Sort by specific property, default EventPipelineName
+        [string]
+        $SortBy = 'EventPipelineName'
+    )
+    begin {
+        $tssParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeTssParams $TssSession
+    }
+    process {
+        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
+        if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
+            $restResponse = $null
+            $uri = $TssSession.ApiUrl, 'event-pipeline', 'list' -join '/'
+            $uri = $uri, "sortBy[0].direction=asc&sortBy[0].name=$SortBy&take=$($TssSession.Take)" -join '?'
+
+            $filters = @()
+            switch ($tssParams.Keys) {
+                'PipelineId' { $filters += "filter.eventPipelineId=$PipelineId" }
+                'PolicyName' {$fiters += "filter.eventPipelinePolicyName=$PolicyName"}
+                'IncludeInactive' { $filters += "filter.includeInactive=$([boolean]$IncludeInactive)" }
+                'ExcludeActive' { $filters += "filter.includeActive=$([boolean]$ExcludeActive)" }
+                'FolderId' { $filters += "filter.folderId=$FolderId" }
+            }
+
+            if ($filters) {
+                $uriFilter = $filters -join '&'
+                Write-Verbose "Filters: $uriFilter"
+                $uri = $uri, $uriFilter -join '&'
+            }
+
+            $invokeParams.Uri = $uri
+            $invokeParams.Method = 'GET'
+
+            Write-Verbose "Performing the operation $($invokeParams.Method) $uri with $body"
+            try {
+                $restResponse = . $InvokeApi @invokeParams
+            } catch {
+                Write-Warning "Issue getting list of Event Pipeline"
+                $err = $_
+                . $ErrorHandling $err
+            }
+
+            if ($restResponse.records) {
+                [Thycotic.PowerShell.EventPipeline.List[]]$restResponse.records
+            }
+        } else {
+            Write-Warning "No valid session found"
+        }
+    }
+}
diff --git a/tests/event-pipeline/Search-TssEventPipeline.Tests.ps1 b/tests/event-pipeline/Search-TssEventPipeline.Tests.ps1
@@ -0,0 +1,24 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'PipelinePolicyId', 'PipelineName', 'EventEntityType', 'IncludeInactive', 'ExcludeActive', 'SortBy'
+        [object[]]$currentParams = ([Management.Automation.CommandMetaData]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')).Parameters.Keys
+        [object[]]$commandDetails = [System.Management.Automation.CommandInfo]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')
+        $unknownParameters = Compare-Object -ReferenceObject $knownParameters -DifferenceObject $currentParams -PassThru
+    }
+    Context "Verify parameters" -Foreach @{currentParams = $currentParams } {
+        It "$commandName should contain <_> parameter" -TestCases $knownParameters {
+            $_ -in $currentParams | Should -Be $true
+        }
+        It "$commandName should not contain parameter: <_>" -TestCases $unknownParameters {
+            $_ | Should -BeNullOrEmpty
+        }
+    }
+    Context "Command specific details" {
+        It "$commandName should set OutputType to Thycotic.PowerShell.EventPipeline.List" -TestCases $commandDetails {
+            $_.OutputType.Name | Should -Be 'Thycotic.PowerShell.EventPipeline.List'
+        }
+    }
+}