BuildMaster Documentation

Credentials - CredentialProperty

  • Last Modified: 2019-07-30

This is generated from the built-in components of BuildMaster 6.1.10, 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.

$CredentialProperty

the decrypted plain text value of a specified credentials property

Script usage:

$CredentialProperty(credential, property)

Parameters:

Name Description
credential The name of the credential to read, optionally prefixed with the type name of the credential separated by the scope resolution operator (i.e. ::).
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:

# ProGetCreds is an instance of Inedo Product Credentials (i.e. InedoProduct::ProGetCreds) with 'Allow encrypted properties...' checked

set $key = $CredentialProperty(ProGetCreds, ApiKey);
set $host = $CredentialProperty(ProGetCreds, Host);

Log-Debug Getting ProGet package from $host with API key: $key;

ProGet::Get-Package(
	Credentials: ProGetCreds,
	Feed: hdars-1k,
	Name: hdars,
	Directory: $WorkingDirectory
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 46f55761 on master