Freigeben über

Auflisten von Schlüsseln und Versionen in Azure Key Vault mit JavaScript

Erstellen Sie den KeyClient mit den entsprechenden Anmeldeinformationen zur programmgesteuerten Authentifizierung.

Auflisten aller Schlüssel

Listen Sie die aktuelle Version aller Schlüssel mit dem iterierbaren Objekt listPropertiesOfKeys auf.

import { KeyClient, CreateKeyOptions, KeyVaultKey } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

// Get latest version of (not soft-deleted) keys 
for await (const keyProperties of client.listPropertiesOfKeys()) {
    console.log(keyProperties.version);
}

Das zurückgegebene KeyProperties-Objekt enthält die Schlüsselversion.

Auflisten aller Schlüssel nach Seite

Um alle Schlüssel in Azure Key Vault aufzulisten, verwenden Sie die listPropertiesOfSecrets-Methode, um die Schlüsseleigenschaften einer Seite gleichzeitig abzurufen, indem Sie das PageSettings-Objekt festlegen.

import { KeyClient } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

let page = 1;
const maxPageSize = 5;

// Get latest version of not-deleted keys 
for await (const keyProperties of client.listPropertiesOfKeys().byPage({maxPageSize})) {
    console.log(`Page ${page++} ---------------------`)
    
    for (const props of keyProperties) {
        console.log(`${props.name}`);
    }
}

Das zurückgegebene KeyProperties-Objekt enthält die Schlüsselversion.

Auflisten aller Versionen eines Schlüssels

Verwenden Sie die listPropertiesOfKeyVersions-Methode, um alle Versionen eines Schlüssels in Azure Key Vault aufzulisten.

import { KeyClient } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

// Get all versions of key
for await (const versionProperties of client.listPropertiesOfKeyVersions(
    keyName
)) {
    console.log(`\tversion: ${versionProperties.version} created on ${versionProperties.createdOn}`);
}

Das zurückgegebene KeyProperties-Objekt enthält die Schlüsselversion.

Lesen Sie das Beispiel Auflisten aller Schlüssel nach Seite, um zu erfahren, wie Sie die Ergebnisse durchblättern.

Auflisten gelöschter Schlüssel

Verwenden Sie die listDeletedKeys-Methode, um alle gelöschten Schlüssel in Azure Key Vault aufzulisten.

import { KeyClient } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

for await (const deletedKey of client.listDeletedKeys()) {
    console.log(
        `Deleted: ${deletedKey.name} deleted on ${deletedKey.properties.deletedOn}, to be purged on ${deletedKey.properties.scheduledPurgeDate}`
    );
}

Das deletedKey-Objekt ist ein DeletedKey-Objekt, das das KeyProperties-Objekt mit zusätzlichen Eigenschaften enthält, z. B.:

  • deletedOn – Der Zeitpunkt, zu dem der Schlüssel gelöscht wurde.
  • scheduledPurgeDate – Das Datum, an dem der Schlüssel gelöscht werden soll. Nachdem ein Schlüssel gelöscht wurde, kann er nicht wiederhergestellt werden. Wenn Sie den Schlüssel gesichert haben, können Sie ihn mit demselben Namen und allen zugehörigen Versionen wiederherstellen.

Lesen Sie das Beispiel Auflisten aller Schlüssel nach Seite, um zu erfahren, wie Sie die Ergebnisse durchblättern.

Nächste Schritte

  • Last updated on