Freigeben über

KeyVaultBackupClient class

Paket:
@azure/keyvault-admin

Der KeyVaultBackupClient stellt Methoden bereit, um Sicherungen zu generieren und Sicherungen einer beliebigen Azure Key Vault-Instanz wiederherzustellen. Dieser Client unterstützt das Generieren vollständiger Sicherungen, selektive Wiederherstellungen bestimmter Schlüssel und vollständige Wiederherstellungen von Key Vault-Instanzen.

Konstruktoren

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Erstellt eine Instanz des KeyVaultBackupClient.

Beispielverwendung:

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

Eigenschaften

vaultUrl

Die Basis-URL zum Tresor

Methoden

beginBackup(string, KeyVaultBeginBackupOptions)

Startet das Generieren einer Sicherung eines Azure Key Vault auf dem angegebenen Speicher-Blob-Konto mithilfe einer vom Benutzer zugewiesenen verwalteten Identität für den Zugriff auf das Speicherkonto.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Key Vault-Sicherung generiert wird.

Beispielverwendung:

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

Startet einen vollständigen Sicherungsvorgang.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Startet das Generieren einer Sicherung eines Azure Key Vault auf dem angegebenen Speicher-Blob-Konto.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Key Vault-Sicherung generiert wird.

Beispielverwendung:

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

Startet einen vollständigen Sicherungsvorgang.
beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Startet einen Vorabsicherungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginBackup Vorgang ausführen kann, indem die konfigurierte vom Benutzer zugewiesene verwaltete Identität verwendet wird, um sich bei Azure Storage zu authentifizieren.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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)

Startet einen Vorabsicherungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginBackup- Vorgang mit dem bereitgestellten SAS-Token ausführen kann.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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)

Startet einen Vorwiederherstellungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginRestore- Vorgang mit dem bereitgestellten SAS-Token ausführen kann.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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)

Startet einen Vorwiederherstellungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginRestore- Vorgang mit dem bereitgestellten SAS-Token ausführen kann.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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)

Startet das Wiederherstellen aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner zeigt, mithilfe einer vom Benutzer zugewiesenen verwalteten Identität, um auf das Speicherkonto zuzugreifen.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Key Vault-Wiederherstellungsvorgang abgeschlossen ist.

Beispielverwendung:

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

Startet einen vollständigen Wiederherstellungsvorgang.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Startet die Wiederherstellung aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Key Vault-Wiederherstellungsvorgang abgeschlossen ist.

Beispielverwendung:

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

Startet einen vollständigen Wiederherstellungsvorgang.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Startet die Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels mithilfe eines zuvor gespeicherten Azure Blob Storage-Sicherungsordners. Auf den Blob-Speichersicherungsordner wird mithilfe der vom Benutzer zugewiesenen verwalteten Identität zugegriffen.

Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die selektive Wiederherstellung des Key Vault abgeschlossen ist.

Beispielverwendung:

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

Erstellt eine neue Rollenzuweisung.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Startet die Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels mithilfe des vom Benutzer bereitgestellten SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist.

Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die selektive Wiederherstellung des Key Vault abgeschlossen ist.

Beispielverwendung:

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

Erstellt eine neue Rollenzuweisung.

Details zum Konstruktor

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Erstellt eine Instanz des KeyVaultBackupClient.

Beispielverwendung:

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)

Parameter

vaultUrl

string

die URL des Key Vault. Es sollte diese Form haben: https://${your-key-vault-name}.vault.azure.net. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault- oder verwaltete HSM-Ressource verweist. Weitere Informationen finden Sie unter https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ein Objekt, das die TokenCredential Schnittstelle implementiert, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity-Paket, um eine Anmeldeinformation zu erstellen, die Ihren Anforderungen entspricht.

options
KeyVaultBackupClientOptions

Optionen zum Konfigurieren von Key Vault-API-Anforderungen.

Details zur Eigenschaft

vaultUrl

Die Basis-URL zum Tresor

vaultUrl: string

Eigenschaftswert

string

Details zur Methode

beginBackup(string, KeyVaultBeginBackupOptions)

Startet das Generieren einer Sicherung eines Azure Key Vault auf dem angegebenen Speicher-Blob-Konto mithilfe einer vom Benutzer zugewiesenen verwalteten Identität für den Zugriff auf das Speicherkonto.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Key Vault-Sicherung generiert wird.

Beispielverwendung:

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

Startet einen vollständigen Sicherungsvorgang.

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

Parameter

blobStorageUri

string

Die URL der BLOB-Speicherressource, einschließlich des Pfads zum Container, in dem die Sicherung gespeichert wird.

options
KeyVaultBeginBackupOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Startet das Generieren einer Sicherung eines Azure Key Vault auf dem angegebenen Speicher-Blob-Konto.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die Key Vault-Sicherung generiert wird.

Beispielverwendung:

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

Startet einen vollständigen Sicherungsvorgang.

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

Parameter

blobStorageUri

string

Die URL der BLOB-Speicherressource, einschließlich des Pfads zum Container, in dem die Sicherung gespeichert wird.

sasToken

string

Das SAS-Token, das für den Zugriff auf die Blob-Speicherressource verwendet wird.

options
KeyVaultBeginBackupOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, KeyVaultBeginPreBackupOptions)

Startet einen Vorabsicherungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginBackup Vorgang ausführen kann, indem die konfigurierte vom Benutzer zugewiesene verwaltete Identität verwendet wird, um sich bei Azure Storage zu authentifizieren.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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

Parameter

blobStorageUri

string

Die URL der BLOB-Speicherressource, einschließlich des Pfads zum Container, in dem die Sicherung gespeichert wird.

options
KeyVaultBeginPreBackupOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreBackup(string, string, KeyVaultBeginPreBackupOptions)

Startet einen Vorabsicherungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginBackup- Vorgang mit dem bereitgestellten SAS-Token ausführen kann.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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

Parameter

blobStorageUri

string

Die URL der BLOB-Speicherressource, einschließlich des Pfads zum Container, in dem die Sicherung gespeichert wird.

sasToken

string

Das SAS-Token, das für den Zugriff auf die Blob-Speicherressource verwendet wird.

options
KeyVaultBeginPreBackupOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginPreRestore(string, KeyVaultBeginPreRestoreOptions)

Startet einen Vorwiederherstellungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginRestore- Vorgang mit dem bereitgestellten SAS-Token ausführen kann.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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

Parameter

folderUri

string

Die URL der BLOB-Speicherressource, in der die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.

options
KeyVaultBeginPreRestoreOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginPreRestore(string, string, KeyVaultBeginPreRestoreOptions)

Startet einen Vorwiederherstellungsvorgang, der verwendet werden kann, um zu überprüfen, ob der Kunde einen beginRestore- Vorgang mit dem bereitgestellten SAS-Token ausführen kann.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Vorgang abgeschlossen ist.

Beispielverwendung:

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

Parameter

folderUri

string

Die URL der BLOB-Speicherressource, in der die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.

sasToken

string

Das SAS-Token. Wenn kein SAS-Token bereitgestellt wird, wird vom Benutzer zugewiesene verwaltete Identität verwendet, um auf die BLOB-Speicherressource zuzugreifen.

options
KeyVaultBeginPreRestoreOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Startet das Wiederherstellen aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner zeigt, mithilfe einer vom Benutzer zugewiesenen verwalteten Identität, um auf das Speicherkonto zuzugreifen.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Key Vault-Wiederherstellungsvorgang abgeschlossen ist.

Beispielverwendung:

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

Startet einen vollständigen Wiederherstellungsvorgang.

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

Parameter

folderUri

string

Die URL der BLOB-Speicherressource, in der die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.

options
KeyVaultBeginRestoreOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Startet die Wiederherstellung aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist.

Diese Funktion gibt einen Poller für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis der Key Vault-Wiederherstellungsvorgang abgeschlossen ist.

Beispielverwendung:

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

Startet einen vollständigen Wiederherstellungsvorgang.

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

Parameter

folderUri

string

Die URL der BLOB-Speicherressource, in der die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.

sasToken

string

Das SAS-Token. Wenn kein SAS-Token bereitgestellt wird, wird vom Benutzer zugewiesene verwaltete Identität verwendet, um auf die BLOB-Speicherressource zuzugreifen.

options
KeyVaultBeginRestoreOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Startet die Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels mithilfe eines zuvor gespeicherten Azure Blob Storage-Sicherungsordners. Auf den Blob-Speichersicherungsordner wird mithilfe der vom Benutzer zugewiesenen verwalteten Identität zugegriffen.

Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die selektive Wiederherstellung des Key Vault abgeschlossen ist.

Beispielverwendung:

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

Erstellt eine neue Rollenzuweisung.

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

Parameter

keyName

string

Der Name des Schlüssels, der wiederhergestellt werden soll.

folderUri

string

Die URL der BLOB-Speicherressource mit dem Ordnernamen des Blobs, in dem die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Startet die Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels mithilfe des vom Benutzer bereitgestellten SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist.

Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis die selektive Wiederherstellung des Key Vault abgeschlossen ist.

Beispielverwendung:

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

Erstellt eine neue Rollenzuweisung.

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

Parameter

keyName

string

Der Name des Schlüssels, der wiederhergestellt werden soll.

folderUri

string

Die URL der BLOB-Speicherressource mit dem Ordnernamen des Blobs, in dem die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.

sasToken

string

Das SAS-Token. Wenn kein SAS-Token bereitgestellt wird, wird vom Benutzer zugewiesene verwaltete Identität verwendet, um auf die BLOB-Speicherressource zuzugreifen.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Die optionalen Parameter.

Gibt zurück

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>