Sdílet prostřednictvím

KeyVaultBackupClient class

  • Reference
Balíček:
@azure/keyvault-admin

KeyVaultBackupClient poskytuje metody pro generování záloh a obnovení záloh libovolné instance Azure Key Vault. Tento klient podporuje generování úplných záloh, selektivní obnovení konkrétních klíčů a úplné obnovení Key Vault instancí.

Konstruktory

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Vytvoří instanci KeyVaultBackupClient.

Příklad použití:

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

Vlastnosti

vaultUrl

Základní adresa URL trezoru

Metody

beginBackup(string, KeyVaultBeginBackupOptions)

Začne generovat zálohu azure Key Vault v zadaném účtu objektu blob služby Storage pomocí spravované identity přiřazené uživatelem pro přístup k účtu úložiště.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, než se vygeneruje záloha Key Vault.

Příklad použití:

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

Spustí operaci úplného zálohování.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Začne generovat zálohu azure Key Vault v zadaném účtu objektu blob služby Storage.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, než se vygeneruje záloha Key Vault.

Příklad použití:

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

Spustí operaci úplného zálohování.
beginRestore(string, KeyVaultBeginRestoreOptions)

Začne obnovovat všechny klíčové materiály pomocí tokenu SAS odkazujícího na dříve uloženou složku záloh služby Azure Blob Storage s použitím spravované identity přiřazené uživatelem pro přístup k účtu úložiště.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud Key Vault operace obnovení nebude dokončena.

Příklad použití:

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

Spustí operaci úplného obnovení.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Začne obnovovat všechny klíčové materiály pomocí tokenu SAS odkazujícího na dříve uloženou záložní složku úložiště objektů blob v Azure.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud Key Vault operace obnovení nebude dokončena.

Příklad použití:

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

Spustí operaci úplného obnovení.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Spustí obnovení všech verzí klíčů daného klíče pomocí do dříve uložené složky záloh úložiště objektů blob v Azure. K záložní složce úložiště objektů blob se bude přistupovat pomocí spravované identity přiřazené uživatelem.

Tato funkce vrátí dlouho běžící operaci poller, která umožňuje čekat neomezeně dlouho, dokud Key Vault selektivní obnovení nebude dokončeno.

Příklad použití:

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

Vytvoří nové přiřazení role.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Spustí obnovení všech verzí klíče daného klíče pomocí uživatelem zadaného tokenu SAS odkazujícího na dříve uloženou záložní složku úložiště objektů blob v Azure.

Tato funkce vrátí dlouho běžící operaci poller, která umožňuje čekat neomezeně dlouho, dokud Key Vault selektivní obnovení nebude dokončeno.

Příklad použití:

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

Vytvoří nové přiřazení role.

Podrobnosti konstruktoru

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Vytvoří instanci KeyVaultBackupClient.

Příklad použití:

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)

Parametry

vaultUrl

string

adresa URL Key Vault. Měl by mít tento tvar: https://${your-key-vault-name}.vault.azure.net. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek Key Vault nebo spravovaný hsm. Podrobnosti viz https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objekt, který implementuje TokenCredential rozhraní používané k ověřování požadavků na službu. @azure/identity Pomocí balíčku vytvořte přihlašovací údaje, které vyhovují vašim potřebám.

options
KeyVaultBackupClientOptions

možnosti používané ke konfiguraci požadavků rozhraní API Key Vault.

Podrobnosti vlastnosti

vaultUrl

Základní adresa URL trezoru

vaultUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

beginBackup(string, KeyVaultBeginBackupOptions)

Začne generovat zálohu azure Key Vault v zadaném účtu objektu blob služby Storage pomocí spravované identity přiřazené uživatelem pro přístup k účtu úložiště.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, než se vygeneruje záloha Key Vault.

Příklad použití:

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

Spustí operaci úplného zálohování.

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

Parametry

blobStorageUri

string

Adresa URL prostředku úložiště objektů blob, včetně cesty ke kontejneru, ve kterém bude záloha uložena.

options
KeyVaultBeginBackupOptions

Volitelné parametry.

Návraty

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Začne generovat zálohu azure Key Vault v zadaném účtu objektu blob služby Storage.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, než se vygeneruje záloha Key Vault.

Příklad použití:

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

Spustí operaci úplného zálohování.

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

Parametry

blobStorageUri

string

Adresa URL prostředku úložiště objektů blob, včetně cesty ke kontejneru, ve kterém bude záloha uložena.

sasToken

string

Token SAS použitý pro přístup k prostředku úložiště objektů blob.

options
KeyVaultBeginBackupOptions

Volitelné parametry.

Návraty

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Začne obnovovat všechny klíčové materiály pomocí tokenu SAS odkazujícího na dříve uloženou složku záloh služby Azure Blob Storage s použitím spravované identity přiřazené uživatelem pro přístup k účtu úložiště.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud Key Vault operace obnovení nebude dokončena.

Příklad použití:

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

Spustí operaci úplného obnovení.

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

Parametry

folderUri

string

Adresa URL prostředku úložiště objektů blob, ve kterém bylo uloženo předchozí úspěšné úplné zálohování.

options
KeyVaultBeginRestoreOptions

Volitelné parametry.

Návraty

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Začne obnovovat všechny klíčové materiály pomocí tokenu SAS odkazujícího na dříve uloženou záložní složku úložiště objektů blob v Azure.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud Key Vault operace obnovení nebude dokončena.

Příklad použití:

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

Spustí operaci úplného obnovení.

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

Parametry

folderUri

string

Adresa URL prostředku úložiště objektů blob, ve kterém bylo uloženo předchozí úspěšné úplné zálohování.

sasToken

string

Token SAS. Pokud není k dispozici žádný token SAS, pro přístup k prostředku úložiště objektů blob se použije spravovaná identita přiřazená uživatelem.

options
KeyVaultBeginRestoreOptions

Volitelné parametry.

Návraty

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Spustí obnovení všech verzí klíčů daného klíče pomocí do dříve uložené složky záloh úložiště objektů blob v Azure. K záložní složce úložiště objektů blob se bude přistupovat pomocí spravované identity přiřazené uživatelem.

Tato funkce vrátí dlouho běžící operaci poller, která umožňuje čekat neomezeně dlouho, dokud Key Vault selektivní obnovení nebude dokončeno.

Příklad použití:

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

Vytvoří nové přiřazení role.

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

Parametry

keyName

string

Název klíče, který chcete obnovit.

folderUri

string

Adresa URL prostředku úložiště objektů blob s názvem složky objektu blob, ve které byla uložena předchozí úspěšná úplná záloha.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Volitelné parametry.

Návraty

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Spustí obnovení všech verzí klíče daného klíče pomocí uživatelem zadaného tokenu SAS odkazujícího na dříve uloženou záložní složku úložiště objektů blob v Azure.

Tato funkce vrátí dlouho běžící operaci poller, která umožňuje čekat neomezeně dlouho, dokud Key Vault selektivní obnovení nebude dokončeno.

Příklad použití:

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

Vytvoří nové přiřazení role.

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

Parametry

keyName

string

Název klíče, který chcete obnovit.

folderUri

string

Adresa URL prostředku úložiště objektů blob s názvem složky objektu blob, ve které byla uložena předchozí úspěšná úplná záloha.

sasToken

string

Token SAS. Pokud není k dispozici žádný token SAS, pro přístup k prostředku úložiště objektů blob se použije spravovaná identita přiřazená uživatelem.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Volitelné parametry.

Návraty

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>