Поделиться через

Вывод списка ключей и версий в Azure Key Vault с помощью JavaScript

  • Статья

Создайте KeyClient с соответствующими учетными данными программной проверки подлинности.

Вывод всех ключей

Перечислить текущую версию всех ключей с помощью итерации 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);
}

Возвращенный объект KeyProperties включает версию ключа.

Вывод списка всех ключей по странице

Чтобы получить список всех ключей в Azure Key Vault, используйте метод listPropertiesOfKeys для получения свойств секрета на странице за раз, задав объект 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}`);
    }
}

Возвращенный объект KeyProperties включает версию ключа.

Вывод списка всех версий ключа

Чтобы получить список всех версий ключа в Azure Key Vault, используйте метод 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}`);
}

Возвращенный объект KeyProperties включает версию ключа.

Ознакомьтесь со списком всех ключей по примеру страницы , чтобы узнать, как просмотреть результаты.

Вывод списка удаленных ключей

Чтобы получить список всех удаленных ключей в Azure Key Vault, используйте метод 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}`
    );
}

Объект deletedKey — это объект DeletedKey , который включает объект KeyProperties с дополнительными свойствами, такими как:

  • deletedOn — время удаления ключа.
  • scheduledPurgeDate — Дата очистки ключа. После очистки ключа его невозможно восстановить. Если вы создали резервную копию ключа, его можно восстановить с одинаковым именем и всеми его версиями.

Ознакомьтесь со списком всех ключей по примеру страницы , чтобы узнать, как просмотреть результаты.

Следующие шаги