Partager via

KeyVaultBackupClient class

  • Référence
Paquet:
@azure/keyvault-admin

KeyVaultBackupClient fournit des méthodes pour générer des sauvegardes et restaurer des sauvegardes d’une instance Azure Key Vault donnée. Ce client prend en charge la génération de sauvegardes complètes, de restaurations sélectives de clés spécifiques et de restaurations complètes d’instances Key Vault.

Constructeurs

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Crée une instance du KeyVaultBackupClient.

Exemple d’utilisation :

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

Propriétés

vaultUrl

URL de base du coffre

Méthodes

beginBackup(string, KeyVaultBeginBackupOptions)

Commence à générer une sauvegarde d’un coffre de clés Azure sur le compte d’objets blob de stockage spécifié, à l’aide d’une identité managée affectée par l’utilisateur pour accéder au compte de stockage.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que la sauvegarde key Vault soit générée.

Exemple d’utilisation :

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

Démarre une opération de sauvegarde complète.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Commence à générer une sauvegarde d’un coffre de clés Azure sur le compte d’objets blob de stockage spécifié.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que la sauvegarde key Vault soit générée.

Exemple d’utilisation :

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

Démarre une opération de sauvegarde complète.
beginRestore(string, KeyVaultBeginRestoreOptions)

Commence à restaurer tous les matériaux clés à l’aide du jeton SAP pointant vers un dossier de sauvegarde de stockage Blob Azure précédemment stocké, à l’aide d’une identité managée affectée par l’utilisateur pour accéder au compte de stockage.

Cette fonction retourne un polleur d’opérations longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que l’opération de restauration key Vault soit terminée.

Exemple d’utilisation :

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

Démarre une opération de restauration complète.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Commence à restaurer tous les matériaux clés à l’aide du jeton SAP pointant vers un dossier de sauvegarde stockage Blob Azure précédemment stocké.

Cette fonction retourne un polleur d’opérations longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que l’opération de restauration key Vault soit terminée.

Exemple d’utilisation :

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

Démarre une opération de restauration complète.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Commence à restaurer toutes les versions de clé d’une clé donnée à l’aide d’un dossier de sauvegarde stockage Blob Azure précédemment stocké. Le dossier de sauvegarde du stockage Blob est accessible à l’aide de l’identité managée affectée par l’utilisateur.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à la fin de la restauration sélective key Vault.

Exemple d’utilisation :

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

Crée une attribution de rôle.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Commence à restaurer toutes les versions de clé d’une clé donnée à l’aide d’un jeton SAP fourni par l’utilisateur pointant vers un dossier de sauvegarde stockage Blob Azure précédemment stocké.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à la fin de la restauration sélective key Vault.

Exemple d’utilisation :

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

Crée une attribution de rôle.

Détails du constructeur

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Crée une instance du KeyVaultBackupClient.

Exemple d’utilisation :

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)

Paramètres

vaultUrl

string

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

credential
TokenCredential

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

options
KeyVaultBackupClientOptions

options utilisées pour configurer les demandes d’API Key Vault.

Détails de la propriété

vaultUrl

URL de base du coffre

vaultUrl: string

Valeur de propriété

string

Détails de la méthode

beginBackup(string, KeyVaultBeginBackupOptions)

Commence à générer une sauvegarde d’un coffre de clés Azure sur le compte d’objets blob de stockage spécifié, à l’aide d’une identité managée affectée par l’utilisateur pour accéder au compte de stockage.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que la sauvegarde key Vault soit générée.

Exemple d’utilisation :

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

Démarre une opération de sauvegarde complète.

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

Paramètres

blobStorageUri

string

URL de la ressource de stockage d’objets blob, y compris le chemin d’accès au conteneur où la sauvegarde sera stockée.

options
KeyVaultBeginBackupOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Commence à générer une sauvegarde d’un coffre de clés Azure sur le compte d’objets blob de stockage spécifié.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que la sauvegarde key Vault soit générée.

Exemple d’utilisation :

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

Démarre une opération de sauvegarde complète.

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

Paramètres

blobStorageUri

string

URL de la ressource de stockage d’objets blob, y compris le chemin d’accès au conteneur où la sauvegarde sera stockée.

sasToken

string

Jeton SAP utilisé pour accéder à la ressource de stockage d’objets blob.

options
KeyVaultBeginBackupOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Commence à restaurer tous les matériaux clés à l’aide du jeton SAP pointant vers un dossier de sauvegarde de stockage Blob Azure précédemment stocké, à l’aide d’une identité managée affectée par l’utilisateur pour accéder au compte de stockage.

Cette fonction retourne un polleur d’opérations longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que l’opération de restauration key Vault soit terminée.

Exemple d’utilisation :

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

Démarre une opération de restauration complète.

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

Paramètres

folderUri

string

URL de la ressource de stockage d’objets blob où la sauvegarde complète précédente a été stockée.

options
KeyVaultBeginRestoreOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Commence à restaurer tous les matériaux clés à l’aide du jeton SAP pointant vers un dossier de sauvegarde stockage Blob Azure précédemment stocké.

Cette fonction retourne un polleur d’opérations longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que l’opération de restauration key Vault soit terminée.

Exemple d’utilisation :

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

Démarre une opération de restauration complète.

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

Paramètres

folderUri

string

URL de la ressource de stockage d’objets blob où la sauvegarde complète précédente a été stockée.

sasToken

string

Jeton SAP. Si aucun jeton SAP n’est fourni, l’identité managée affectée par l’utilisateur est utilisée pour accéder à la ressource de stockage d’objets blob.

options
KeyVaultBeginRestoreOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Commence à restaurer toutes les versions de clé d’une clé donnée à l’aide d’un dossier de sauvegarde stockage Blob Azure précédemment stocké. Le dossier de sauvegarde du stockage Blob est accessible à l’aide de l’identité managée affectée par l’utilisateur.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à la fin de la restauration sélective key Vault.

Exemple d’utilisation :

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

Crée une attribution de rôle.

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

Paramètres

keyName

string

Nom de la clé à restaurer.

folderUri

string

URL de la ressource de stockage d’objets blob, avec le nom du dossier de l’objet blob où la sauvegarde complète précédente a été stockée.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Commence à restaurer toutes les versions de clé d’une clé donnée à l’aide d’un jeton SAP fourni par l’utilisateur pointant vers un dossier de sauvegarde stockage Blob Azure précédemment stocké.

Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à la fin de la restauration sélective key Vault.

Exemple d’utilisation :

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

Crée une attribution de rôle.

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

Paramètres

keyName

string

Nom de la clé à restaurer.

folderUri

string

URL de la ressource de stockage d’objets blob, avec le nom du dossier de l’objet blob où la sauvegarde complète précédente a été stockée.

sasToken

string

Jeton SAP. Si aucun jeton SAP n’est fourni, l’identité managée affectée par l’utilisateur est utilisée pour accéder à la ressource de stockage d’objets blob.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Paramètres facultatifs.

Retours

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>