Udostępnij za pośrednictwem

Uzyskiwanie klucza w usłudze Azure Key Vault za pomocą języka JavaScript

  • Artykuł

Utwórz klienta KeyClient z odpowiednimi poświadczeniami uwierzytelniania programowego, a następnie użyj klienta, aby ustawić, zaktualizować i obrócić klucz w usłudze Azure Key Vault.

Uzyskiwanie klucza

Możesz pobrać najnowszą wersję klucza lub określoną wersję klucza za pomocą metody getKey . Wersja znajduje się we właściwościach obiektu KeyVaultKey .

  • Pobierz najnowszą wersję: await client.getKey(name);
  • Pobierz określoną wersję: 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}`);

Pobieranie wszystkich wersji klucza

Aby uzyskać wszystkie wersje klucza w usłudze Azure Key Vault, użyj listPropertiesOfKeyVersions metody klasy KeyClient, aby uzyskać iterowalnej listy właściwości wersji klucza. Spowoduje to zwrócenie obiektu KeyProperties , który nie zawiera wartości wersji. Jeśli chcesz, aby wartość wersji została zwrócona we właściwości , użyj wersji zwróconej we właściwości , aby uzyskać wartość klucza za pomocą metody getKey.

Method Zwraca wartość Zwraca właściwości
getKey Tak Tak
listPropertiesOfKeyVersions Nie. Tak 
// 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
}

Uzyskiwanie wyłączonego klucza

Skorzystaj z poniższej tabeli, aby dowiedzieć się, co można zrobić z wyłączonym kluczem.

Dozwolone Niedozwolone
Włącz klucz
Aktualizowanie właściwości		 Pobieranie wartości

Następne kroki