Cloud Keys 2020 Node.js Edition

Questions / Feedback?

ListSecrets Method

Lists the secrets in the currently-selected vault.

Syntax

azuresecrets.listSecrets([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 lists the secrets in the currently-selected Vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted secrets in the vault instead.

Calling this method will fire the SecretList event once for each secret, and will also populate the Secret* properties.

If there are still more secrets available to list when this method returns, the SecretMarker property will be populated. Continue to call this method until SecretMarker is empty to accumulate all pages of results in the Secret* properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

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