Delen via

KeyClient class

  • Referentie
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 { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

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:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

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:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);

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:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);

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:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

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:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

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:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

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:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

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:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let 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:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

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:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

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:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");
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:

let client = new KeyClient(vaultUrl, credentials);
let { 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:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

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:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

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:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

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:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}
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:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

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:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", 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:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let 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:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
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:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.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:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { 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:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

Constructordetails

KeyClient(string, TokenCredential, KeyClientOptions)

Hiermee maakt u een exemplaar van KeyClient.

Voorbeeldgebruik:

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

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

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:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

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:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);

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:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);

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:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

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:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

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:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

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:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

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:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let 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:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

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:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

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>

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:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");

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:

let client = new KeyClient(vaultUrl, credentials);
let { 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:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

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:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

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:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

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:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}

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:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

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:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", 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:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let 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:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");

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:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.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:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { 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:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", 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>