Search-TssIpRestrictionGroup - new command to search IP Address Restr…

…ictions assigned to Groups

docs/commands/ipaddress-restrictions/Search-TssIpRestrictionGroup.md

@@ -0,0 +1,113 @@
+# Search-TssIpRestrictionGroup
+
+## SYNOPSIS
+Search IP Address restrictions assigned to groups.
+
+## SYNTAX
+
+```
+Search-TssIpRestrictionGroup [-TssSession] <Session> [-IpAddressRestrictionId <Int32>] [-GroupId <Int32>]
+ [-SortBy <String>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Search IP Address restrictions assigned to groups.
+Search based on Group Id or IP Address Restriction Id.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Search-TssIpRestrictionGroup -TssSession $session -Id 5
+```
+
+Return groups assigned to IP Address restriction 5
+
+### EXAMPLE 2
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Search-TssIpRestrictionGroup -TssSession $session -GroupId 46
+```
+
+Return IP Address restrictions assigned to Group ID 46
+
+## 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
+```
+
+### -IpAddressRestrictionId
+IP Address Restriction
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -GroupId
+Group ID
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SortBy
+Sort by specific property, default IpAddressRestrictionId
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: IpAddressRestrictionId
+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.IpRestrictions.Group
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/ipaddress-restrictions/Search-TssIpRestrictionGroup](https://thycotic-ps.github.io/thycotic.secretserver/commands/ipaddress-restrictions/Search-TssIpRestrictionGroup)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/ipaddress-restrictions/Search-TssIpRestrictionGroup.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/ipaddress-restrictions/Search-TssIpRestrictionGroup.ps1)
+

src/Thycotic.SecretServer.Format.ps1xml

@@ -3317,5 +3317,39 @@
       </TableControl>
     </View>
 
+    <!-- Thycotic.PowerShell.IpRestrictions.Group -->
+    <View>
+      <Name>IpRestrictions.Group</Name>
+      <ViewSelectedBy>
+        <TypeName>Thycotic.PowerShell.IpRestrictions.Group</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>IpAddressRestrictionId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>IpAddressRestrictionName</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>GroupId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>GroupName</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
+
   </ViewDefinitions>
 </Configuration>

src/Thycotic.SecretServer/classes/ipaddress-restrictions/Group.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Threading.Tasks;
+using System.Management.Automation;
+using System.Management.Automation.Runspaces;
+
+namespace Thycotic.PowerShell.IpRestrictions
+{
+    public class Group
+    {
+        public int GroupId { get; set; }
+        public string GroupName { get; set; }
+        public int Id { get; set; }
+        public int IpAddressRestrictionId { get; set; }
+        public string IpAddressRestrictionName { get; set; }
+    }
+}

src/functions/ipaddress-restrictions/Search-TssIpRestrictionGroup.ps1

@@ -0,0 +1,88 @@
+function Search-TssIpRestrictionGroup {
+    <#
+    .SYNOPSIS
+    Search IP Address restrictions assigned to groups.
+
+    .DESCRIPTION
+    Search IP Address restrictions assigned to groups. Search based on Group Id or IP Address Restriction Id.
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/ipaddress-restrictions/Search-TssIpRestrictionGroup
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/ipaddress-restrictions/Search-TssIpRestrictionGroup.ps1
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Search-TssIpRestrictionGroup -TssSession $session -Id 5
+
+    Return groups assigned to IP Address restriction 5
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Search-TssIpRestrictionGroup -TssSession $session -GroupId 46
+
+    Return IP Address restrictions assigned to Group ID 46
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [CmdletBinding()]
+    [OutputType('Thycotic.PowerShell.IpRestrictions.Group')]
+    param (
+        # TssSession object created by New-TssSession for authentication
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [Thycotic.PowerShell.Authentication.Session]
+        $TssSession,
+
+        # IP Address Restriction
+        [int]
+        $IpAddressRestrictionId,
+
+        # Group ID
+        [int]
+        $GroupId,
+
+        # Sort by specific property, default IpAddressRestrictionId
+        [string]
+        $SortBy = 'IpAddressRestrictionId'
+    )
+    begin {
+        $tssParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeApiParams $TssSession
+    }
+    process {
+        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
+        if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            . $CheckVersion $TssSession '10.9.000064' $PSCmdlet.MyInvocation
+            if ($tssParams.ContainsKey('IpAddressRestrictionId')) {
+                $uri = $TssSession.ApiUrl, 'ipaddress-restrictions', $IpAddressRestrictionId, 'groups' -join '/'
+            }
+            if ($tssParams.ContainsKey('GroupId')) {
+                $uri = $TssSession.ApiUrl, 'groups', $GroupId, 'ipaddress-restrictions' -join '/'
+            }
+            $uri = $uri, "sortBy[0].direction=asc&sortBy[0].name=$SortBy&take=$($TssSession.Take)" -join '?'
+            $invokeParams.Method = 'GET'
+            $invokeParams.Uri = $uri
+
+            Write-Verbose "Performing the operation $($invokeParams.Method) $($invokeParams.Uri)"
+            try {
+                $apiResponse = Invoke-TssApi @invokeParams
+                $restResponse = . $ProcessResponse $apiResponse
+            } catch {
+                Write-Warning "Issue on search request"
+                $err = $_
+                . $ErrorHandling $err
+            }
+
+            if ($restResponse.records.Count -le 0 -and $restResponse.records.Length -eq 0) {
+                Write-Warning "No records found"
+            }
+            if ($restResponse.records) {
+                [Thycotic.PowerShell.IpRestrictions.Group[]]$restResponse.records
+            }
+        } else {
+            Write-Warning "No valid session found"
+        }
+    }
+}

tests/ipaddress-restrictions/Search-TssIpRestrictionGroup.Tests.ps1

@@ -0,0 +1,24 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'IpAddressRestrictionId', 'GroupId', '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.IpRestrictions.Group" -TestCases $commandDetails {
+            $_.OutputType.Name | Should -Be 'Thycotic.PowerShell.IpRestrictions.Group'
+        }
+    }
+}