GetSecret Method

Gets a secret's value and information.

Syntax

azuresecrets.getSecret(secretName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method gets the value and information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version. The secret's value is returned via the specified LocalFile or the SecretData property.

Alternatively, the GetDeleted configuration setting can be enabled to get a soft-deleted secret's information (but not its value).

When the information is returned, the class clears the Secret* properties and repopulates them with a single item that contains the secret's information, and repopulates the Tag* properties with the secret's tags. The SecretList and TagList events are also fired.