Compartir a través de

KeyClient class

  • Referencia
Paquete:
@azure/keyvault-keys

KeyClient proporciona métodos para administrar <xref:KeyVaultKey> en azure Key Vault. El cliente admite la creación, recuperación, actualización, eliminación, purgado, copia de seguridad, restauración y enumeración de KeyVaultKeys. El cliente también admite la lista <xref:DeletedKey> de una eliminación temporal habilitada para Azure Key Vault.

Constructores

KeyClient(string, TokenCredential, KeyClientOptions)

Crea una instancia de KeyClient. Ejemplo de uso:

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

Propiedades

vaultUrl

Dirección URL base del almacén

Métodos

backupKey(string, BackupKeyOptions)

Solicita que se descargue una copia de seguridad de la clave especificada en el cliente. Se descargarán todas las versiones de la clave. Esta operación requiere el permiso keys/backup. Ejemplo de uso:

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

Realiza una copia de seguridad de la clave especificada.
beginDeleteKey(string, BeginDeleteKeyOptions)

La operación de eliminación se aplica a cualquier clave almacenada en Azure Key Vault. No se pueden eliminar versiones individuales de una clave, solo todas las versiones de una clave determinada a la vez. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se elimine la clave.

Esta operación requiere el permiso keys/delete.

Ejemplo de uso:

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

Elimina una clave de un almacén de claves especificado.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Recupera la clave eliminada en el almacén especificado. Esta operación solo se puede realizar en un almacén habilitado para eliminación temporal. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se recupere la clave eliminada.

Esta operación requiere el permiso de claves y recuperación.

Ejemplo de uso:

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

Recupera la clave eliminada a la versión más reciente.
createEcKey(string, CreateEcKeyOptions)

El método createEcKey crea una nueva clave de curva elíptica en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.
createKey(string, KeyType, CreateKeyOptions)

La operación de creación de clave se puede usar para crear cualquier tipo de clave en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.
createOctKey(string, CreateOctKeyOptions)

El método createOctKey crea una nueva clave OCT en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.
createRsaKey(string, CreateRsaKeyOptions)

El método createRSAKey crea una nueva clave RSA en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.
getDeletedKey(string, GetDeletedKeyOptions)

El método getDeletedKey devuelve la clave eliminada especificada junto con sus propiedades. Esta operación requiere el permiso keys/get. Ejemplo de uso:

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

Obtiene la clave eliminada especificada.
getKey(string, GetKeyOptions)

El método getKey obtiene una clave especificada y es aplicable a cualquier clave almacenada en Azure Key Vault. Esta operación requiere el permiso keys/get. Ejemplo de uso:

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

Obtenga una clave especificada de un almacén de claves determinado.
importKey(string, JsonWebKey, ImportKeyOptions)

La operación de importación de clave se puede usar para importar cualquier tipo de clave en una Key Vault de Azure. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Esta operación requiere el permiso keys/import. Ejemplo de uso:

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

Importa una clave creada externamente, la almacena y devuelve parámetros de clave y propiedades al cliente.
listDeletedKeys(ListDeletedKeysOptions)

Itera las claves eliminadas en el almacén. El identificador y las propiedades de clave completa se proporcionan en la respuesta. No se devuelve ningún valor para las claves. Estas operaciones requieren el permiso keys/list. Ejemplo de uso:

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

Enumeración de todas las claves del almacén
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Itera la versión más reciente de todas las claves del almacén. El identificador y las propiedades de clave completa se proporcionan en la respuesta. No se devuelve ningún valor para las claves. Estas operaciones requieren el permiso keys/list. Ejemplo de uso:

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

Enumeración de todas las claves del almacén
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Itera todas las versiones de la clave especificada en el almacén. El identificador de clave completo, las propiedades y las etiquetas se proporcionan en la respuesta. Esta operación requiere el permiso keys/list. Ejemplo de uso:

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)

La operación de purga de clave eliminada quita la clave de forma permanente, sin la posibilidad de recuperación. Esta operación solo se puede habilitar en un almacén habilitado para eliminación temporal. Esta operación requiere el permiso de purga o claves. Ejemplo de uso:

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

Elimina permanentemente la clave especificada.
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Restaura una clave de copia de seguridad y todas sus versiones en un almacén. Esta operación requiere el permiso de claves y restauración. Ejemplo de uso:

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

Restaura una clave de copia de seguridad en un almacén.
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

El método updateKeyProperties cambia las propiedades especificadas de una clave almacenada existente. Las propiedades que no se especifican en la solicitud se dejan sin cambios. No se puede cambiar el valor de una clave en sí. Esta operación requiere el permiso keys/set. Ejemplo de uso:

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

Novedades las propiedades asociadas a una clave especificada en un almacén de claves determinado.

Detalles del constructor

KeyClient(string, TokenCredential, KeyClientOptions)

Crea una instancia de KeyClient. Ejemplo de uso:

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)

Parámetros

vaultUrl

string

dirección URL del Key Vault. Debe tener esta forma: https://${your-key-vault-name}.vault.azure.net

credential

TokenCredential

Objeto que implementa la TokenCredential interfaz utilizada para autenticar las solicitudes en el servicio. Use el paquete de @azure/identidad para crear una credencial que se adapte a sus necesidades.

pipelineOptions
KeyClientOptions

Opciones de canalización usadas para configurar Key Vault solicitudes de API. Omita este parámetro para usar la configuración de canalización predeterminada.

Detalles de las propiedades

vaultUrl

Dirección URL base del almacén

vaultUrl: string

Valor de propiedad

string

Detalles del método

backupKey(string, BackupKeyOptions)

Solicita que se descargue una copia de seguridad de la clave especificada en el cliente. Se descargarán todas las versiones de la clave. Esta operación requiere el permiso keys/backup. Ejemplo de uso:

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

Realiza una copia de seguridad de la clave especificada.

function backupKey(name: string, options?: BackupKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
BackupKeyOptions

Parámetros opcionales.

Devoluciones

Promise<Uint8Array | undefined>

beginDeleteKey(string, BeginDeleteKeyOptions)

La operación de eliminación se aplica a cualquier clave almacenada en Azure Key Vault. No se pueden eliminar versiones individuales de una clave, solo todas las versiones de una clave determinada a la vez. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se elimine la clave.

Esta operación requiere el permiso keys/delete.

Ejemplo de uso:

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

Elimina una clave de un almacén de claves especificado.

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
BeginDeleteKeyOptions

Parámetros opcionales.

Devoluciones

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Recupera la clave eliminada en el almacén especificado. Esta operación solo se puede realizar en un almacén habilitado para eliminación temporal. Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se recupere la clave eliminada.

Esta operación requiere el permiso de claves y recuperación.

Ejemplo de uso:

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

Recupera la clave eliminada a la versión más reciente.

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions)

Parámetros

name

string

Nombre de la clave eliminada.

options
BeginRecoverDeletedKeyOptions

Parámetros opcionales.

Devoluciones

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

createEcKey(string, CreateEcKeyOptions)

El método createEcKey crea una nueva clave de curva elíptica en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.

function createEcKey(name: string, options?: CreateEcKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
CreateEcKeyOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>

createKey(string, KeyType, CreateKeyOptions)

La operación de creación de clave se puede usar para crear cualquier tipo de clave en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.

function createKey(name: string, keyType: KeyType, options?: CreateKeyOptions)

Parámetros

name

string

El nombre de la clave.

keyType
KeyType

Tipo de la clave. Uno de los siguientes: "EC", "EC-HSM", "RSA", "RSA-HSM", "oct".

options
CreateKeyOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

El método createOctKey crea una nueva clave OCT en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.

function createOctKey(name: string, options?: CreateOctKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
CreateOctKeyOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

El método createRSAKey crea una nueva clave RSA en Azure Key Vault. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Requiere el permiso keys/create. Ejemplo de uso:

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

Crea una nueva clave, la almacena y, a continuación, devuelve los parámetros de clave y las propiedades al cliente.

function createRsaKey(name: string, options?: CreateRsaKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
CreateRsaKeyOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>

getDeletedKey(string, GetDeletedKeyOptions)

El método getDeletedKey devuelve la clave eliminada especificada junto con sus propiedades. Esta operación requiere el permiso keys/get. Ejemplo de uso:

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

Obtiene la clave eliminada especificada.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
GetDeletedKeyOptions

Parámetros opcionales.

Devoluciones

Promise<DeletedKey>

getKey(string, GetKeyOptions)

El método getKey obtiene una clave especificada y es aplicable a cualquier clave almacenada en Azure Key Vault. Esta operación requiere el permiso keys/get. Ejemplo de uso:

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

Obtenga una clave especificada de un almacén de claves determinado.

function getKey(name: string, options?: GetKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
GetKeyOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>

importKey(string, JsonWebKey, ImportKeyOptions)

La operación de importación de clave se puede usar para importar cualquier tipo de clave en una Key Vault de Azure. Si ya existe la clave con ese nombre, Azure Key Vault crea una nueva versión de la clave. Esta operación requiere el permiso keys/import. Ejemplo de uso:

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

Importa una clave creada externamente, la almacena y devuelve parámetros de clave y propiedades al cliente.

function importKey(name: string, key: JsonWebKey, options?: ImportKeyOptions)

Parámetros

name

string

Nombre de la clave importada.

key
JsonWebKey

Clave web JSON.

options
ImportKeyOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Itera las claves eliminadas en el almacén. El identificador y las propiedades de clave completa se proporcionan en la respuesta. No se devuelve ningún valor para las claves. Estas operaciones requieren el permiso keys/list. Ejemplo de uso:

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

Enumeración de todas las claves del almacén

function listDeletedKeys(options?: ListDeletedKeysOptions)

Parámetros

options
ListDeletedKeysOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<DeletedKey>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Itera la versión más reciente de todas las claves del almacén. El identificador y las propiedades de clave completa se proporcionan en la respuesta. No se devuelve ningún valor para las claves. Estas operaciones requieren el permiso keys/list. Ejemplo de uso:

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

Enumeración de todas las claves del almacén

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions)

Parámetros

options
ListPropertiesOfKeysOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<KeyProperties>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Itera todas las versiones de la clave especificada en el almacén. El identificador de clave completo, las propiedades y las etiquetas se proporcionan en la respuesta. Esta operación requiere el permiso keys/list. Ejemplo de uso:

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)

Parámetros

name

string

Nombre de la clave para la que se van a capturar las versiones

options
ListPropertiesOfKeyVersionsOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<KeyProperties>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

La operación de purga de clave eliminada quita la clave de forma permanente, sin la posibilidad de recuperación. Esta operación solo se puede habilitar en un almacén habilitado para eliminación temporal. Esta operación requiere el permiso de purga o claves. Ejemplo de uso:

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

Elimina permanentemente la clave especificada.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions)

Parámetros

name

string

El nombre de la clave.

options
PurgeDeletedKeyOptions

Parámetros opcionales.

Devoluciones

Promise<void>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Restaura una clave de copia de seguridad y todas sus versiones en un almacén. Esta operación requiere el permiso de claves y restauración. Ejemplo de uso:

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

Restaura una clave de copia de seguridad en un almacén.

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions)

Parámetros

backup

Uint8Array

Blob de copia de seguridad asociado a una agrupación de claves.

options
RestoreKeyBackupOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

El método updateKeyProperties cambia las propiedades especificadas de una clave almacenada existente. Las propiedades que no se especifican en la solicitud se dejan sin cambios. No se puede cambiar el valor de una clave en sí. Esta operación requiere el permiso keys/set. Ejemplo de uso:

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

Novedades las propiedades asociadas a una clave especificada en un almacén de claves determinado.

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions)

Parámetros

name

string

El nombre de la clave.

keyVersion

string

Versión de la clave.

options
UpdateKeyPropertiesOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultKey>