Search-TssMetadataFieldSection - new command

thycotic-ps · Aug 16, 2021 · 4f5ba25 · 4f5ba25
1 parent 028c4f2
commit 4f5ba25
Show file tree

Hide file tree

Showing 7 changed files with 446 additions and 68 deletions.
diff --git a/docs/commands/metadata/Search-TssMetadataFieldSection.md b/docs/commands/metadata/Search-TssMetadataFieldSection.md
@@ -0,0 +1,127 @@
+# Search-TssMetadataFieldSection
+
+## SYNOPSIS
+Search Metadata Field Section that has metadata for a specific item
+
+## SYNTAX
+
+### item
+```
+Search-TssMetadataFieldSection [-TssSession] <Session> -ItemId <Int32> -Type <MetadataType> [-SortBy <String>]
+ [<CommonParameters>]
+```
+
+### field
+```
+Search-TssMetadataFieldSection [-TssSession] <Session> [-SectionFieldId <Int32>] [-SortBy <String>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+Search Metadata Field Section that has metadata for a specific item
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Search-TssMetadataSection -TssSession $session -ItemId 5
+```
+
+Return field sections for Item ID 5
+
+## 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: False
+Accept wildcard characters: False
+```
+
+### -ItemId
+Item ID to return metadata
+
+```yaml
+Type: Int32
+Parameter Sets: item
+Aliases:
+
+Required: True
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SectionFieldId
+Metadata Field ID
+
+```yaml
+Type: Int32
+Parameter Sets: field
+Aliases: MetadataSectionFieldId
+
+Required: False
+Position: Named
+Default value: 0
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Type
+Metadata Type (Secret, User, Folder, Group)
+
+```yaml
+Type: MetadataType
+Parameter Sets: item
+Aliases: MetadataType
+Accepted values: Secret, User, Folder, Group
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SortBy
+Sort by specific property, default ItemId
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: ItemId
+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.Metadata.FieldSectionSummary
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/metadata/Search-TssMetadataSection](https://thycotic-ps.github.io/thycotic.secretserver/commands/metadata/Search-TssMetadataSection)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/metadata/Search-TssMetadataSection.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/metadata/Search-TssMetadataSection.ps1)
+
diff --git a/src/Thycotic.SecretServer.Format.ps1xml b/src/Thycotic.SecretServer.Format.ps1xml
@@ -2581,5 +2581,109 @@
       </TableControl>
     </View>
 
+    <!-- Thycotic.PowerShell.Metadata.Summary -->
+    <View>
+      <Name>Metadata.Summary</Name>
+      <ViewSelectedBy>
+        <TypeName>Thycotic.PowerShell.Metadata.Summary</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>MetadataItemDataId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>MetadataFieldSectionName</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>MetadataFieldName</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>MetadataFieldDataType</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ItemId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>MetadataType</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ValueBit</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ValueDateTime</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ValueInt</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ValueNumber</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ValueString</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ValueUserDisplayName</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
+
+    <!-- Thycotic.PowerShell.Metadata.FieldSectionSummary -->
+    <View>
+      <Name>Metadata.FieldSectionSummary</Name>
+      <ViewSelectedBy>
+        <TypeName>Thycotic.PowerShell.Metadata.FieldSectionSummary</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+          <TableColumnHeader />
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>MetadataFieldSectionId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>MetadataFieldSectionName</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>RequiresAdministerMetadata</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>RequiresEntityEdit</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Actions</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
+
   </ViewDefinitions>
 </Configuration>
diff --git a/src/Thycotic.SecretServer.psd1 b/src/Thycotic.SecretServer.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Shawn Melton
 #
-# Generated on: 8/10/2021
+# Generated on: 8/16/2021
 #
 
 @{
@@ -69,73 +69,74 @@ FormatsToProcess = 'Thycotic.SecretServer.Format.ps1xml'
 NestedModules = @('bin\Thycotic.SecretServer.dll')
 
 # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = 'Add-TssEventPipeline', 'Add-TssFolderPermission',
-               'Add-TssGroupMember', 'Add-TssSecretPermission',
-               'Add-TssSecretTemplateField', 'Close-TssSecret',
-               'Disable-TssEventPipeline', 'Disable-TssEventPipelinePolicy',
-               'Disable-TssSecretCheckout', 'Disable-TssSecretEmail',
-               'Disable-TssUnlimitedAdmin', 'Disable-TssUser',
-               'Enable-TssEventPipeline', 'Enable-TssEventPipelinePolicy',
-               'Enable-TssSecretCheckout', 'Enable-TssSecretEmail',
-               'Enable-TssUnlimitedAdmin', 'Enable-TssUser', 'Export-TssReport',
-               'Find-TssFolder', 'Find-TssGroup', 'Find-TssReport', 'Find-TssSecret',
-               'Find-TssUser', 'Get-TssConfiguration', 'Get-TssEventPipeline',
-               'Get-TssEventPipelinePolicy', 'Get-TssEventPipelinePolicyActivity',
-               'Get-TssEventPipelineRun', 'Get-TssFolder', 'Get-TssFolderAudit',
-               'Get-TssFolderPermission', 'Get-TssFolderState', 'Get-TssGroup',
-               'Get-TssGroupMember', 'Get-TssGroupRole', 'Get-TssGroupUser',
-               'Get-TssReport', 'Get-TssReportCategory', 'Get-TssReportParameter',
-               'Get-TssRpcAssociatedSecret', 'Get-TssRpcPasswordType',
-               'Get-TssScript', 'Get-TssSecret', 'Get-TssSecretAccessRequestOption',
-               'Get-TssSecretAccessRequestSecret', 'Get-TssSecretAttachment',
-               'Get-TssSecretAudit', 'Get-TssSecretDependency',
-               'Get-TssSecretDependencyGroup', 'Get-TssSecretDependencyRunStatus',
-               'Get-TssSecretDependencyStub', 'Get-TssSecretDependencyTemplate',
-               'Get-TssSecretField', 'Get-TssSecretHeartbeatStatus',
-               'Get-TssSecretHook', 'Get-TssSecretHookStub',
-               'Get-TssSecretPasswordStatus', 'Get-TssSecretPolicy',
-               'Get-TssSecretSetting', 'Get-TssSecretState', 'Get-TssSecretStub',
-               'Get-TssSecretSummary', 'Get-TssSecretTemplate',
-               'Get-TssSecretTemplateFolder', 'Get-TssSite', 'Get-TssUser',
-               'Get-TssUserAudit', 'Get-TssUserGroup', 'Get-TssUserOwner',
-               'Get-TssUserRole', 'Get-TssUserRoleAssigned', 'Get-TssVersion',
-               'Initialize-TssSdkClient', 'Invoke-TssReport', 'Invoke-TssRestApi',
-               'Invoke-TssSecretGeneratePassword', 'Lock-TssUser', 'New-TssFolder',
-               'New-TssFolderPermission', 'New-TssGroup', 'New-TssReport',
-               'New-TssSecret', 'New-TssSecretDependency',
-               'New-TssSecretDependencyGroup', 'New-TssSecretHook',
-               'New-TssSecretPermission', 'New-TssSecretTemplate',
-               'New-TssSecretTemplateField', 'New-TssSession', 'New-TssUser',
-               'Open-TssSecret', 'Remove-TssEventPipeline', 'Remove-TssFolder',
-               'Remove-TssFolderPermission', 'Remove-TssFolderTemplate',
-               'Remove-TssGroupMember', 'Remove-TssReport',
-               'Remove-TssReportCategory', 'Remove-TssSecret',
-               'Remove-TssSecretDependency', 'Remove-TssSecretHook',
-               'Remove-TssSecretPermission', 'Remove-TssUserPii',
-               'Reset-TssUserPassword', 'Restore-TssSecret', 'Revoke-TssSecret',
-               'Search-TssDirectoryServiceDomain',
-               'Search-TssDistributedEngineSite', 'Search-TssEventPipeline',
-               'Search-TssEventPipelinePolicy', 'Search-TssFolder',
-               'Search-TssFolderPermission', 'Search-TssGroup', 'Search-TssMetadata',
-               'Search-TssReport', 'Search-TssReportSchedule', 'Search-TssRole',
-               'Search-TssRpcPasswordType', 'Search-TssScript', 'Search-TssSecret',
-               'Search-TssSecretAccessRequest', 'Search-TssSecretDependency',
-               'Search-TssSecretHook', 'Search-TssSecretPermission',
-               'Search-TssSecretPolicy', 'Search-TssSecretTemplate',
-               'Search-TssSystemLog', 'Search-TssUser', 'Search-TssWorkflowTemplate',
-               'Set-TssFolder', 'Set-TssSecret', 'Set-TssSecretExpiration',
-               'Set-TssSecretField', 'Set-TssSecretPolicy',
-               'Set-TssSecretRpcAssociated', 'Set-TssSecretRpcPrivileged',
-               'Set-TssSecretSecurity', 'Set-TssSecretTemplate',
-               'Show-TssCurrentUser', 'Start-TssDiscovery',
-               'Start-TssSecretChangePassword', 'Start-TssSecretDependency',
-               'Start-TssSecretHeartbeat', 'Stop-TssSecretChangePassword',
-               'Test-TssFolderAction', 'Test-TssSdkClient', 'Test-TssSecretAction',
-               'Test-TssSecretState', 'Test-TssVersion', 'Unlock-TssUser',
-               'Update-TssFolder', 'Update-TssFolderPermission',
-               'Update-TssGroupMember', 'Update-TssSecret', 'Update-TssSecretHook',
-               'Update-TssSecretPermission', 'Update-TssSecretRdpLauncherSetting',
-               'Update-TssSecretTemplateField', 'Update-TssUser',
+FunctionsToExport = 'Add-TssEventPipeline', 'Add-TssFolderPermission', 
+               'Add-TssGroupMember', 'Add-TssSecretPermission', 
+               'Add-TssSecretTemplateField', 'Close-TssSecret', 
+               'Disable-TssEventPipeline', 'Disable-TssEventPipelinePolicy', 
+               'Disable-TssSecretCheckout', 'Disable-TssSecretEmail', 
+               'Disable-TssUnlimitedAdmin', 'Disable-TssUser', 
+               'Enable-TssEventPipeline', 'Enable-TssEventPipelinePolicy', 
+               'Enable-TssSecretCheckout', 'Enable-TssSecretEmail', 
+               'Enable-TssUnlimitedAdmin', 'Enable-TssUser', 'Export-TssReport', 
+               'Find-TssFolder', 'Find-TssGroup', 'Find-TssReport', 'Find-TssSecret', 
+               'Find-TssUser', 'Get-TssConfiguration', 'Get-TssEventPipeline', 
+               'Get-TssEventPipelinePolicy', 'Get-TssEventPipelinePolicyActivity', 
+               'Get-TssEventPipelineRun', 'Get-TssFolder', 'Get-TssFolderAudit', 
+               'Get-TssFolderPermission', 'Get-TssFolderState', 'Get-TssGroup', 
+               'Get-TssGroupMember', 'Get-TssGroupRole', 'Get-TssGroupUser', 
+               'Get-TssReport', 'Get-TssReportCategory', 'Get-TssReportParameter', 
+               'Get-TssRpcAssociatedSecret', 'Get-TssRpcPasswordType', 
+               'Get-TssScript', 'Get-TssSecret', 'Get-TssSecretAccessRequestOption', 
+               'Get-TssSecretAccessRequestSecret', 'Get-TssSecretAttachment', 
+               'Get-TssSecretAudit', 'Get-TssSecretDependency', 
+               'Get-TssSecretDependencyGroup', 'Get-TssSecretDependencyRunStatus', 
+               'Get-TssSecretDependencyStub', 'Get-TssSecretDependencyTemplate', 
+               'Get-TssSecretField', 'Get-TssSecretHeartbeatStatus', 
+               'Get-TssSecretHook', 'Get-TssSecretHookStub', 
+               'Get-TssSecretPasswordStatus', 'Get-TssSecretPolicy', 
+               'Get-TssSecretSetting', 'Get-TssSecretState', 'Get-TssSecretStub', 
+               'Get-TssSecretSummary', 'Get-TssSecretTemplate', 
+               'Get-TssSecretTemplateFolder', 'Get-TssSite', 'Get-TssUser', 
+               'Get-TssUserAudit', 'Get-TssUserGroup', 'Get-TssUserOwner', 
+               'Get-TssUserRole', 'Get-TssUserRoleAssigned', 'Get-TssVersion', 
+               'Initialize-TssSdkClient', 'Invoke-TssReport', 'Invoke-TssRestApi', 
+               'Invoke-TssSecretGeneratePassword', 'Lock-TssUser', 'New-TssFolder', 
+               'New-TssFolderPermission', 'New-TssGroup', 'New-TssReport', 
+               'New-TssSecret', 'New-TssSecretDependency', 
+               'New-TssSecretDependencyGroup', 'New-TssSecretHook', 
+               'New-TssSecretPermission', 'New-TssSecretTemplate', 
+               'New-TssSecretTemplateField', 'New-TssSession', 'New-TssUser', 
+               'Open-TssSecret', 'Remove-TssEventPipeline', 'Remove-TssFolder', 
+               'Remove-TssFolderPermission', 'Remove-TssFolderTemplate', 
+               'Remove-TssGroupMember', 'Remove-TssMetadata', 'Remove-TssReport', 
+               'Remove-TssReportCategory', 'Remove-TssSecret', 
+               'Remove-TssSecretDependency', 'Remove-TssSecretHook', 
+               'Remove-TssSecretPermission', 'Remove-TssUserPii', 
+               'Reset-TssUserPassword', 'Restore-TssSecret', 'Revoke-TssSecret', 
+               'Search-TssDirectoryServiceDomain', 
+               'Search-TssDistributedEngineSite', 'Search-TssEventPipeline', 
+               'Search-TssEventPipelinePolicy', 'Search-TssFolder', 
+               'Search-TssFolderPermission', 'Search-TssGroup', 'Search-TssMetadata', 
+               'Search-TssMetadataFieldSection', 'Search-TssReport', 
+               'Search-TssReportSchedule', 'Search-TssRole', 
+               'Search-TssRpcPasswordType', 'Search-TssScript', 'Search-TssSecret', 
+               'Search-TssSecretAccessRequest', 'Search-TssSecretDependency', 
+               'Search-TssSecretHook', 'Search-TssSecretPermission', 
+               'Search-TssSecretPolicy', 'Search-TssSecretTemplate', 
+               'Search-TssSystemLog', 'Search-TssUser', 'Search-TssWorkflowTemplate', 
+               'Set-TssFolder', 'Set-TssSecret', 'Set-TssSecretExpiration', 
+               'Set-TssSecretField', 'Set-TssSecretPolicy', 
+               'Set-TssSecretRpcAssociated', 'Set-TssSecretRpcPrivileged', 
+               'Set-TssSecretSecurity', 'Set-TssSecretTemplate', 
+               'Show-TssCurrentUser', 'Start-TssDiscovery', 
+               'Start-TssSecretChangePassword', 'Start-TssSecretDependency', 
+               'Start-TssSecretHeartbeat', 'Stop-TssSecretChangePassword', 
+               'Test-TssFolderAction', 'Test-TssSdkClient', 'Test-TssSecretAction', 
+               'Test-TssSecretState', 'Test-TssVersion', 'Unlock-TssUser', 
+               'Update-TssFolder', 'Update-TssFolderPermission', 
+               'Update-TssGroupMember', 'Update-TssSecret', 'Update-TssSecretHook', 
+               'Update-TssSecretPermission', 'Update-TssSecretRdpLauncherSetting', 
+               'Update-TssSecretTemplateField', 'Update-TssUser', 
                'Update-TssUserPassword', 'Write-TssSecretAccessRequestViewComment'
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.