KeyClient class

Paket:

@azure/keyvault-keys

Der KeyClient stellt Methoden zum Verwalten KeyVaultKey- im Azure Key Vault bereit. Der Client unterstützt das Erstellen, Abrufen, Aktualisieren, Löschen, Löschen, Sichern, Wiederherstellen und Auflisten von KeyVaultKeys. Der Client unterstützt auch das Auflisten DeletedKey- für einen vorläufig aktivierten Azure Key Vault.

Konstruktoren

KeyClient(string, TokenCredential, KeyClientOptions)

Erstellt eine Instanz von KeyClient. Beispielverwendung: 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);

Eigenschaften

vaultUrl

Die Basis-URL zum Tresor

Methoden

backupKey(string, BackupKeyOptions)	Fordert an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird. Alle Versionen des Schlüssels werden heruntergeladen. Für diesen Vorgang ist die Schlüssel-/Sicherungsberechtigung erforderlich. Beispielverwendung: let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); Sichert den angegebenen Schlüssel.
beginDeleteKey(string, BeginDeleteKeyOptions)	Der Löschvorgang gilt für alle im Azure Key Vault gespeicherten Schlüssel. Einzelne Versionen eines Schlüssels können nicht gelöscht werden, nur alle Versionen eines bestimmten Schlüssels gleichzeitig. Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Schlüssel gelöscht wird. Für diesen Vorgang sind die Schlüssel/Löschberechtigungen erforderlich. Beispielverwendung: 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); Löscht einen Schlüssel aus einem angegebenen Schlüsseltresor.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)	Stellt den gelöschten Schlüssel im angegebenen Tresor wieder her. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor ausgeführt werden. Diese Funktion gibt einen Abrufvorgang mit langer Ausführung zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der gelöschte Schlüssel wiederhergestellt wird. Für diesen Vorgang sind die Schlüssel/Wiederherstellungsberechtigungen erforderlich. Beispielverwendung: 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); Stellt den gelöschten Schlüssel auf die neueste Version wieder her.
createEcKey(string, CreateEcKeyOptions)	Die createEcKey-Methode erstellt einen neuen elliptischen Kurvenschlüssel in Azure Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung. Beispielverwendung: let client = new KeyClient(url, credentials); let result = await client.createEcKey("MyKey", { curve: "P-256" }); Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.
createKey(string, string, CreateKeyOptions)	Der Erstellungsschlüsselvorgang kann zum Erstellen eines beliebigen Schlüsseltyps in Azure Key Vault verwendet werden. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung. Beispielverwendung: let client = new KeyClient(url, credentials); // Create an elliptic-curve key: let result = await client.createKey("MyKey", "EC"); Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.
createOctKey(string, CreateOctKeyOptions)	Die createOctKey-Methode erstellt einen neuen OCT-Schlüssel im Azure Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung. Beispielverwendung: let client = new KeyClient(url, credentials); let result = await client.createOctKey("MyKey", { hsm: true }); Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.
createRsaKey(string, CreateRsaKeyOptions)	Die createRSAKey-Methode erstellt einen neuen RSA-Schlüssel im Azure Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung. Beispielverwendung: let client = new KeyClient(url, credentials); let result = await client.createRsaKey("MyKey", { keySize: 2048 }); Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.
getCryptographyClient(string, GetCryptographyClientOptions)	Ruft einen CryptographyClient- für den angegebenen Schlüssel ab. Beispielverwendung: let client = new KeyClient(url, credentials); // get a cryptography client for a given key let cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)	Die getDeletedKey-Methode gibt den angegebenen gelöschten Schlüssel zusammen mit seinen Eigenschaften zurück. Für diesen Vorgang sind die Schlüssel/Die Berechtigung "Abrufen" erforderlich. Beispielverwendung: let client = new KeyClient(url, credentials); let key = await client.getDeletedKey("MyDeletedKey"); Ruft den angegebenen gelöschten Schlüssel ab.
getKey(string, GetKeyOptions)	Die getKey-Methode ruft einen angegebenen Schlüssel ab und gilt für jeden im Azure Key Vault gespeicherten Schlüssel. Für diesen Vorgang sind die Schlüssel/Die Berechtigung "Abrufen" erforderlich. Beispielverwendung: let client = new KeyClient(url, credentials); let key = await client.getKey("MyKey"); Rufen Sie einen angegebenen Schlüssel aus einem bestimmten Schlüsseltresor ab.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)	Ruft die Drehungsrichtlinie eines Key Vault-Schlüssels ab. Standardmäßig verfügen alle Schlüssel über eine Richtlinie, die 30 Tage vor Ablauf benachrichtigt. Für diesen Vorgang sind die Schlüssel/Die Berechtigung "Abrufen" erforderlich. Beispielverwendung: let client = new KeyClient(vaultUrl, credentials); let result = await client.getKeyRotationPolicy("myKey");
getRandomBytes(number, GetRandomBytesOptions)	Ruft die angeforderte Anzahl von Bytes ab, die Zufallswerte aus einem verwalteten HSM enthalten. Für diesen Vorgang ist die managedHsm/rng-Berechtigung erforderlich. Beispielverwendung: let client = new KeyClient(vaultUrl, credentials); let { bytes } = await client.getRandomBytes(10);
importKey(string, JsonWebKey, ImportKeyOptions)	Der Importschlüsselvorgang kann verwendet werden, um einen beliebigen Schlüsseltyp in einen Azure Key Vault zu importieren. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel/Importberechtigungen erforderlich. Beispielverwendung: let client = new KeyClient(url, credentials); // Key contents in myKeyContents let result = await client.importKey("MyKey", myKeyContents); Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Eigenschaften an den Client zurück.
listDeletedKeys(ListDeletedKeysOptions)	Durchläuft die gelöschten Schlüssel im Tresor. Der vollständige Schlüsselbezeichner und die Eigenschaften werden in der Antwort bereitgestellt. Für die Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Schlüssel-/Listenberechtigung erforderlich. Beispielverwendung: let client = new KeyClient(url, credentials); for await (const deletedKey of client.listDeletedKeys()) { console.log("deleted key: ", deletedKey); } Auflisten aller Schlüssel im Tresor
listPropertiesOfKeys(ListPropertiesOfKeysOptions)	Iterates the latest version of all keys in the vault. Der vollständige Schlüsselbezeichner und die Eigenschaften werden in der Antwort bereitgestellt. Für die Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Schlüssel-/Listenberechtigung erforderlich. Beispielverwendung: let client = new KeyClient(url, credentials); for await (const keyProperties of client.listPropertiesOfKeys()) { const key = await client.getKey(keyProperties.name); console.log("key: ", key); } Auflisten aller Schlüssel im Tresor
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)	Durchläuft alle Versionen des angegebenen Schlüssels im Tresor. Der vollständige Schlüsselbezeichner, die Eigenschaften und Tags werden in der Antwort bereitgestellt. Für diesen Vorgang ist die Schlüssel-/Listenberechtigung erforderlich. Beispielverwendung: 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)	Durch den Löschvorgang des gelöschten Schlüssels wird der Schlüssel dauerhaft entfernt, ohne dass eine Wiederherstellung möglich ist. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor aktiviert werden. Für diesen Vorgang sind die Schlüssel-/Löschberechtigungen erforderlich. Beispielverwendung: const client = new KeyClient(url, credentials); const deletePoller = await client.beginDeleteKey("MyKey") await deletePoller.pollUntilDone(); await client.purgeDeletedKey("MyKey"); Löscht den angegebenen Schlüssel endgültig.
releaseKey(string, string, ReleaseKeyOptions)	Gibt einen Schlüssel aus einem verwalteten HSM frei. Der Release key-Vorgang gilt für alle Schlüsseltypen. Für den Vorgang muss der Schlüssel als exportierbar gekennzeichnet werden, und die Schlüssel/Freigabeberechtigungen. Beispielverwendung: let client = new KeyClient(vaultUrl, credentials); let result = await client.releaseKey("myKey", target)
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)	Stellt einen gesicherten Schlüssel und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Schlüssel-/Wiederherstellungsberechtigung erforderlich. Beispielverwendung: let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); // ... let key = await client.restoreKeyBackup(backupContents); Stellt einen gesicherten Schlüssel in einem Tresor wieder her.
rotateKey(string, RotateKeyOptions)	Dreht den Schlüssel basierend auf der Schlüsselrichtlinie, indem eine neue Version des Schlüssels generiert wird. Für diesen Vorgang sind die Schlüssel/Drehberechtigungen erforderlich. Beispielverwendung: let client = new KeyClient(vaultUrl, credentials); let key = await client.rotateKey("MyKey");
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)	Die updateKeyProperties-Methode ändert die angegebenen Eigenschaften eines vorhandenen gespeicherten Schlüssels. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert eines Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang ist die Schlüssel-/Satzberechtigung erforderlich. Beispielverwendung: 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 }); Aktualisiert die Eigenschaften, die einem angegebenen Schlüssel in einem bestimmten Schlüsseltresor zugeordnet sind.
updateKeyProperties(string, UpdateKeyPropertiesOptions)	Die updateKeyProperties-Methode ändert die angegebenen Eigenschaften der neuesten Version eines vorhandenen gespeicherten Schlüssels. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert eines Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang ist die Schlüssel-/Satzberechtigung erforderlich. Beispielverwendung: let keyName = "MyKey"; let client = new KeyClient(vaultUrl, credentials); let key = await client.getKey(keyName); let result = await client.updateKeyProperties(keyName, { enabled: false }); Aktualisiert die Eigenschaften, die einem angegebenen Schlüssel in einem bestimmten Schlüsseltresor zugeordnet sind.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)	Aktualisiert die Rotationsrichtlinie eines Key Vault-Schlüssels. Für diesen Vorgang sind die Schlüssel/Aktualisierungsberechtigungen erforderlich. Beispielverwendung: let client = new KeyClient(vaultUrl, credentials); const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

Details zum Konstruktor

KeyClient(string, TokenCredential, KeyClientOptions)

Erstellt eine Instanz von KeyClient.

Beispielverwendung:

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)

Parameter

vaultUrl

string

die URL des Key Vault. Es sollte diese Form haben: https://${your-key-vault-name}.vault.azure.net. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault- oder verwaltete HSM-Ressource verweist. Weitere Informationen finden Sie unter https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Ein Objekt, das die TokenCredential Schnittstelle implementiert, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity-Paket, um eine Anmeldeinformation zu erstellen, die Ihren Anforderungen entspricht.

pipelineOptions

KeyClientOptions

Pipelineoptionen zum Konfigurieren von Key Vault-API-Anforderungen. Lassen Sie diesen Parameter aus, um die Standardpipelinekonfiguration zu verwenden.

Details zur Eigenschaft

vaultUrl

Die Basis-URL zum Tresor

vaultUrl: string

Eigenschaftswert

string

Details zur Methode

backupKey(string, BackupKeyOptions)

Fordert an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird. Alle Versionen des Schlüssels werden heruntergeladen. Für diesen Vorgang ist die Schlüssel-/Sicherungsberechtigung erforderlich.

Beispielverwendung:

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

Sichert den angegebenen Schlüssel.

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

Parameter

name

string

Der Name des Schlüssels.

options

BackupKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

Der Löschvorgang gilt für alle im Azure Key Vault gespeicherten Schlüssel. Einzelne Versionen eines Schlüssels können nicht gelöscht werden, nur alle Versionen eines bestimmten Schlüssels gleichzeitig.

Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Schlüssel gelöscht wird.

Für diesen Vorgang sind die Schlüssel/Löschberechtigungen erforderlich.

Beispielverwendung:

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);

Löscht einen Schlüssel aus einem angegebenen Schlüsseltresor.

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

Parameter

name

string

Der Name des Schlüssels.

options

BeginDeleteKeyOptions

Die optionalen Parameter.

Gibt zurück

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Stellt den gelöschten Schlüssel im angegebenen Tresor wieder her. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor ausgeführt werden.

Diese Funktion gibt einen Abrufvorgang mit langer Ausführung zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der gelöschte Schlüssel wiederhergestellt wird.

Für diesen Vorgang sind die Schlüssel/Wiederherstellungsberechtigungen erforderlich.

Beispielverwendung:

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);

Stellt den gelöschten Schlüssel auf die neueste Version wieder her.

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

Parameter

name

string

Der Name des gelöschten Schlüssels.

options

BeginRecoverDeletedKeyOptions

Die optionalen Parameter.

Gibt zurück

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

createEcKey(string, CreateEcKeyOptions)

Die createEcKey-Methode erstellt einen neuen elliptischen Kurvenschlüssel in Azure Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung.

Beispielverwendung:

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

Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.

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

Parameter

name

string

Der Name des Schlüssels.

options

CreateEcKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

Der Erstellungsschlüsselvorgang kann zum Erstellen eines beliebigen Schlüsseltyps in Azure Key Vault verwendet werden. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung.

Beispielverwendung:

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

Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.

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

Parameter

name

string

Der Name des Schlüssels.

keyType

string

Der Typ des Schlüssels. Eine der folgenden: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'.

options

CreateKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

Die createOctKey-Methode erstellt einen neuen OCT-Schlüssel im Azure Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung.

Beispielverwendung:

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

Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.

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

Parameter

name

string

Der Name des Schlüssels.

options

CreateOctKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

Die createRSAKey-Methode erstellt einen neuen RSA-Schlüssel im Azure Key Vault. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Sie erfordert die Schlüssel/Erstellungsberechtigung.

Beispielverwendung:

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

Erstellt einen neuen Schlüssel, speichert ihn und gibt dann Schlüsselparameter und Eigenschaften an den Client zurück.

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

Parameter

name

string

Der Name des Schlüssels.

options

CreateRsaKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Ruft einen CryptographyClient- für den angegebenen Schlüssel ab.

Beispielverwendung:

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

Parameter

keyName

string

options

GetCryptographyClientOptions

Gibt zurück

CryptographyClient

• Ein CryptographyClient mit den gleichen Optionen, Anmeldeinformationen und http-Client wie dieser KeyClient-

getDeletedKey(string, GetDeletedKeyOptions)

Die getDeletedKey-Methode gibt den angegebenen gelöschten Schlüssel zusammen mit seinen Eigenschaften zurück. Für diesen Vorgang sind die Schlüssel/Die Berechtigung "Abrufen" erforderlich.

Beispielverwendung:

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

Ruft den angegebenen gelöschten Schlüssel ab.

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

Parameter

name

string

Der Name des Schlüssels.

options

GetDeletedKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<DeletedKey>

getKey(string, GetKeyOptions)

Die getKey-Methode ruft einen angegebenen Schlüssel ab und gilt für jeden im Azure Key Vault gespeicherten Schlüssel. Für diesen Vorgang sind die Schlüssel/Die Berechtigung "Abrufen" erforderlich.

Beispielverwendung:

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

Rufen Sie einen angegebenen Schlüssel aus einem bestimmten Schlüsseltresor ab.

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

Parameter

name

string

Der Name des Schlüssels.

options

GetKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Ruft die Drehungsrichtlinie eines Key Vault-Schlüssels ab. Standardmäßig verfügen alle Schlüssel über eine Richtlinie, die 30 Tage vor Ablauf benachrichtigt.

Für diesen Vorgang sind die Schlüssel/Die Berechtigung "Abrufen" erforderlich. Beispielverwendung:

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

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

Parameter

keyName

string

Der Name des Schlüssels.

options

GetKeyRotationPolicyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Ruft die angeforderte Anzahl von Bytes ab, die Zufallswerte aus einem verwalteten HSM enthalten. Für diesen Vorgang ist die managedHsm/rng-Berechtigung erforderlich.

Beispielverwendung:

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);

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

Parameter

count

number

Die Anzahl der Bytes, die zwischen 1 und 128 einschließlich generiert werden sollen.

options

GetRandomBytesOptions

Die optionalen Parameter.

Gibt zurück

Promise<Uint8Array>

importKey(string, JsonWebKey, ImportKeyOptions)

Der Importschlüsselvorgang kann verwendet werden, um einen beliebigen Schlüsseltyp in einen Azure Key Vault zu importieren. Wenn der benannte Schlüssel bereits vorhanden ist, erstellt Azure Key Vault eine neue Version des Schlüssels. Für diesen Vorgang sind die Schlüssel/Importberechtigungen erforderlich.

Beispielverwendung:

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

Importiert einen extern erstellten Schlüssel, speichert ihn und gibt Schlüsselparameter und Eigenschaften an den Client zurück.

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

Parameter

name

string

Name für den importierten Schlüssel.

key

JsonWebKey

Der JSON-Webschlüssel.

options

ImportKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Durchläuft die gelöschten Schlüssel im Tresor. Der vollständige Schlüsselbezeichner und die Eigenschaften werden in der Antwort bereitgestellt. Für die Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Schlüssel-/Listenberechtigung erforderlich.

Beispielverwendung:

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

Auflisten aller Schlüssel im Tresor

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

Parameter

options

ListDeletedKeysOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Iterates the latest version of all keys in the vault. Der vollständige Schlüsselbezeichner und die Eigenschaften werden in der Antwort bereitgestellt. Für die Schlüssel werden keine Werte zurückgegeben. Für diese Vorgänge sind die Schlüssel-/Listenberechtigung erforderlich.

Beispielverwendung:

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

Auflisten aller Schlüssel im Tresor

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

Parameter

options

ListPropertiesOfKeysOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Durchläuft alle Versionen des angegebenen Schlüssels im Tresor. Der vollständige Schlüsselbezeichner, die Eigenschaften und Tags werden in der Antwort bereitgestellt. Für diesen Vorgang ist die Schlüssel-/Listenberechtigung erforderlich.

Beispielverwendung:

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>

Parameter

name

string

Name des Schlüssels zum Abrufen von Versionen für

options

ListPropertiesOfKeyVersionsOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

Durch den Löschvorgang des gelöschten Schlüssels wird der Schlüssel dauerhaft entfernt, ohne dass eine Wiederherstellung möglich ist. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor aktiviert werden. Für diesen Vorgang sind die Schlüssel-/Löschberechtigungen erforderlich.

Beispielverwendung:

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

Löscht den angegebenen Schlüssel endgültig.

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

Parameter

name

string

Der Name des Schlüssels.

options

PurgeDeletedKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Gibt einen Schlüssel aus einem verwalteten HSM frei.

Der Release key-Vorgang gilt für alle Schlüsseltypen. Für den Vorgang muss der Schlüssel als exportierbar gekennzeichnet werden, und die Schlüssel/Freigabeberechtigungen.

Beispielverwendung:

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

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

Parameter

name

string

Der Name des Schlüssels.

targetAttestationToken

string

Die Nachweis-Assertion für das Ziel der Key Release.

options

ReleaseKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Stellt einen gesicherten Schlüssel und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Schlüssel-/Wiederherstellungsberechtigung erforderlich.

Beispielverwendung:

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

Stellt einen gesicherten Schlüssel in einem Tresor wieder her.

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

Parameter

backup

Uint8Array

Das Sicherungs-BLOB, das einem Schlüsselbundle zugeordnet ist.

options

RestoreKeyBackupOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Dreht den Schlüssel basierend auf der Schlüsselrichtlinie, indem eine neue Version des Schlüssels generiert wird. Für diesen Vorgang sind die Schlüssel/Drehberechtigungen erforderlich.

Beispielverwendung:

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

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

Parameter

name

string

Der Name des zu drehenden Schlüssels.

options

RotateKeyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

Die updateKeyProperties-Methode ändert die angegebenen Eigenschaften eines vorhandenen gespeicherten Schlüssels. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert eines Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang ist die Schlüssel-/Satzberechtigung erforderlich.

Beispielverwendung:

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 });

Aktualisiert die Eigenschaften, die einem angegebenen Schlüssel in einem bestimmten Schlüsseltresor zugeordnet sind.

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

Parameter

name

string

Der Name des Schlüssels.

keyVersion

string

Die Version des Schlüssels.

options

UpdateKeyPropertiesOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

Die updateKeyProperties-Methode ändert die angegebenen Eigenschaften der neuesten Version eines vorhandenen gespeicherten Schlüssels. Eigenschaften, die in der Anforderung nicht angegeben sind, bleiben unverändert. Der Wert eines Schlüssels selbst kann nicht geändert werden. Für diesen Vorgang ist die Schlüssel-/Satzberechtigung erforderlich.

Beispielverwendung:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

Aktualisiert die Eigenschaften, die einem angegebenen Schlüssel in einem bestimmten Schlüsseltresor zugeordnet sind.

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

Parameter

name

string

Der Name des Schlüssels.

options

UpdateKeyPropertiesOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Aktualisiert die Rotationsrichtlinie eines Key Vault-Schlüssels. Für diesen Vorgang sind die Schlüssel/Aktualisierungsberechtigungen erforderlich.

Beispielverwendung:

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

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

Parameter

keyName

string

Der Name des Schlüssels.

policy

KeyRotationPolicyProperties

options

UpdateKeyRotationPolicyOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyRotationPolicy>