$SecureCredentialProperty

Updated on 14 May 2021
1 Minute to read

Print
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.

$SecureCredentialProperty

the decrypted plain text value of a specified credentials property

Script usage:

$SecureCredentialProperty(credential, property)

Parameters:

Name	Description
☆ credential	The name of the credential to read.
☆ property	The name of the credential property to get. If the property is encrypted, the credential itself must be configured to allow the value to be extracted, otherwise the function call will fail at run time.

Example:

# HDarsUser is a Username & Password Credentials with 'Allow encrypted properties...' checked

set $username = $SecureCredentialProperty(HDarsUser, Username);
set $password = $SecureCredentialProperty(HDarsUser, Password);

Log-Debug Executing sometool.exe -user $username -pass *****;
Exec sometool.exe -user $username -pass $password;

Was this article helpful?

What's Next

$MSBuildToolsPath

Table of contents