Delen via

KeyVaultBackupClient class

  • Referentie
Pakket:
@azure/keyvault-admin

KeyVaultBackupClient biedt methoden voor het genereren van back-ups en het herstellen van back-ups van een bepaald Azure Key Vault-exemplaar. Deze client ondersteunt het genereren van volledige back-ups, selectieve herstelbewerkingen van specifieke sleutels en volledige herstelbewerkingen van Key Vault-exemplaren.

Constructors

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Hiermee maakt u een exemplaar van de KeyVaultBackupClient.

Voorbeeldgebruik:

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

Eigenschappen

vaultUrl

De basis-URL naar de kluis

Methoden

beginBackup(string, KeyVaultBeginBackupOptions)

Begint met het genereren van een back-up van een Azure Key Vault op het opgegeven Storage Blob-account met behulp van een door de gebruiker toegewezen beheerde identiteit voor toegang tot het Opslagaccount.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de Key Vault-back-up wordt gegenereerd.

Voorbeeldgebruik:

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

Hiermee start u een volledige back-upbewerking.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Begint met het genereren van een back-up van een Azure Key Vault op het opgegeven Storage Blob-account.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de Key Vault-back-up wordt gegenereerd.

Voorbeeldgebruik:

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

Hiermee start u een volledige back-upbewerking.
beginRestore(string, KeyVaultBeginRestoreOptions)

Begint met het herstellen van alle sleutelmaterialen met behulp van het SAS-token dat verwijst naar een eerder opgeslagen back-upmap van Azure Blob Storage, met behulp van een door de gebruiker toegewezen beheerde identiteit voor toegang tot het opslagaccount.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de herstelbewerking van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee start u een volledige herstelbewerking.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Begint met het herstellen van alle sleutelmaterialen met behulp van het SAS-token dat verwijst naar een eerder opgeslagen back-upmap van Azure Blob Storage.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de herstelbewerking van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee start u een volledige herstelbewerking.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Begint met het herstellen van alle sleutelversies van een bepaalde sleutel met behulp van een eerder opgeslagen back-upmap van Azure Blob Storage. De back-upmap van Blob Storage wordt geopend met behulp van door de gebruiker toegewezen beheerde identiteit.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat selectief herstel van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee maakt u een nieuwe roltoewijzing.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Begint met het herstellen van alle sleutelversies van een bepaalde sleutel met behulp van het door de gebruiker opgegeven SAS-token dat verwijst naar een eerder opgeslagen back-upmap van Azure Blob Storage.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat selectief herstel van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee maakt u een nieuwe roltoewijzing.

Constructordetails

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Hiermee maakt u een exemplaar van de KeyVaultBackupClient.

Voorbeeldgebruik:

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)

Parameters

vaultUrl

string

de URL van de Sleutelkluis. Deze moet deze vorm hebben: https://${your-key-vault-name}.vault.azure.net. Controleer of deze URL verwijst naar een geldige Key Vault- of beheerde HSM-resource. Zie https://aka.ms/azsdk/blog/vault-uri voor meer informatie.

credential
TokenCredential

Een object dat de TokenCredential-interface implementeert die wordt gebruikt voor het verifiëren van aanvragen voor de service. Gebruik het @azure/identity-pakket om een referentie te maken die aan uw behoeften voldoet.

options
KeyVaultBackupClientOptions

opties die worden gebruikt voor het configureren van Key Vault API-aanvragen.

Eigenschapdetails

vaultUrl

De basis-URL naar de kluis

vaultUrl: string

Waarde van eigenschap

string

Methodedetails

beginBackup(string, KeyVaultBeginBackupOptions)

Begint met het genereren van een back-up van een Azure Key Vault op het opgegeven Storage Blob-account met behulp van een door de gebruiker toegewezen beheerde identiteit voor toegang tot het Opslagaccount.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de Key Vault-back-up wordt gegenereerd.

Voorbeeldgebruik:

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

Hiermee start u een volledige back-upbewerking.

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

Parameters

blobStorageUri

string

De URL van de blobopslagresource, inclusief het pad naar de container waar de back-up uiteindelijk wordt opgeslagen.

options
KeyVaultBeginBackupOptions

De optionele parameters.

Retouren

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Begint met het genereren van een back-up van een Azure Key Vault op het opgegeven Storage Blob-account.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de Key Vault-back-up wordt gegenereerd.

Voorbeeldgebruik:

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

Hiermee start u een volledige back-upbewerking.

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

Parameters

blobStorageUri

string

De URL van de blobopslagresource, inclusief het pad naar de container waar de back-up uiteindelijk wordt opgeslagen.

sasToken

string

Het SAS-token dat wordt gebruikt voor toegang tot de blobopslagresource.

options
KeyVaultBeginBackupOptions

De optionele parameters.

Retouren

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Begint met het herstellen van alle sleutelmaterialen met behulp van het SAS-token dat verwijst naar een eerder opgeslagen back-upmap van Azure Blob Storage, met behulp van een door de gebruiker toegewezen beheerde identiteit voor toegang tot het opslagaccount.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de herstelbewerking van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee start u een volledige herstelbewerking.

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

Parameters

folderUri

string

De URL van de blobopslagresource waarin de vorige geslaagde volledige back-up is opgeslagen.

options
KeyVaultBeginRestoreOptions

De optionele parameters.

Retouren

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Begint met het herstellen van alle sleutelmaterialen met behulp van het SAS-token dat verwijst naar een eerder opgeslagen back-upmap van Azure Blob Storage.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de herstelbewerking van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee start u een volledige herstelbewerking.

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

Parameters

folderUri

string

De URL van de blobopslagresource waarin de vorige geslaagde volledige back-up is opgeslagen.

sasToken

string

Het SAS-token. Als er geen SAS-token is opgegeven, wordt door de gebruiker toegewezen beheerde identiteit gebruikt voor toegang tot de blobopslagresource.

options
KeyVaultBeginRestoreOptions

De optionele parameters.

Retouren

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Begint met het herstellen van alle sleutelversies van een bepaalde sleutel met behulp van een eerder opgeslagen back-upmap van Azure Blob Storage. De back-upmap van Blob Storage wordt geopend met behulp van door de gebruiker toegewezen beheerde identiteit.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat selectief herstel van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee maakt u een nieuwe roltoewijzing.

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

Parameters

keyName

string

De naam van de sleutel die moet worden hersteld.

folderUri

string

De URL van de blobopslagresource, met de mapnaam van de blob waar de vorige geslaagde volledige back-up is opgeslagen.

options
KeyVaultBeginSelectiveKeyRestoreOptions

De optionele parameters.

Retouren

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Begint met het herstellen van alle sleutelversies van een bepaalde sleutel met behulp van het door de gebruiker opgegeven SAS-token dat verwijst naar een eerder opgeslagen back-upmap van Azure Blob Storage.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat selectief herstel van Key Vault is voltooid.

Voorbeeldgebruik:

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

Hiermee maakt u een nieuwe roltoewijzing.

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

Parameters

keyName

string

De naam van de sleutel die moet worden hersteld.

folderUri

string

De URL van de blobopslagresource, met de mapnaam van de blob waar de vorige geslaagde volledige back-up is opgeslagen.

sasToken

string

Het SAS-token. Als er geen SAS-token is opgegeven, wordt door de gebruiker toegewezen beheerde identiteit gebruikt voor toegang tot de blobopslagresource.

options
KeyVaultBeginSelectiveKeyRestoreOptions

De optionele parameters.

Retouren

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>