Thycotic.SecretServer

0.43.0

functions/secret-dependencies/New-SecretDependency.ps1

function New-SecretDependency {
    <#
    .SYNOPSIS
    Create a new Secret Dependency
 
    .DESCRIPTION
    Create a new Secret Dependency
 
    .EXAMPLE
    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
    $dependentStub = Get-TssSecretDependencyStub -TssSession $session -SecretId 42 -TemplateId 4
    New-TssSecretDependency -TssSession $session -DependencyStub $dependentStub
 
    Create new dependency on Secret 42
 
    .LINK
    https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssSecretDependency
 
    .LINK
    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-dependencies/New-SecretDependency.ps1
 
    .NOTES
    Requires TssSession object returned by New-TssSession
    #>
    [CmdletBinding(SupportsShouldProcess)]
    [OutputType('TssSecretDependency')]
    param (
        # TssSession object created by New-TssSession for auth
        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
        [TssSession]
        $TssSession,

        # Secret Dependency Stub object
        [Parameter(Mandatory,ValueFromPipeline)]
        [TssSecretDependency]
        $DependencyStub
    )
    begin {
        $tssNewParams = $PSBoundParameters
        $invokeParams = . $GetInvokeTssParams $TssSession
    }
    process {
        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
        if ($tssNewParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
            $restResponse = $null
            $uri = $TssSession.ApiUrl, 'secret-dependencies' -join '/'
            $invokeParams.Uri = $uri
            $invokeParams.Method = 'POST'
            $invokeParams.Body = ($SecretDependencyStub | ConvertTo-Json)

            Write-Verbose "Performing the operation $($invokeParams.Method) $uri with:`n $newBody"
            if (-not $PSCmdlet.ShouldProcess("", "$($invokeParams.Method) $uri with $($invokeParams.Body)")) { return }
            try {
                $restResponse = . $InvokeApi @invokeParams
            } catch {
                Write-Warning "Issue creating dependency on Secret [$($DependencyStub.SecretId)]"
                $err = $_
                . $ErrorHandling $err
            }

            if ($restResponse) {
                [TssSecretDependency]$restResponse
            }
        } else {
            Write-Warning "No valid session found"
        }
    }
}