Compartir a través de

KeyVaultBackupClient class

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.

Uso de ejemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const 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 Storage.

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

Uso de ejemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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 instancia de Azure Key Vault en la cuenta de Storage Blob especificada.

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

Uso de ejemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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.
beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Inicia una operación de copia de seguridad previa que se puede usar para comprobar si el cliente puede realizar una operación de beginBackup mediante la identidad administrada asignada por el usuario del HSM configurada para autenticarse con Azure Storage.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, { resumeFrom: serialized });

// Waiting until it's done
const result = await poller.pollUntilDone();
console.log(result);
beginPreBackup(string, string, KeyVaultBeginPreBackupOptions)

Inicia una operación anterior a la copia de seguridad que se puede usar para comprobar si el cliente puede realizar una operación de beginBackup mediante el token de SAS proporcionado.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, sasToken, { resumeFrom: serialized });

// Waiting until it's done
const result = await poller.pollUntilDone();
console.log(result);
beginPreRestore(string, KeyVaultBeginPreRestoreOptions)

Inicia una operación de restauración previa que se puede usar para comprobar si el cliente puede realizar una operación de beginRestore mediante el token de SAS proporcionado.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

// Waiting until it's done
await poller.pollUntilDone();
beginPreRestore(string, string, KeyVaultBeginPreRestoreOptions)

Inicia una operación de restauración previa que se puede usar para comprobar si el cliente puede realizar una operación de beginRestore mediante el token de SAS proporcionado.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

// Waiting until it's done
await poller.pollUntilDone();
beginRestore(string, KeyVaultBeginRestoreOptions)

Inicia la restauración de 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 ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Uso de ejemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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
await poller.pollUntilDone();

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 ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Uso de ejemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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)

Inicia la restauración de todas las versiones clave de una clave determinada mediante a una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente. Se accederá 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 ejecución prolongada que permite esperar indefinidamente hasta que se complete la restauración selectiva de Key Vault.

Uso de ejemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginSelectiveKeyRestore(keyName, blobStorageUri, { resumeFrom: serialized });

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

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

Inicia la restauración de 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 previamente.

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

Uso de ejemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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.

Uso de ejemplo:

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

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

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

Parámetros

vaultUrl

string

la dirección URL de 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. Consulte https://aka.ms/azsdk/blog/vault-uri para obtener más información.

credential
TokenCredential

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

options
KeyVaultBackupClientOptions

opciones que se usan 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 Storage.

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

Uso de ejemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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 instancia de Azure Key Vault en la cuenta de Storage Blob especificada.

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

Uso de ejemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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>>

beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Inicia una operación de copia de seguridad previa que se puede usar para comprobar si el cliente puede realizar una operación de beginBackup mediante la identidad administrada asignada por el usuario del HSM configurada para autenticarse con Azure Storage.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, { resumeFrom: serialized });

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

function beginPreBackup(blobStorageUri: string, options?: KeyVaultBeginPreBackupOptions): 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
KeyVaultBeginPreBackupOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, string, KeyVaultBeginPreBackupOptions)

Inicia una operación anterior a la copia de seguridad que se puede usar para comprobar si el cliente puede realizar una operación de beginBackup mediante el token de SAS proporcionado.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreBackup(blobStorageUri, sasToken, { resumeFrom: serialized });

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

function beginPreBackup(blobStorageUri: string, sasToken: string, options?: KeyVaultBeginPreBackupOptions): 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
KeyVaultBeginPreBackupOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreRestore(string, KeyVaultBeginPreRestoreOptions)

Inicia una operación de restauración previa que se puede usar para comprobar si el cliente puede realizar una operación de beginRestore mediante el token de SAS proporcionado.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

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

function beginPreRestore(folderUri: string, options?: KeyVaultBeginPreRestoreOptions): 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
KeyVaultBeginPreRestoreOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginPreRestore(string, string, KeyVaultBeginPreRestoreOptions)

Inicia una operación de restauración previa que se puede usar para comprobar si el cliente puede realizar una operación de beginRestore mediante el token de SAS proporcionado.

Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación.

Uso de ejemplo:

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

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

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

// The poller can be serialized with:
const serialized = poller.toString();

// A new poller can be created with:
await client.beginPreRestore(blobStorageUri, sasToken, { resumeFrom: serialized });

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

function beginPreRestore(folderUri: string, sasToken: string, options?: KeyVaultBeginPreRestoreOptions): 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
KeyVaultBeginPreRestoreOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Inicia la restauración de 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 ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Uso de ejemplo:

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

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

const blobStorageUri = "<blob-storage-uri>"; // <Blob storage URL>/<folder name>
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
await poller.pollUntilDone();

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 ejecución prolongada que permite esperar indefinidamente hasta que se complete la operación de restauración de Key Vault.

Uso de ejemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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)

Inicia la restauración de todas las versiones clave de una clave determinada mediante a una carpeta de copia de seguridad de Azure Blob Storage almacenada previamente. Se accederá 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 ejecución prolongada que permite esperar indefinidamente hasta que se complete la restauración selectiva de Key Vault.

Uso de ejemplo:

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

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

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

// Serializing the poller
const serialized = poller.toString();

// A new poller can be created with:
await client.beginSelectiveKeyRestore(keyName, blobStorageUri, { 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 desea 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)

Inicia la restauración de 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 previamente.

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

Uso de ejemplo:

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

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, 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 desea 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>>