Hämta en nyckel i Azure Key Vault med JavaScript
Skapa KeyClient med lämpliga programmässiga autentiseringsuppgifter och använd sedan klienten för att ange, uppdatera och rotera en nyckel i Azure Key Vault.
Hämta nyckel
Du kan hämta den senaste versionen av en nyckel eller en specifik version av en nyckel med metoden getKey . Versionen ligger inom egenskaperna för KeyVaultKey-objektet .
- Hämta den senaste versionen:
await client.getKey(name);
- Hämta specifik version:
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}`);
Hämta alla versioner av en nyckel
Om du vill hämta alla versioner av en nyckel i Azure Key Vault använder du listPropertiesOfKeyVersions
metoden för KeyClient-klassen för att hämta en itererbar lista över nyckelns versionsegenskaper. Detta returnerar ett KeyProperties-objekt som inte innehåller versionens värde. Om du vill ha versionens värde använder du den version som returneras i egenskapen för att hämta nyckelns värde med metoden getKey.
Metod | Returnerar värde | Returnerar egenskaper |
---|---|---|
getKey | Ja | Ja |
listPropertiesOfKeyVersions | Nej | Ja |
// 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
}
Hämta inaktiverad nyckel
Använd följande tabell för att förstå vad du kan göra med en inaktiverad nyckel.
Tillåts | Tillåts inte |
---|---|
Aktivera nyckel Uppdatera egenskaper |
Hämta värde |