Compartir a través de

KeyVaultBackupClient class

  • Referencia
Paquete:
@azure/keyvault-admin

KeyVaultBackupClient proporciona métodos para generar copias de seguridad y restaurar copias de seguridad de cualquier instancia de Azure Key Vault determinada. Este cliente admite la generación de copias de seguridad completas, restauraciones selectivas de claves específicas y restauraciones completas de instancias de Key Vault.

Constructores

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Crea una instancia de KeyVaultBackupClient.

Ejemplo de uso:

import { KeyVaultBackupClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultBackupClient(vaultUrl, credentials);

Propiedades

vaultUrl

Dirección URL base del almacén

Métodos

beginBackup(string, KeyVaultBeginBackupOptions)

Comienza a generar una copia de seguridad de una instancia de Azure Key Vault en la cuenta de Storage Blob especificada mediante una identidad administrada asignada por el usuario para acceder a la cuenta de almacenamiento.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se genere la copia de seguridad de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri);

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

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

Inicia una operación de copia de seguridad completa.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Comienza a generar una copia de seguridad de una Key Vault de Azure en la cuenta de Storage Blob especificada.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se genere la copia de seguridad de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri, sasToken);

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

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

Inicia una operación de copia de seguridad completa.
beginRestore(string, KeyVaultBeginRestoreOptions)

Comienza a restaurar todos los materiales clave mediante el token de SAS que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente mediante una identidad administrada asignada por el usuario para acceder a la cuenta de almacenamiento.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, { resumeFrom: serialized });
//

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

Inicia una operación de restauración completa.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Comienza a restaurar todos los materiales clave mediante el token de SAS que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri, sasToken);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, sasToken, { resumeFrom: serialized });
//

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

Inicia una operación de restauración completa.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Comienza a restaurar todas las versiones clave de una clave determinada mediante en una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente. Se tendrá acceso a la carpeta de copia de seguridad de Blob Storage mediante la identidad administrada asignada por el usuario.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la restauración selectiva de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Crea una nueva asignación de roles.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Comienza a restaurar todas las versiones clave de una clave determinada mediante el token de SAS proporcionado por el usuario que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada anteriormente.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la restauración selectiva de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Crea una nueva asignación de roles.

Detalles del constructor

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Crea una instancia de KeyVaultBackupClient.

Ejemplo de uso:

import { KeyVaultBackupClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultBackupClient(vaultUrl, credentials);

new KeyVaultBackupClient(vaultUrl: string, credential: TokenCredential, options?: KeyVaultBackupClientOptions)

Parámetros

vaultUrl

string

dirección URL del Key Vault. Debe tener esta forma: https://${your-key-vault-name}.vault.azure.net. Debe validar que esta dirección URL hace referencia a un recurso de Key Vault o HSM administrado válido. Para obtener información detallada, vea https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

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

options
KeyVaultBackupClientOptions

opciones usadas para configurar solicitudes de API de Key Vault.

Detalles de las propiedades

vaultUrl

Dirección URL base del almacén

vaultUrl: string

Valor de propiedad

string

Detalles del método

beginBackup(string, KeyVaultBeginBackupOptions)

Comienza a generar una copia de seguridad de una instancia de Azure Key Vault en la cuenta de Storage Blob especificada mediante una identidad administrada asignada por el usuario para acceder a la cuenta de almacenamiento.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se genere la copia de seguridad de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri);

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

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

Inicia una operación de copia de seguridad completa.

function beginBackup(blobStorageUri: string, options?: KeyVaultBeginBackupOptions): Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

Parámetros

blobStorageUri

string

La dirección URL del recurso de Blob Storage, incluida la ruta de acceso al contenedor donde se almacenará la copia de seguridad.

options
KeyVaultBeginBackupOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Comienza a generar una copia de seguridad de una Key Vault de Azure en la cuenta de Storage Blob especificada.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se genere la copia de seguridad de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginBackup(blobStorageUri, sasToken);

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

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

Inicia una operación de copia de seguridad completa.

function beginBackup(blobStorageUri: string, sasToken: string, options?: KeyVaultBeginBackupOptions): Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

Parámetros

blobStorageUri

string

La dirección URL del recurso de Blob Storage, incluida la ruta de acceso al contenedor donde se almacenará la copia de seguridad.

sasToken

string

Token de SAS que se usa para acceder al recurso de Blob Storage.

options
KeyVaultBeginBackupOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Comienza a restaurar todos los materiales clave mediante el token de SAS que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente mediante una identidad administrada asignada por el usuario para acceder a la cuenta de almacenamiento.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, { resumeFrom: serialized });
//

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

Inicia una operación de restauración completa.

function beginRestore(folderUri: string, options?: KeyVaultBeginRestoreOptions): Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

Parámetros

folderUri

string

Dirección URL del recurso de Blob Storage donde se almacenó la copia de seguridad completa correcta anterior.

options
KeyVaultBeginRestoreOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Comienza a restaurar todos los materiales clave mediante el token de SAS que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
const sasToken = "<sas-token>";
const poller = await client.beginRestore(blobStorageUri, sasToken);

// The poller can be serialized with:
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginRestore(blobStorageUri, sasToken, { resumeFrom: serialized });
//

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

Inicia una operación de restauración completa.

function beginRestore(folderUri: string, sasToken: string, options?: KeyVaultBeginRestoreOptions): Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

Parámetros

folderUri

string

Dirección URL del recurso de Blob Storage donde se almacenó la copia de seguridad completa correcta anterior.

sasToken

string

Token de SAS. Si no se proporciona ningún token de SAS, se usará la identidad administrada asignada por el usuario para acceder al recurso de Blob Storage.

options
KeyVaultBeginRestoreOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Comienza a restaurar todas las versiones clave de una clave determinada mediante en una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente. Se tendrá acceso a la carpeta de copia de seguridad de Blob Storage mediante la identidad administrada asignada por el usuario.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la restauración selectiva de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Crea una nueva asignación de roles.

function beginSelectiveKeyRestore(keyName: string, folderUri: string, options?: KeyVaultBeginSelectiveKeyRestoreOptions): Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

Parámetros

keyName

string

Nombre de la clave que quiere restaurar.

folderUri

string

Dirección URL del recurso de Blob Storage, con el nombre de carpeta del blob donde se almacenó la copia de seguridad completa correcta anterior.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Comienza a restaurar todas las versiones clave de una clave determinada mediante el token de SAS proporcionado por el usuario que apunta a una carpeta de copia de seguridad de Azure Blob Storage almacenada anteriormente.

Esta función devuelve un sondeo de operación de larga duración que permite esperar indefinidamente hasta que se complete la restauración selectiva de Key Vault.

Ejemplo de uso:

const client = new KeyVaultBackupClient(url, credentials);

const blobStorageUri = "<blob-storage-uri>";
const sasToken = "<sas-token>";
const keyName = "<key-name>";
const poller = await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken);

// Serializing the poller
//
//   const serialized = poller.toString();
//
// A new poller can be created with:
//
//   await client.beginSelectiveKeyRestore(keyName, blobStorageUri, sasToken, { resumeFrom: serialized });
//

// Waiting until it's done
await poller.pollUntilDone();

Crea una nueva asignación de roles.

function beginSelectiveKeyRestore(keyName: string, folderUri: string, sasToken: string, options?: KeyVaultBeginSelectiveKeyRestoreOptions): Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

Parámetros

keyName

string

Nombre de la clave que quiere restaurar.

folderUri

string

Dirección URL del recurso de Blob Storage, con el nombre de carpeta del blob donde se almacenó la copia de seguridad completa correcta anterior.

sasToken

string

Token de SAS. Si no se proporciona ningún token de SAS, se usará la identidad administrada asignada por el usuario para acceder al recurso de Blob Storage.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>