Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
240 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Get-TssMetadataField | ||
|
|
||
| ## SYNOPSIS | ||
| Get list of all metadata fields | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Get-TssMetadataField [-TssSession] <Session> [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
| Get list of all metadata fields | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
| ``` | ||
| $session = New-TssSession -SecretServer https://alpha -Credential $ssCred | ||
| Get-TssMetadataField -TssSession $session | ||
| ``` | ||
|
|
||
| Return list of all metadata fields that exists | ||
|
|
||
| ## 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 | ||
| ``` | ||
|
|
||
| ### 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.Metadata.FieldSummary | ||
| ## NOTES | ||
| Requires TssSession object returned by New-TssSession | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [https://thycotic-ps.github.io/thycotic.secretserver/commands/metadata/Get-TssMetadataField](https://thycotic-ps.github.io/thycotic.secretserver/commands/metadata/Get-TssMetadataField) | ||
|
|
||
| [https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/metadata/Get-TssMetadataField.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/metadata/Get-TssMetadataField.ps1) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
src/Thycotic.SecretServer/classes/metadata/FieldSummary.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| using System; | ||
| using System.Threading.Tasks; | ||
| using System.Management.Automation; | ||
| using System.Management.Automation.Runspaces; | ||
| using Thycotic.PowerShell.Enums; | ||
|
|
||
| namespace Thycotic.PowerShell.Metadata | ||
| { | ||
| public class FieldSummary | ||
| { | ||
| public int DefaultSortOrder { get; set; } | ||
| public MetadataFieldDataType FieldDataType {get;set;} | ||
| public int MetadataFieldId { get; set; } | ||
| public string MetadataFieldName { get; set; } | ||
| public int MetadataFieldSectionId { get; set; } | ||
| public string MetadataFieldSectionName { get; set; } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| using System; | ||
| using System.Threading.Tasks; | ||
| using System.Management.Automation; | ||
| using System.Management.Automation.Runspaces; | ||
|
|
||
| namespace Thycotic.PowerShell.Enums | ||
| { | ||
| public enum MetadataFieldDataType | ||
| { | ||
| String, | ||
| Boolean, | ||
| Number, | ||
| DateTime, | ||
| User | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| function Get-TssMetadataField { | ||
| <# | ||
| .SYNOPSIS | ||
| Get list of all metadata fields | ||
| .DESCRIPTION | ||
| Get list of all metadata fields | ||
| .EXAMPLE | ||
| $session = New-TssSession -SecretServer https://alpha -Credential $ssCred | ||
| Get-TssMetadataField -TssSession $session | ||
| Return list of all metadata fields that exists | ||
| .LINK | ||
| https://thycotic-ps.github.io/thycotic.secretserver/commands/metadata/Get-TssMetadataField | ||
| .LINK | ||
| https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/metadata/Get-TssMetadataField.ps1 | ||
| .NOTES | ||
| Requires TssSession object returned by New-TssSession | ||
| #> | ||
| [CmdletBinding()] | ||
| [OutputType('Thycotic.PowerShell.Metadata.FieldSummary')] | ||
| param ( | ||
| # TssSession object created by New-TssSession for authentication | ||
| [Parameter(Mandatory,ValueFromPipeline,Position = 0)] | ||
| [Thycotic.PowerShell.Authentication.Session] | ||
| $TssSession | ||
| ) | ||
| 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.000000' $PSCmdlet.MyInvocation | ||
| $uri = $TssSession.ApiUrl, 'metadata', 'fields' -join '/' | ||
| $invokeParams.Uri = $uri | ||
| $invokeParams.Method = 'GET' | ||
|
|
||
| Write-Verbose "Performing the operation $($invokeParams.Method) $uri" | ||
| try { | ||
| $apiResponse = Invoke-TssApi @invokeParams | ||
| $restResponse = . $ProcessResponse $apiResponse | ||
| } catch { | ||
| Write-Warning "Issue getting reference name on [$var name]" | ||
| $err = $_ | ||
| . $ErrorHandling $err | ||
| } | ||
|
|
||
| if ($restResponse.records) { | ||
| [Thycotic.PowerShell.Metadata.FieldSummary[]]$restResponse.records | ||
| } | ||
| } else { | ||
| Write-Warning "No valid session found" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| BeforeDiscovery { | ||
| $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf | ||
| } | ||
| Describe "$commandName verify parameters" { | ||
| BeforeDiscovery { | ||
| [object[]]$knownParameters = 'TssSession' | ||
| [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.Metadata.FieldSummary" -TestCases $commandDetails { | ||
| $_.OutputType.Name | Should -Be 'Thycotic.PowerShell.Metadata.FieldSummary' | ||
| } | ||
| } | ||
| } |