Get-TssSecretStub
SYNOPSIS
Return template object
SYNTAX
Get-TssSecretStub [-TssSession] <Session> -SecretTemplateId <Int32> [-FolderId <Int32>] [<CommonParameters>]
DESCRIPTION
Return a template object to be used for create a new secret
EXAMPLES
EXAMPLE 1
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Get-TssSecretStub -TssSession $session -SecretTemplateId 6001
Return the Active Directory template as an object
EXAMPLE 2
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
$newSecret = Get-TssSecretStub -TssSession $session -SecretTemplateId 6001
$newSecret.Name = 'IT Dept Domain Admin'
$newSecret.SetFieldValue('username','therealboss')
Getting the Active Directory template stub object, setting the Name and Username on the Secret stub.
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
-SecretTemplateId
Secret Template ID
Type: Int32
Parameter Sets: (All)
Aliases: TemplateId
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FolderId
Folder ID, sets the Folder ID property on the output object
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
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.
INPUTS
OUTPUTS
Thycotic.PowerShell.Secrets.Secret
NOTES
Requires TssSession object returned by New-TssSession
RELATED LINKS
https://thycotic-ps.github.io/thycotic.secretserver/commands/secrets/Get-TssSecretStub