Delen via

KeyClient class

Pakket:
@azure/keyvault-keys

KeyClient biedt methoden voor het beheren van KeyVaultKey- in Azure Key Vault. De client ondersteunt het maken, ophalen, bijwerken, verwijderen, opschonen, back-ups maken, herstellen en vermelden van KeyVaultKeys. De client biedt ook ondersteuning voor het weergeven van DeletedKey voor een voorlopig verwijderen ingeschakelde Azure Key Vault.

Constructors

KeyClient(string, TokenCredential, KeyClientOptions)

Hiermee maakt u een exemplaar van KeyClient.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`; // or `https://${vaultName}.managedhsm.azure.net` for managed HSM.

// Lastly, create our keys client and connect to the service
const client = new KeyClient(url, credential);

Eigenschappen

vaultUrl

De basis-URL naar de kluis

Methoden

backupKey(string, BackupKeyOptions)

Hiermee wordt aangevraagd dat een back-up van de opgegeven sleutel naar de client wordt gedownload. Alle versies van de sleutel worden gedownload. Voor deze bewerking zijn de sleutels/back-upmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

Hiermee wordt een back-up gemaakt van de opgegeven sleutel.
beginDeleteKey(string, BeginDeleteKeyOptions)

De verwijderbewerking is van toepassing op elke sleutel die is opgeslagen in Azure Key Vault. Afzonderlijke versies van een sleutel kunnen niet worden verwijderd, alleen alle versies van een bepaalde sleutel tegelijk.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de sleutel wordt verwijderd.

Voor deze bewerking is de machtiging sleutels/verwijderen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const poller = await client.beginDeleteKey(keyName);
await poller.pollUntilDone();

Hiermee verwijdert u een sleutel uit een opgegeven sleutelkluis.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Hiermee herstelt u de verwijderde sleutel in de opgegeven kluis. Deze bewerking kan alleen worden uitgevoerd op een kluis met voorlopig verwijderen.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de verwijderde sleutel is hersteld.

Voor deze bewerking zijn de sleutels/herstelmachtiging vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedKey(keyName);
const recoveredKey = await recoverPoller.pollUntilDone();

Herstelt de verwijderde sleutel naar de nieuwste versie.
createEcKey(string, CreateEcKeyOptions)

Met de methode createEcKey wordt een nieuwe elliptische curvesleutel gemaakt in Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createEcKey(keyName, { curve: "P-256" });
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.
createKey(string, string, CreateKeyOptions)

De bewerking voor het maken van sleutels kan worden gebruikt om elk sleuteltype in Azure Key Vault te maken. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createKey(keyName, "RSA");
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.
createOctKey(string, CreateOctKeyOptions)

Met de methode createOctKey wordt een nieuwe OCT-sleutel gemaakt in Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createOctKey("MyKey", { hsm: true });
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.
createRsaKey(string, CreateRsaKeyOptions)

Met de methode createRSAKey maakt u een nieuwe RSA-sleutel in Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createRsaKey("MyKey", { keySize: 2048 });
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.
getCryptographyClient(string, GetCryptographyClientOptions)

Hiermee haalt u een CryptographyClient- op voor de opgegeven sleutel.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

// Get a cryptography client for a given key
const cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)

De methode getDeletedKey retourneert de opgegeven verwijderde sleutel samen met de eigenschappen. Voor deze bewerking zijn de sleutels/machtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

await client.getDeletedKey(keyName);

Hiermee haalt u de opgegeven verwijderde sleutel op.
getKey(string, GetKeyOptions)

De getKey-methode haalt een opgegeven sleutel op en is van toepassing op elke sleutel die is opgeslagen in Azure Key Vault. Voor deze bewerking zijn de sleutels/machtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKey(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKey(keyName, { version: latestKey.properties.version! });
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

Haal een opgegeven sleutel op uit een bepaalde sleutelkluis.
getKeyAttestation(string, GetKeyAttestationOptions)

De getKeyAttestation-methode haalt een opgegeven sleutel en de attestation-blob op en is van toepassing op elke sleutel die is opgeslagen in beheerde HSM van Azure Key Vault. Voor deze bewerking zijn de sleutels/machtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT MANAGED HSM NAME>";
const url = `https://${vaultName}.managedhsm.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKeyAttestation(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKeyAttestation(keyName, {
  version: latestKey.properties.version!,
});
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

Haal een opgegeven sleutel op uit een bepaalde sleutelkluis.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Hiermee haalt u het roulatiebeleid van een Key Vault-sleutel op. Standaard hebben alle sleutels een beleid dat 30 dagen voor de vervaldatum op de hoogte wordt gesteld.

Voor deze bewerking zijn de sleutels/machtigingen vereist. Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.getKeyRotationPolicy(keyName);
getRandomBytes(number, GetRandomBytesOptions)

Hiermee haalt u het aangevraagde aantal bytes op dat willekeurige waarden van een beheerde HSM bevat. Voor deze bewerking is de machtiging managedHsm/rng vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const bytes = await client.getRandomBytes(10);
importKey(string, JsonWebKey, ImportKeyOptions)

De importsleutelbewerking kan worden gebruikt om elk sleuteltype te importeren in een Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Voor deze bewerking zijn de sleutels/importmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const jsonWebKey = {
  kty: "RSA",
  kid: "test-key-123",
  use: "sig",
  alg: "RS256",
  n: new Uint8Array([112, 34, 56, 98, 123, 244, 200, 99]),
  e: new Uint8Array([1, 0, 1]),
  d: new Uint8Array([45, 67, 89, 23, 144, 200, 76, 233]),
  p: new Uint8Array([34, 89, 100, 77, 204, 56, 29, 77]),
  q: new Uint8Array([78, 99, 201, 45, 188, 34, 67, 90]),
  dp: new Uint8Array([23, 45, 78, 56, 200, 144, 32, 67]),
  dq: new Uint8Array([12, 67, 89, 144, 99, 56, 23, 45]),
  qi: new Uint8Array([78, 90, 45, 201, 34, 67, 120, 55]),
};

const result = await client.importKey("MyKey", jsonWebKey);

Hiermee importeert u een extern gemaakte sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.
listDeletedKeys(ListDeletedKeysOptions)

Hiermee worden de verwijderde sleutels in de kluis herhaald. De volledige sleutel-id en eigenschappen worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de sleutels. Voor deze bewerkingen is de machtiging sleutels/lijsten vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

Alle sleutels in de kluis weergeven
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Hiermee wordt de nieuwste versie van alle sleutels in de kluis herhaald. De volledige sleutel-id en eigenschappen worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de sleutels. Voor deze bewerkingen is de machtiging sleutels/lijsten vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

Alle sleutels in de kluis weergeven
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Hiermee worden alle versies van de opgegeven sleutel in de kluis herhaald. De volledige sleutel-id, eigenschappen en tags worden opgegeven in het antwoord. Voor deze bewerking zijn de sleutels/lijstmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

Met de bewerking verwijderde sleutel opschonen wordt de sleutel permanent verwijderd zonder de mogelijkheid om de sleutel te herstellen. Deze bewerking kan alleen worden ingeschakeld voor een kluis met voorlopig verwijderen. Voor deze bewerking zijn de sleutels/opschoningsmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

await client.purgeDeletedKey(keyName);

Hiermee verwijdert u de opgegeven sleutel definitief.
releaseKey(string, string, ReleaseKeyOptions)

Geeft een sleutel uit van een beheerde HSM.

De releasesleutelbewerking is van toepassing op alle sleuteltypen. Voor de bewerking moet de sleutel worden gemarkeerd als exporteerbaar en de sleutels/releasemachtigingen.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.releaseKey("myKey", "<attestation-target>");
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Hiermee herstelt u een back-up van een sleutel en alle bijbehorende versies naar een kluis. Voor deze bewerking zijn de sleutels/herstelmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

const key = await client.restoreKeyBackup(backupContents);

Hiermee herstelt u een back-up van een sleutel naar een kluis.
rotateKey(string, RotateKeyOptions)

Draait de sleutel op basis van het sleutelbeleid door een nieuwe versie van de sleutel te genereren. Voor deze bewerking zijn de sleutels/draaimachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

// Set the key's automated rotation policy to rotate the key 30 days before expiry.
const policy = await client.updateKeyRotationPolicy(keyName, {
  lifetimeActions: [
    {
      action: "Rotate",
      timeBeforeExpiry: "P30D",
    },
  ],
  // You may also specify the duration after which any newly rotated key will expire.
  // In this case, any new key versions will expire after 90 days.
  expiresIn: "P90D",
});

// You can get the current key rotation policy of a given key by calling the getKeyRotationPolicy method.
const currentPolicy = await client.getKeyRotationPolicy(keyName);

// Finally, you can rotate a key on-demand by creating a new version of the given key.
const rotatedKey = await client.rotateKey(keyName);
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

De methode updateKeyProperties wijzigt de opgegeven eigenschappen van een bestaande opgeslagen sleutel. Eigenschappen die niet zijn opgegeven in de aanvraag, blijven ongewijzigd. De waarde van een sleutel zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging sleutels/set vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

Hiermee worden de eigenschappen bijgewerkt die zijn gekoppeld aan een opgegeven sleutel in een bepaalde sleutelkluis.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

De methode updateKeyProperties wijzigt de opgegeven eigenschappen van de nieuwste versie van een bestaande opgeslagen sleutel. Eigenschappen die niet zijn opgegeven in de aanvraag, blijven ongewijzigd. De waarde van een sleutel zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging sleutels/set vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

Hiermee worden de eigenschappen bijgewerkt die zijn gekoppeld aan een opgegeven sleutel in een bepaalde sleutelkluis.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Hiermee werkt u het rotatiebeleid van een Key Vault-sleutel bij. Voor deze bewerking zijn de sleutels/updatemachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const myPolicy = await client.getKeyRotationPolicy(keyName);

const setPolicy = await client.updateKeyRotationPolicy(keyName, myPolicy);

Constructordetails

KeyClient(string, TokenCredential, KeyClientOptions)

Hiermee maakt u een exemplaar van KeyClient.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`; // or `https://${vaultName}.managedhsm.azure.net` for managed HSM.

// Lastly, create our keys client and connect to the service
const client = new KeyClient(url, credential);

new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)

Parameters

vaultUrl

string

de URL van de Sleutelkluis. Deze moet deze vorm hebben: https://${your-key-vault-name}.vault.azure.net. Controleer of deze URL verwijst naar een geldige Key Vault- of beheerde HSM-resource. Zie https://aka.ms/azsdk/blog/vault-uri voor meer informatie.

credential
TokenCredential

Een object dat de TokenCredential-interface implementeert die wordt gebruikt voor het verifiëren van aanvragen voor de service. Gebruik het @azure/identity-pakket om een referentie te maken die aan uw behoeften voldoet.

pipelineOptions
KeyClientOptions

Pijplijnopties die worden gebruikt voor het configureren van Key Vault-API-aanvragen. Laat deze parameter weg om de standaardpijplijnconfiguratie te gebruiken.

Eigenschapdetails

vaultUrl

De basis-URL naar de kluis

vaultUrl: string

Waarde van eigenschap

string

Methodedetails

backupKey(string, BackupKeyOptions)

Hiermee wordt aangevraagd dat een back-up van de opgegeven sleutel naar de client wordt gedownload. Alle versies van de sleutel worden gedownload. Voor deze bewerking zijn de sleutels/back-upmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

Hiermee wordt een back-up gemaakt van de opgegeven sleutel.

function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>

Parameters

name

string

De naam van de sleutel.

options
BackupKeyOptions

De optionele parameters.

Retouren

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

De verwijderbewerking is van toepassing op elke sleutel die is opgeslagen in Azure Key Vault. Afzonderlijke versies van een sleutel kunnen niet worden verwijderd, alleen alle versies van een bepaalde sleutel tegelijk.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de sleutel wordt verwijderd.

Voor deze bewerking is de machtiging sleutels/verwijderen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const poller = await client.beginDeleteKey(keyName);
await poller.pollUntilDone();

Hiermee verwijdert u een sleutel uit een opgegeven sleutelkluis.

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Parameters

name

string

De naam van de sleutel.

options
BeginDeleteKeyOptions

De optionele parameters.

Retouren

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Hiermee herstelt u de verwijderde sleutel in de opgegeven kluis. Deze bewerking kan alleen worden uitgevoerd op een kluis met voorlopig verwijderen.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de verwijderde sleutel is hersteld.

Voor deze bewerking zijn de sleutels/herstelmachtiging vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedKey(keyName);
const recoveredKey = await recoverPoller.pollUntilDone();

Herstelt de verwijderde sleutel naar de nieuwste versie.

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Parameters

name

string

De naam van de verwijderde sleutel.

options
BeginRecoverDeletedKeyOptions

De optionele parameters.

Retouren

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

createEcKey(string, CreateEcKeyOptions)

Met de methode createEcKey wordt een nieuwe elliptische curvesleutel gemaakt in Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createEcKey(keyName, { curve: "P-256" });
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.

function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

options
CreateEcKeyOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

De bewerking voor het maken van sleutels kan worden gebruikt om elk sleuteltype in Azure Key Vault te maken. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createKey(keyName, "RSA");
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.

function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

keyType

string

Het type sleutel. Een van de volgende opties: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'.

options
CreateKeyOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

Met de methode createOctKey wordt een nieuwe OCT-sleutel gemaakt in Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createOctKey("MyKey", { hsm: true });
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.

function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

options
CreateOctKeyOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

Met de methode createRSAKey maakt u een nieuwe RSA-sleutel in Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createRsaKey("MyKey", { keySize: 2048 });
console.log("result: ", result);

Hiermee maakt u een nieuwe sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.

function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

options
CreateRsaKeyOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Hiermee haalt u een CryptographyClient- op voor de opgegeven sleutel.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

// Get a cryptography client for a given key
const cryptographyClient = client.getCryptographyClient("MyKey");

function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient

Parameters

keyName

string

options
GetCryptographyClientOptions

Retouren

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

De methode getDeletedKey retourneert de opgegeven verwijderde sleutel samen met de eigenschappen. Voor deze bewerking zijn de sleutels/machtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

await client.getDeletedKey(keyName);

Hiermee haalt u de opgegeven verwijderde sleutel op.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>

Parameters

name

string

De naam van de sleutel.

options
GetDeletedKeyOptions

De optionele parameters.

Retouren

Promise<DeletedKey>

getKey(string, GetKeyOptions)

De getKey-methode haalt een opgegeven sleutel op en is van toepassing op elke sleutel die is opgeslagen in Azure Key Vault. Voor deze bewerking zijn de sleutels/machtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKey(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKey(keyName, { version: latestKey.properties.version! });
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

Haal een opgegeven sleutel op uit een bepaalde sleutelkluis.

function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

options
GetKeyOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

getKeyAttestation(string, GetKeyAttestationOptions)

De getKeyAttestation-methode haalt een opgegeven sleutel en de attestation-blob op en is van toepassing op elke sleutel die is opgeslagen in beheerde HSM van Azure Key Vault. Voor deze bewerking zijn de sleutels/machtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT MANAGED HSM NAME>";
const url = `https://${vaultName}.managedhsm.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKeyAttestation(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKeyAttestation(keyName, {
  version: latestKey.properties.version!,
});
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

Haal een opgegeven sleutel op uit een bepaalde sleutelkluis.

function getKeyAttestation(name: string, options?: GetKeyAttestationOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

options
GetKeyAttestationOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Hiermee haalt u het roulatiebeleid van een Key Vault-sleutel op. Standaard hebben alle sleutels een beleid dat 30 dagen voor de vervaldatum op de hoogte wordt gesteld.

Voor deze bewerking zijn de sleutels/machtigingen vereist. Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.getKeyRotationPolicy(keyName);

function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Parameters

keyName

string

De naam van de sleutel.

options
GetKeyRotationPolicyOptions

De optionele parameters.

Retouren

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Hiermee haalt u het aangevraagde aantal bytes op dat willekeurige waarden van een beheerde HSM bevat. Voor deze bewerking is de machtiging managedHsm/rng vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const bytes = await client.getRandomBytes(10);

function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>

Parameters

count

number

Het aantal bytes dat moet worden gegenereerd tussen 1 en 128 inclusief.

options
GetRandomBytesOptions

De optionele parameters.

Retouren

Promise<Uint8Array>

importKey(string, JsonWebKey, ImportKeyOptions)

De importsleutelbewerking kan worden gebruikt om elk sleuteltype te importeren in een Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Voor deze bewerking zijn de sleutels/importmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const jsonWebKey = {
  kty: "RSA",
  kid: "test-key-123",
  use: "sig",
  alg: "RS256",
  n: new Uint8Array([112, 34, 56, 98, 123, 244, 200, 99]),
  e: new Uint8Array([1, 0, 1]),
  d: new Uint8Array([45, 67, 89, 23, 144, 200, 76, 233]),
  p: new Uint8Array([34, 89, 100, 77, 204, 56, 29, 77]),
  q: new Uint8Array([78, 99, 201, 45, 188, 34, 67, 90]),
  dp: new Uint8Array([23, 45, 78, 56, 200, 144, 32, 67]),
  dq: new Uint8Array([12, 67, 89, 144, 99, 56, 23, 45]),
  qi: new Uint8Array([78, 90, 45, 201, 34, 67, 120, 55]),
};

const result = await client.importKey("MyKey", jsonWebKey);

Hiermee importeert u een extern gemaakte sleutel, slaat u deze op en retourneert u sleutelparameters en eigenschappen aan de client.

function importKey(name: string, key: JsonWebKey, options?: ImportKeyOptions): Promise<KeyVaultKey>

Parameters

name

string

Naam voor de geïmporteerde sleutel.

key
JsonWebKey

De JSON-websleutel.

options
ImportKeyOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Hiermee worden de verwijderde sleutels in de kluis herhaald. De volledige sleutel-id en eigenschappen worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de sleutels. Voor deze bewerkingen is de machtiging sleutels/lijsten vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

Alle sleutels in de kluis weergeven

function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

Parameters

options
ListDeletedKeysOptions

De optionele parameters.

Retouren

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Hiermee wordt de nieuwste versie van alle sleutels in de kluis herhaald. De volledige sleutel-id en eigenschappen worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de sleutels. Voor deze bewerkingen is de machtiging sleutels/lijsten vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

Alle sleutels in de kluis weergeven

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Parameters

options
ListPropertiesOfKeysOptions

De optionele parameters.

Retouren

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Hiermee worden alle versies van de opgegeven sleutel in de kluis herhaald. De volledige sleutel-id, eigenschappen en tags worden opgegeven in het antwoord. Voor deze bewerking zijn de sleutels/lijstmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Parameters

name

string

Naam van de sleutel voor het ophalen van versies voor

options
ListPropertiesOfKeyVersionsOptions

De optionele parameters.

Retouren

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

Met de bewerking verwijderde sleutel opschonen wordt de sleutel permanent verwijderd zonder de mogelijkheid om de sleutel te herstellen. Deze bewerking kan alleen worden ingeschakeld voor een kluis met voorlopig verwijderen. Voor deze bewerking zijn de sleutels/opschoningsmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

await client.purgeDeletedKey(keyName);

Hiermee verwijdert u de opgegeven sleutel definitief.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>

Parameters

name

string

De naam van de sleutel.

options
PurgeDeletedKeyOptions

De optionele parameters.

Retouren

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Geeft een sleutel uit van een beheerde HSM.

De releasesleutelbewerking is van toepassing op alle sleuteltypen. Voor de bewerking moet de sleutel worden gemarkeerd als exporteerbaar en de sleutels/releasemachtigingen.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.releaseKey("myKey", "<attestation-target>");

function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>

Parameters

name

string

De naam van de sleutel.

targetAttestationToken

string

De attestation-verklaring voor het doel van de sleutelrelease.

options
ReleaseKeyOptions

De optionele parameters.

Retouren

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Hiermee herstelt u een back-up van een sleutel en alle bijbehorende versies naar een kluis. Voor deze bewerking zijn de sleutels/herstelmachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

const key = await client.restoreKeyBackup(backupContents);

Hiermee herstelt u een back-up van een sleutel naar een kluis.

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>

Parameters

backup

Uint8Array

De back-upblob die is gekoppeld aan een sleutelbundel.

options
RestoreKeyBackupOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Draait de sleutel op basis van het sleutelbeleid door een nieuwe versie van de sleutel te genereren. Voor deze bewerking zijn de sleutels/draaimachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

// Set the key's automated rotation policy to rotate the key 30 days before expiry.
const policy = await client.updateKeyRotationPolicy(keyName, {
  lifetimeActions: [
    {
      action: "Rotate",
      timeBeforeExpiry: "P30D",
    },
  ],
  // You may also specify the duration after which any newly rotated key will expire.
  // In this case, any new key versions will expire after 90 days.
  expiresIn: "P90D",
});

// You can get the current key rotation policy of a given key by calling the getKeyRotationPolicy method.
const currentPolicy = await client.getKeyRotationPolicy(keyName);

// Finally, you can rotate a key on-demand by creating a new version of the given key.
const rotatedKey = await client.rotateKey(keyName);

function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel die moet worden gedraaid.

options
RotateKeyOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

De methode updateKeyProperties wijzigt de opgegeven eigenschappen van een bestaande opgeslagen sleutel. Eigenschappen die niet zijn opgegeven in de aanvraag, blijven ongewijzigd. De waarde van een sleutel zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging sleutels/set vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

Hiermee worden de eigenschappen bijgewerkt die zijn gekoppeld aan een opgegeven sleutel in een bepaalde sleutelkluis.

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

keyVersion

string

De versie van de sleutel.

options
UpdateKeyPropertiesOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

De methode updateKeyProperties wijzigt de opgegeven eigenschappen van de nieuwste versie van een bestaande opgeslagen sleutel. Eigenschappen die niet zijn opgegeven in de aanvraag, blijven ongewijzigd. De waarde van een sleutel zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging sleutels/set vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

Hiermee worden de eigenschappen bijgewerkt die zijn gekoppeld aan een opgegeven sleutel in een bepaalde sleutelkluis.

function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Parameters

name

string

De naam van de sleutel.

options
UpdateKeyPropertiesOptions

De optionele parameters.

Retouren

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Hiermee werkt u het rotatiebeleid van een Key Vault-sleutel bij. Voor deze bewerking zijn de sleutels/updatemachtigingen vereist.

Voorbeeldgebruik:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const myPolicy = await client.getKeyRotationPolicy(keyName);

const setPolicy = await client.updateKeyRotationPolicy(keyName, myPolicy);

function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Parameters

keyName

string

De naam van de sleutel.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

De optionele parameters.

Retouren

Promise<KeyRotationPolicy>