Een sleutel ophalen in Azure Key Vault met JavaScript

Maak de KeyClient met de juiste programmatische verificatiereferenties en gebruik vervolgens de client om een sleutel in Te stellen, bij te werken en te roteren in Azure Key Vault.

Sleutel ophalen

U kunt de nieuwste versie van een sleutel of een specifieke versie van een sleutel ophalen met de getKey-methode . De versie bevindt zich binnen de eigenschappen van het KeyVaultKey-object.

• Nieuwste versie downloaden: await client.getKey(name);
• Specifieke versie ophalen: 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}`);

Alle versies van een sleutel ophalen

Als u alle versies van een sleutel in Azure Key Vault wilt ophalen, gebruikt u de listPropertiesOfKeyVersions methode van de KeyClient-klasse om een iterable lijst met eigenschappen van de sleutelversie op te halen. Hiermee wordt een KeyProperties-object geretourneerd, dat niet de waarde van de versie bevat. Als u de waarde van de versie wilt, gebruikt u de versie die in de eigenschap wordt geretourneerd om de waarde van de sleutel op te halen met de getKey-methode.

Wijze	Retourneert de waarde	Retourneert eigenschappen
getKey	Ja	Ja
listPropertiesOfKeyVersions	Nr.	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
}

Uitgeschakelde sleutel ophalen

Gebruik de volgende tabel om te begrijpen wat u met een uitgeschakelde sleutel kunt doen.

Toegestaan	Niet toegestaan
Sleutel inschakelen Eigenschappen bijwerken	Waarde ophalen

Volgende stappen

• Sleutel inschakelen en uitschakelen vanuit JavaScript SDK