Cloud Keys 2020 Node.js Edition

Questions / Feedback?

EncodeData Property

Whether to automatically base64-encode and -decode secret data.

Syntax

 azuresecrets.getEncodeData([callback])
 azuresecrets.setEncodeData( encodeData, [callback])

Default Value

FALSE

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 the getEncodeData([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setEncodeData([callback]) 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 property specifies whether the class should automatically base64-encode secret data when it is uploaded by CreateSecret, and base64-decode it when it is downloaded with GetSecret.

Secrets are stored on the server as strings, and are transported via a JSON string property, so binary values must be encoded in some way; this property is provided as a convenience.

This property is not available at design time.

Data Type

Boolean

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 7718]