Remove-TssMetadata

SYNOPSIS

Deletes the metadata value and all history for that item

SYNTAX

Remove-TssMetadata [-TssSession] <Session> -ItemId <Int32> -ItemDataId <Int32> -ItemType <MetadataType>
 [-WhatIf] [-Confirm] [<CommonParameters>]
  

DESCRIPTION

Deletes the metadata value and all history for that item

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Remove-TssMetadata -TssSession $session -ItemId 5 -ItemDataId 1 -Type User
  

Delete Item ID 5 and allits history

PARAMETERS

-TssSession

TssSession object created by New-TssSession for authentication

Type: Session
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
  

-ItemId

Item ID

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
  

-ItemDataId

Metadata Item Data ID

Type: Int32
Parameter Sets: (All)
Aliases: MetadataItemDataId

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
  

-ItemType

Item Type

Type: MetadataType
Parameter Sets: (All)
Aliases: MetadataType
Accepted values: Secret, User, Folder, Group

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
  

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
  

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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.

INPUTS

OUTPUTS

Thycotic.PowerShell.Common.Delete

NOTES

Requires TssSession object returned by New-TssSession

https://thycotic-ps.github.io/thycotic.secretserver/commands/metadata/Remove-TssMetadata

https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/metadata/Remove-TssMetadata.ps1