JavaScript を使用して Azure Key Vault でキーを取得する

適切なプログラムによる認証資格情報を使用して 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 のすべてのバージョンのキーを取得するには、KeyClient クラスの listPropertiesOfKeyVersions メソッドを使用して、キーのバージョンのプロパティのスケーラブルな一覧を取得します。 これは、バージョンの値を含まない KeyProperties オブジェクトを返します。 バージョンの値が必要な場合は、プロパティで返されるバージョンを使用して、getKey メソッドでキーの値を取得します。

// 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
}

無効なキーを取得する

次の表を使用して、無効なキーで何ができるかを理解します。

次のステップ

• JavaScript SDK のキーの有効化と無効化