Condividi tramite

KeyVaultBackupClient class

  • Riferimento
Pacchetto:
@azure/keyvault-admin

KeyVaultBackupClient fornisce metodi per generare backup e ripristinare backup di una determinata istanza di Azure Key Vault. Questo client supporta la generazione di backup completi, ripristini selettivi di chiavi specifiche e ripristini completi di istanze di Key Vault.

Costruttori

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Crea un'istanza di KeyVaultBackupClient.

Esempio di utilizzo:

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

Proprietà

vaultUrl

URL di base dell'insieme di credenziali

Metodi

beginBackup(string, KeyVaultBeginBackupOptions)

Avvia la generazione di un backup di un Key Vault di Azure nell'account BLOB di archiviazione specificato, usando un'identità gestita assegnata dall'utente per accedere all'account di archiviazione.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando non viene generato il backup Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di backup completa.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Avvia la generazione di un backup di un Key Vault di Azure nell'account BLOB di archiviazione specificato.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando non viene generato il backup Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di backup completa.
beginRestore(string, KeyVaultBeginRestoreOptions)

Avvia il ripristino di tutti i materiali chiave usando il token di firma di accesso condiviso che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza, usando un'identità gestita assegnata dall'utente per accedere all'account di archiviazione.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento dell'operazione di ripristino Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di ripristino completa.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Avvia il ripristino di tutti i materiali chiave usando il token di firma di accesso condiviso che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento dell'operazione di ripristino Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di ripristino completa.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Avvia il ripristino di tutte le versioni chiave di una determinata chiave usando in una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza. È possibile accedere alla cartella di backup dell'archiviazione BLOB usando l'identità gestita assegnata dall'utente.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento del ripristino selettivo Key Vault.

Esempio di utilizzo:

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 nuova assegnazione di ruolo.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Avvia il ripristino di tutte le versioni chiave di una determinata chiave usando il token di firma di accesso condiviso fornito dall'utente che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento del ripristino selettivo Key Vault.

Esempio di utilizzo:

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 nuova assegnazione di ruolo.

Dettagli costruttore

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Crea un'istanza di KeyVaultBackupClient.

Esempio di utilizzo:

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)

Parametri

vaultUrl

string

URL del Key Vault. Deve avere questa forma: https://${your-key-vault-name}.vault.azure.net. È necessario verificare che questo URL faccia riferimento a una risorsa HSM Key Vault o gestita valida. Per informazioni dettagliate, vedere https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Oggetto che implementa l'interfaccia TokenCredential utilizzata per autenticare le richieste al servizio. Usare il @azure/identity pacchetto per creare credenziali adatte alle proprie esigenze.

options
KeyVaultBackupClientOptions

opzioni usate per configurare Key Vault richieste API.

Dettagli proprietà

vaultUrl

URL di base dell'insieme di credenziali

vaultUrl: string

Valore della proprietà

string

Dettagli metodo

beginBackup(string, KeyVaultBeginBackupOptions)

Avvia la generazione di un backup di un Key Vault di Azure nell'account BLOB di archiviazione specificato, usando un'identità gestita assegnata dall'utente per accedere all'account di archiviazione.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando non viene generato il backup Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di backup completa.

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

Parametri

blobStorageUri

string

URL della risorsa di archiviazione BLOB, incluso il percorso del contenitore in cui verrà archiviato il backup.

options
KeyVaultBeginBackupOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Avvia la generazione di un backup di un Key Vault di Azure nell'account BLOB di archiviazione specificato.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando non viene generato il backup Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di backup completa.

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

Parametri

blobStorageUri

string

URL della risorsa di archiviazione BLOB, incluso il percorso del contenitore in cui verrà archiviato il backup.

sasToken

string

Token di firma di accesso condiviso usato per accedere alla risorsa di archiviazione BLOB.

options
KeyVaultBeginBackupOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Avvia il ripristino di tutti i materiali chiave usando il token di firma di accesso condiviso che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza, usando un'identità gestita assegnata dall'utente per accedere all'account di archiviazione.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento dell'operazione di ripristino Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di ripristino completa.

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

Parametri

folderUri

string

URL della risorsa di archiviazione BLOB in cui è stato archiviato il backup completo precedente.

options
KeyVaultBeginRestoreOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Avvia il ripristino di tutti i materiali chiave usando il token di firma di accesso condiviso che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento dell'operazione di ripristino Key Vault.

Esempio di utilizzo:

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

Avvia un'operazione di ripristino completa.

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

Parametri

folderUri

string

URL della risorsa di archiviazione BLOB in cui è stato archiviato il backup completo precedente.

sasToken

string

Token di firma di accesso condiviso. Se non viene fornito alcun token di firma di accesso condiviso, verrà usata l'identità gestita assegnata dall'utente per accedere alla risorsa di archiviazione BLOB.

options
KeyVaultBeginRestoreOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Avvia il ripristino di tutte le versioni chiave di una determinata chiave usando in una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza. È possibile accedere alla cartella di backup dell'archiviazione BLOB usando l'identità gestita assegnata dall'utente.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento del ripristino selettivo Key Vault.

Esempio di utilizzo:

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 nuova assegnazione di ruolo.

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

Parametri

keyName

string

Nome della chiave da ripristinare.

folderUri

string

URL della risorsa di archiviazione BLOB, con il nome della cartella del BLOB in cui è stato archiviato il backup completo precedente.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Avvia il ripristino di tutte le versioni chiave di una determinata chiave usando il token di firma di accesso condiviso fornito dall'utente che punta a una cartella di backup dell'archiviazione BLOB di Azure archiviata in precedenza.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento del ripristino selettivo Key Vault.

Esempio di utilizzo:

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 nuova assegnazione di ruolo.

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

Parametri

keyName

string

Nome della chiave da ripristinare.

folderUri

string

URL della risorsa di archiviazione BLOB, con il nome della cartella del BLOB in cui è stato archiviato il backup completo precedente.

sasToken

string

Token di firma di accesso condiviso. Se non viene fornito alcun token di firma di accesso condiviso, verrà usata l'identità gestita assegnata dall'utente per accedere alla risorsa di archiviazione BLOB.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>