Cloud Keys 2020 JavaScript Edition

Questions / Feedback?

ListKeys Method

Lists keys in the currently-selected vault.

Syntax

async azurekeys.listKeys(): Promise<void>

Remarks

This method lists the keys in the currently-selected Vault. If the GetDeleted configuration setting is enabled, it lists the soft-deleted keys in the vault instead.

Calling this method will fire the KeyList event once for each key, and will also populate the Key* properties. However, note that by default the following properties will not be populated, since the server does not return full information for keys when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each key; refer to its documentation for more information.

  • KeysKeyOps
  • KeysKeyType
  • KeysPublicKey
  • KeysVersionId

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

The MaxKeys 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 JavaScript Edition - Version 20.0 [Build 8262]