KeyClient class

Référence

Paquet:: @azure/keyvault-keys

KeyClient fournit des méthodes pour gérer KeyVaultKey dans azure Key Vault. Le client prend en charge la création, la récupération, la mise à jour, la suppression, le vidage, la sauvegarde, la restauration et la liste des KeyVaultKeys. Le client prend également en charge la liste DeletedKey pour une Key Vault Azure activée pour la suppression réversible.

Constructeurs

KeyClient(string, TokenCredential, KeyClientOptions)

Crée une instance de KeyClient.

Exemple d’utilisation :

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

Propriétés

vaultUrl

URL de base du coffre

Méthodes

backupKey(string, BackupKeyOptions)	Demande qu’une sauvegarde de la clé spécifiée soit téléchargée sur le client. Toutes les versions de la clé seront téléchargées. Cette opération nécessite l’autorisation clés/sauvegarde. Exemple d’utilisation : `let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey");` Sauvegarde la clé spécifiée.
beginDeleteKey(string, BeginDeleteKeyOptions)	L’opération de suppression s’applique à toute clé stockée dans Azure Key Vault. Les versions individuelles d’une clé ne peuvent pas être supprimées, seules toutes les versions d’une clé donnée à la fois. Cette fonction retourne un pollueur d’opération de longue durée qui vous permet d’attendre indéfiniment que la clé soit supprimée. Cette opération nécessite l’autorisation keys/delete. Exemple d’utilisation : `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);` Supprime une clé d’un coffre de clés spécifié.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)	Récupère la clé supprimée dans le coffre spécifié. Cette opération ne peut être effectuée que sur un coffre avec suppression réversible. Cette fonction retourne un pollueur d’opération de longue durée qui vous permet d’attendre indéfiniment que la clé supprimée soit récupérée. Cette opération nécessite l’autorisation clés/récupération. Exemple d’utilisation : 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); Récupère la clé supprimée dans la dernière version.
createEcKey(string, CreateEcKeyOptions)	La méthode createEcKey crée une nouvelle clé de courbe elliptique dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création. Exemple d’utilisation : `let client = new KeyClient(url, credentials); let result = await client.createEcKey("MyKey", { curve: "P-256" });` Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.
createKey(string, string, CreateKeyOptions)	L’opération de création de clé peut être utilisée pour créer n’importe quel type de clé dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création. Exemple d’utilisation : `let client = new KeyClient(url, credentials); // Create an elliptic-curve key: let result = await client.createKey("MyKey", "EC");` Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.
createOctKey(string, CreateOctKeyOptions)	La méthode createOctKey crée une nouvelle clé OCT dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création. Exemple d’utilisation : `let client = new KeyClient(url, credentials); let result = await client.createOctKey("MyKey", { hsm: true });` Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.
createRsaKey(string, CreateRsaKeyOptions)	La méthode createRSAKey crée une nouvelle clé RSA dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création. Exemple d’utilisation : `let client = new KeyClient(url, credentials); let result = await client.createRsaKey("MyKey", { keySize: 2048 });` Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.
getCryptographyClient(string, GetCryptographyClientOptions)	Obtient un chiffrementClient pour la clé donnée. Exemple d’utilisation : `let client = new KeyClient(url, credentials); // get a cryptography client for a given key let cryptographyClient = client.getCryptographyClient("MyKey");`
getDeletedKey(string, GetDeletedKeyOptions)	La méthode getDeletedKey retourne la clé supprimée spécifiée ainsi que ses propriétés. Cette opération nécessite l’autorisation keys/get. Exemple d’utilisation : `let client = new KeyClient(url, credentials); let key = await client.getDeletedKey("MyDeletedKey");` Obtient la clé supprimée spécifiée.
getKey(string, GetKeyOptions)	La méthode getKey obtient une clé spécifiée et s’applique à toute clé stockée dans Azure Key Vault. Cette opération nécessite l’autorisation keys/get. Exemple d’utilisation : `let client = new KeyClient(url, credentials); let key = await client.getKey("MyKey");` Obtenez une clé spécifiée à partir d’un coffre de clés donné.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)	Obtient la stratégie de rotation d’une clé Key Vault. Par défaut, toutes les clés ont une stratégie qui notifie 30 jours avant l’expiration. Cette opération nécessite l’autorisation keys/get. Exemple d’utilisation : `let client = new KeyClient(vaultUrl, credentials); let result = await client.getKeyRotationPolicy("myKey");`
getRandomBytes(number, GetRandomBytesOptions)	Obtient le nombre d’octets demandé contenant des valeurs aléatoires à partir d’un HSM managé. Cette opération nécessite l’autorisation managedHsm/rng. Exemple d’utilisation : `let client = new KeyClient(vaultUrl, credentials); let { bytes } = await client.getRandomBytes(10);`
importKey(string, JsonWebKey_2, ImportKeyOptions)	L’opération d’importation de clé peut être utilisée pour importer n’importe quel type de clé dans un Key Vault Azure. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Cette opération nécessite l’autorisation clés/importation. Exemple d’utilisation : `let client = new KeyClient(url, credentials); // Key contents in myKeyContents let result = await client.importKey("MyKey", myKeyContents);` Importe une clé créée en externe, la stocke et retourne les paramètres de clé et les propriétés au client.
listDeletedKeys(ListDeletedKeysOptions)	Itère les clés supprimées dans le coffre. L’identificateur de clé complet et les propriétés sont fournis dans la réponse. Aucune valeur n’est retournée pour les clés. Cette opération nécessite l’autorisation clés/liste. Exemple d’utilisation : `let client = new KeyClient(url, credentials); for await (const deletedKey of client.listDeletedKeys()) { console.log("deleted key: ", deletedKey); }` Répertorier toutes les clés dans le coffre
listPropertiesOfKeys(ListPropertiesOfKeysOptions)	Itère la dernière version de toutes les clés du coffre. L’identificateur de clé complet et les propriétés sont fournis dans la réponse. Aucune valeur n’est retournée pour les clés. Cette opération nécessite l’autorisation clés/liste. Exemple d’utilisation : `let client = new KeyClient(url, credentials); for await (const keyProperties of client.listPropertiesOfKeys()) { const key = await client.getKey(keyProperties.name); console.log("key: ", key); }` Répertorier toutes les clés dans le coffre
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)	Itère toutes les versions de la clé donnée dans le coffre. L’identificateur de clé, les propriétés et les balises complets sont fournis dans la réponse. Cette opération nécessite l’autorisation clés/liste. Exemple d’utilisation : `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)	L’opération de vidage de la clé supprimée supprime la clé définitivement, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre activé pour la suppression réversible. Cette opération nécessite l’autorisation clés/vidage. Exemple d’utilisation : `const client = new KeyClient(url, credentials); const deletePoller = await client.beginDeleteKey("MyKey") await deletePoller.pollUntilDone(); await client.purgeDeletedKey("MyKey");` Supprime définitivement la clé spécifiée.
releaseKey(string, string, ReleaseKeyOptions)	Libère une clé à partir d’un HSM managé. L’opération de clé de mise en production s’applique à tous les types de clés. L’opération nécessite que la clé soit marquée comme exportable et l’autorisation clés/mise en production. Exemple d’utilisation : `let client = new KeyClient(vaultUrl, credentials); let result = await client.releaseKey("myKey", target)`
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)	Restaure une clé sauvegardée et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation clés/restauration. Exemple d’utilisation : `let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); // ... let key = await client.restoreKeyBackup(backupContents);` Restaure une clé sauvegardée dans un coffre.
rotateKey(string, RotateKeyOptions)	Fait pivoter la clé en fonction de la stratégie de clé en générant une nouvelle version de la clé. Cette opération nécessite l’autorisation clés/rotation. Exemple d’utilisation : `let client = new KeyClient(vaultUrl, credentials); let key = await client.rotateKey("MyKey");`
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)	La méthode updateKeyProperties modifie les propriétés spécifiées d’une clé stockée existante. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d’une clé elle-même ne peut pas être modifiée. Cette opération nécessite l’autorisation keys/set. Exemple d’utilisation : `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 });` Mises à jour les propriétés associées à une clé spécifiée dans un coffre de clés donné.
updateKeyProperties(string, UpdateKeyPropertiesOptions)	La méthode updateKeyProperties modifie les propriétés spécifiées de la dernière version d’une clé stockée existante. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d’une clé elle-même ne peut pas être modifiée. Cette opération nécessite l’autorisation keys/set. Exemple d’utilisation : `let keyName = "MyKey"; let client = new KeyClient(vaultUrl, credentials); let key = await client.getKey(keyName); let result = await client.updateKeyProperties(keyName, { enabled: false });` Mises à jour les propriétés associées à une clé spécifiée dans un coffre de clés donné.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)	Mises à jour la stratégie de rotation d’une clé Key Vault. Cette opération nécessite l’autorisation clés/mise à jour. Exemple d’utilisation : `let client = new KeyClient(vaultUrl, credentials); const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);`

Détails du constructeur

KeyClient(string, TokenCredential, KeyClientOptions)

Crée une instance de KeyClient.

Exemple d’utilisation :

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)

Paramètres

vaultUrl: string

URL du Key Vault. Il doit avoir la forme suivante : https://${your-key-vault-name}.vault.azure.net. Vous devez vérifier que cette URL fait référence à une ressource Key Vault ou HSM managée valide. Pour plus d'informations, consultez https://aka.ms/azsdk/blog/vault-uri.

credential: TokenCredential

Objet qui implémente l’interface TokenCredential utilisée pour authentifier les demandes adressées au service. Utilisez le @azure/identity package pour créer des informations d’identification qui correspondent à vos besoins.

pipelineOptions: KeyClientOptions

Options de pipeline utilisées pour configurer Key Vault demandes d’API. Omettez ce paramètre pour utiliser la configuration de pipeline par défaut.

Détails de la propriété

vaultUrl

URL de base du coffre

vaultUrl: string

Valeur de propriété

string

Détails de la méthode

backupKey(string, BackupKeyOptions)

Demande qu’une sauvegarde de la clé spécifiée soit téléchargée sur le client. Toutes les versions de la clé seront téléchargées. Cette opération nécessite l’autorisation clés/sauvegarde.

Exemple d’utilisation :

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

Sauvegarde la clé spécifiée.

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

Paramètres

name: string

Nom de la clé.

options: BackupKeyOptions

Paramètres facultatifs.

Retours

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

L’opération de suppression s’applique à toute clé stockée dans Azure Key Vault. Les versions individuelles d’une clé ne peuvent pas être supprimées, seules toutes les versions d’une clé donnée à la fois.

Cette fonction retourne un pollueur d’opération de longue durée qui vous permet d’attendre indéfiniment que la clé soit supprimée.

Cette opération nécessite l’autorisation keys/delete.

Exemple d’utilisation :

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

Supprime une clé d’un coffre de clés spécifié.

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

Paramètres

name: string

Nom de la clé.

options: BeginDeleteKeyOptions

Paramètres facultatifs.

Retours

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Récupère la clé supprimée dans le coffre spécifié. Cette opération ne peut être effectuée que sur un coffre avec suppression réversible.

Cette fonction retourne un pollueur d’opération de longue durée qui vous permet d’attendre indéfiniment que la clé supprimée soit récupérée.

Cette opération nécessite l’autorisation clés/récupération.

Exemple d’utilisation :

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

Récupère la clé supprimée dans la dernière version.

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

Paramètres

name: string

Nom de la clé supprimée.

options: BeginRecoverDeletedKeyOptions

Paramètres facultatifs.

Retours

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

createEcKey(string, CreateEcKeyOptions)

La méthode createEcKey crée une nouvelle clé de courbe elliptique dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création.

Exemple d’utilisation :

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

Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.

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

Paramètres

name: string

Nom de la clé.

options: CreateEcKeyOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

L’opération de création de clé peut être utilisée pour créer n’importe quel type de clé dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création.

Exemple d’utilisation :

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

Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.

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

Paramètres

name: string

Nom de la clé.

keyType: string

Type de la clé. L’un des éléments suivants : 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'.

options: CreateKeyOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

La méthode createOctKey crée une nouvelle clé OCT dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création.

Exemple d’utilisation :

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

Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.

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

Paramètres

name: string

Nom de la clé.

options: CreateOctKeyOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

La méthode createRSAKey crée une nouvelle clé RSA dans Azure Key Vault. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Il nécessite l’autorisation clés/création.

Exemple d’utilisation :

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

Crée une clé, la stocke, puis retourne les paramètres de clé et les propriétés au client.

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

Paramètres

name: string

Nom de la clé.

options: CreateRsaKeyOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Obtient un chiffrementClient pour la clé donnée.

Exemple d’utilisation :

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

Paramètres

keyName: string

options: GetCryptographyClientOptions

Retours

CryptographyClient

Un Client Cryptography utilisant les mêmes options, informations d’identification et client http que ce KeyClient

getDeletedKey(string, GetDeletedKeyOptions)

La méthode getDeletedKey retourne la clé supprimée spécifiée ainsi que ses propriétés. Cette opération nécessite l’autorisation keys/get.

Exemple d’utilisation :

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

Obtient la clé supprimée spécifiée.

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

Paramètres

name: string

Nom de la clé.

options: GetDeletedKeyOptions

Paramètres facultatifs.

Retours

Promise<DeletedKey>

getKey(string, GetKeyOptions)

La méthode getKey obtient une clé spécifiée et s’applique à toute clé stockée dans Azure Key Vault. Cette opération nécessite l’autorisation keys/get.

Exemple d’utilisation :

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

Obtenez une clé spécifiée à partir d’un coffre de clés donné.

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

Paramètres

name: string

Nom de la clé.

options: GetKeyOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Obtient la stratégie de rotation d’une clé Key Vault. Par défaut, toutes les clés ont une stratégie qui notifie 30 jours avant l’expiration.

Cette opération nécessite l’autorisation keys/get. Exemple d’utilisation :

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

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

Paramètres

keyName: string

Nom de la clé.

options: GetKeyRotationPolicyOptions

Paramètres facultatifs.

Retours

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Obtient le nombre d’octets demandé contenant des valeurs aléatoires à partir d’un HSM managé. Cette opération nécessite l’autorisation managedHsm/rng.

Exemple d’utilisation :

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

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

Paramètres

count: number

Nombre d’octets à générer entre 1 et 128 inclus.

options: GetRandomBytesOptions

Paramètres facultatifs.

Retours

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

L’opération d’importation de clé peut être utilisée pour importer n’importe quel type de clé dans un Key Vault Azure. Si la clé nommée existe déjà, le coffre de clés Azure en crée une nouvelle version. Cette opération nécessite l’autorisation clés/importation.

Exemple d’utilisation :

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

Importe une clé créée en externe, la stocke et retourne les paramètres de clé et les propriétés au client.

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

Paramètres

name: string

Nom de la clé importée.

key: JsonWebKey

Clé web JSON.

options: ImportKeyOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Itère les clés supprimées dans le coffre. L’identificateur de clé complet et les propriétés sont fournis dans la réponse. Aucune valeur n’est retournée pour les clés. Cette opération nécessite l’autorisation clés/liste.

Exemple d’utilisation :

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

Répertorier toutes les clés dans le coffre

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

Paramètres

options: ListDeletedKeysOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Itère la dernière version de toutes les clés du coffre. L’identificateur de clé complet et les propriétés sont fournis dans la réponse. Aucune valeur n’est retournée pour les clés. Cette opération nécessite l’autorisation clés/liste.

Exemple d’utilisation :

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

Répertorier toutes les clés dans le coffre

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

Paramètres

options: ListPropertiesOfKeysOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Itère toutes les versions de la clé donnée dans le coffre. L’identificateur de clé, les propriétés et les balises complets sont fournis dans la réponse. Cette opération nécessite l’autorisation clés/liste.

Exemple d’utilisation :

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>

Paramètres

name: string

Nom de la clé pour laquelle extraire les versions

options: ListPropertiesOfKeyVersionsOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

L’opération de vidage de la clé supprimée supprime la clé définitivement, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre activé pour la suppression réversible. Cette opération nécessite l’autorisation clés/vidage.

Exemple d’utilisation :

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

Supprime définitivement la clé spécifiée.

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

Paramètres

name: string

Nom de la clé.

options: PurgeDeletedKeyOptions

Paramètres facultatifs.

Retours

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Libère une clé à partir d’un HSM managé.

L’opération de clé de mise en production s’applique à tous les types de clés. L’opération nécessite que la clé soit marquée comme exportable et l’autorisation clés/mise en production.

Exemple d’utilisation :

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

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

Paramètres

name: string

Nom de la clé.

targetAttestationToken: string

Assertion d’attestation pour la cible de la mise en production de clé.

options: ReleaseKeyOptions

Paramètres facultatifs.

Retours

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Restaure une clé sauvegardée et toutes ses versions dans un coffre. Cette opération nécessite l’autorisation clés/restauration.

Exemple d’utilisation :

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

Restaure une clé sauvegardée dans un coffre.

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

Paramètres

backup: Uint8Array

Objet blob de sauvegarde associé à un bundle de clés.

options: RestoreKeyBackupOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Fait pivoter la clé en fonction de la stratégie de clé en générant une nouvelle version de la clé. Cette opération nécessite l’autorisation clés/rotation.

Exemple d’utilisation :

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

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

Paramètres

name: string

Nom de la clé à faire pivoter.

options: RotateKeyOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

La méthode updateKeyProperties modifie les propriétés spécifiées d’une clé stockée existante. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d’une clé elle-même ne peut pas être modifiée. Cette opération nécessite l’autorisation keys/set.

Exemple d’utilisation :

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

Mises à jour les propriétés associées à une clé spécifiée dans un coffre de clés donné.

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

Paramètres

name: string

Nom de la clé.

keyVersion: string

Version de la clé.

options: UpdateKeyPropertiesOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

La méthode updateKeyProperties modifie les propriétés spécifiées de la dernière version d’une clé stockée existante. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d’une clé elle-même ne peut pas être modifiée. Cette opération nécessite l’autorisation keys/set.

Exemple d’utilisation :

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

Mises à jour les propriétés associées à une clé spécifiée dans un coffre de clés donné.

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

Paramètres

name: string

Nom de la clé.

options: UpdateKeyPropertiesOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Mises à jour la stratégie de rotation d’une clé Key Vault. Cette opération nécessite l’autorisation clés/mise à jour.

Exemple d’utilisation :

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

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

Paramètres

keyName: string

Nom de la clé.

policy: KeyRotationPolicyProperties

options: UpdateKeyRotationPolicyOptions

Paramètres facultatifs.

Retours

Promise<KeyRotationPolicy>