Udostępnij za pośrednictwem

Wyświetlanie listy kluczy i wersji w usłudze Azure Key Vault za pomocą języka JavaScript

  • Artykuł

Utwórz klienta KeyClient z odpowiednimi poświadczeniami uwierzytelniania programowego.

Wyświetlanie listy wszystkich kluczy

Wyświetl bieżącą wersję wszystkich kluczy z iterowalnym listPropertiesOfKeys.

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);
}

Zwrócony obiekt KeyProperties zawiera wersję klucza.

Wyświetlanie listy wszystkich kluczy według strony

Aby wyświetlić listę wszystkich kluczy w usłudze Azure Key Vault, użyj metody listPropertiesOfKeys , aby uzyskać właściwości wpisu tajnego strony naraz, ustawiając obiekt PageSettings .

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}`);
    }
}

Zwrócony obiekt KeyProperties zawiera wersję klucza.

Wyświetlanie listy wszystkich wersji klucza

Aby wyświetlić listę wszystkich wersji klucza w usłudze Azure Key Vault, użyj metody listPropertiesOfKeyVersions .

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}`);
}

Zwrócony obiekt KeyProperties zawiera wersję klucza.

Zapoznaj się z przykładem Listy wszystkich kluczy według strony , aby zobaczyć, jak przeglądać wyniki.

Wyświetlanie listy usuniętych kluczy

Aby wyświetlić listę wszystkich usuniętych kluczy w usłudze Azure Key Vault, użyj metody listDeletedKeys .

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}`
    );
}

Obiekt deletedKey jest obiektem DeletedKey , który zawiera obiekt KeyProperties z dodatkowymi właściwościami, takimi jak:

  • deletedOn — czas usunięcia klucza.
  • scheduledPurgeDate - Data przeczyszczania klucza. Po przeczyszczaniu klucza nie można go odzyskać. Jeśli utworzono kopię zapasową klucza, możesz przywrócić go z tą samą nazwą i wszystkimi jego wersjami.

Zapoznaj się z przykładem Listy wszystkich kluczy według strony , aby zobaczyć, jak przeglądać wyniki.

Następne kroki