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

Получение ключа в Azure Key Vault с помощью JavaScript

  • Статья

Создайте KeyClient с соответствующими учетными данными программной проверки подлинности, а затем используйте клиент для задания, обновления и смены ключа в Azure Key Vault.

Получение ключа

Последнюю версию ключа или определенную версию ключа можно получить с помощью метода getKey . Версия находится в свойствах объекта KeyVaultKey .

  • Получите последнюю версию: await client.getKey(name);
  • Получение конкретной версии: await client.getKey(name, { version });
// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
    KeyClient,
} from '@azure/keyvault-keys';

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

const name = `myRsaKey`;

// Get latest key
const latestKey = await client.getKey(name);
console.log(`${latestKey.name} version is ${latestKey.properties.version}`);

// Get previous key by version id
const keyPreviousVersionId = '2f2ec6d43db64d66ad8ffa12489acc8b';
const keyByVersion = await client.getKey(name, {
    version: keyPreviousVersionId
});
console.log(`Previous key version is ${keyByVersion.properties.version}`);

Получение всех версий ключа

Чтобы получить все версии ключа в Azure Key Vault, используйте listPropertiesOfKeyVersions метод класса KeyClient, чтобы получить итерируемый список свойств версии ключа. Возвращает объект KeyProperties , который не включает значение версии. Если требуется значение версии, используйте версию, возвращаемую в свойстве, чтобы получить значение ключа с помощью метода getKey.

Способ Возвращает значение Возвращает свойства
getKey Да Да
listPropertiesOfKeyVersions No Да 
// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
    KeyClient,
} from '@azure/keyvault-keys';

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

const name = `myRsaKey`;

for await (const keyProperties of client.listPropertiesOfKeyVersions(name)) {
    const thisVersion = keyProperties.version;
    
    const { key } = await client.getKey(name, {
        version: thisVersion
    });

    // do something with version's key value
}

Получение отключенного ключа

Используйте следующую таблицу, чтобы понять, что можно сделать с отключенным ключом.

Разрешенный Не разрешенный
Включение ключа
Обновление свойств		 Получение значения

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