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 オブジェクトが返されます。 バージョンの値が必要な場合は、プロパティで返される version を使用すると、getKey メソッドでシークレットの値を取得できます。

メソッド	値を返す	プロパティを返す
getKey	はい	はい
listPropertiesOfKeyVersions	いいえ	はい

// 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 のキーを有効または無効にする