KeyVaultBackupClient class
KeyVaultBackupClient bietet Methoden zum Generieren von Sicherungen und Wiederherstellen von Sicherungen eines bestimmten Azure-Key Vault instance. Dieser Client unterstützt das Generieren vollständiger Sicherungen, selektiver Wiederherstellungen bestimmter Schlüssel und vollständige Wiederherstellungen von Key Vault Instanzen.
Konstruktoren
| Key |
Erstellt eine instance des KeyVaultBackupClient. Beispielverwendung: |
Eigenschaften
| vault |
Die Basis-URL für den Tresor |
Methoden
| begin |
Beginnt mit dem Generieren einer Sicherung eines Azure Key Vault für das angegebene Speicherblobkonto unter Verwendung einer benutzerseitig zugewiesenen verwalteten Identität für den Zugriff auf das Speicherkonto. Diese Funktion gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault Sicherung generiert wird. Beispielverwendung: Startet einen vollständigen Sicherungsvorgang. |
| begin |
Beginnt mit dem Generieren einer Sicherung eines Azure-Key Vault für das angegebene Speicherblobkonto. Diese Funktion gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault Sicherung generiert wird. Beispielverwendung: Startet einen vollständigen Sicherungsvorgang. |
| begin |
Beginnt mit der Wiederherstellung aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist, wobei eine benutzerseitig zugewiesene verwaltete Identität für den Zugriff auf das Speicherkonto verwendet wird. Diese Funktion gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie unbegrenzt warten können, bis der Key Vault Wiederherstellungsvorgang abgeschlossen ist. Beispielverwendung: Startet einen vollständigen Wiederherstellungsvorgang. |
| begin |
Beginnt mit der Wiederherstellung aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist. Diese Funktion gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie unbegrenzt warten können, bis der Key Vault Wiederherstellungsvorgang abgeschlossen ist. Beispielverwendung: Startet einen vollständigen Wiederherstellungsvorgang. |
| begin |
Beginnt mit der Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels in einem zuvor gespeicherten Azure Blob Storage-Sicherungsordner. Auf den Blob storage-Sicherungsordner wird mithilfe der benutzerseitig zugewiesenen verwalteten Identität zugegriffen. Diese Funktion gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault selektiven Wiederherstellung abgeschlossen ist. Beispielverwendung: Erstellt eine neue Rollenzuweisung. |
| begin |
Beginnt mit der Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels mithilfe des vom Benutzer bereitgestellten SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner zeigt. Diese Funktion gibt einen Abrufvorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault selektive Wiederherstellung abgeschlossen ist. Beispielverwendung: Erstellt eine neue Rollenzuweisung. |
Details zum Konstruktor
KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)
Erstellt eine instance des KeyVaultBackupClient.
Beispielverwendung:
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)Parameter
- vaultUrl
-
string
die URL des Key Vault. Sie sollte die folgende Form aufweisen: 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. Einzelheiten dazu finden Sie unter https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
Ein -Objekt, das die Schnittstelle implementiert, die TokenCredential zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity Paket, um Anmeldeinformationen zu erstellen, die Ihren Anforderungen entsprechen.
- options
- KeyVaultBackupClientOptions
Optionen, die zum Konfigurieren Key Vault API-Anforderungen verwendet werden.
Details zur Eigenschaft
vaultUrl
Die Basis-URL für den Tresor
vaultUrl: stringEigenschaftswert
string
Details zur Methode
beginBackup(string, KeyVaultBeginBackupOptions)
Beginnt mit dem Generieren einer Sicherung eines Azure Key Vault für das angegebene Speicherblobkonto unter Verwendung einer benutzerseitig zugewiesenen verwalteten Identität für den Zugriff auf das Speicherkonto.
Diese Funktion gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault Sicherung generiert wird.
Beispielverwendung:
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);
Startet einen vollständigen Sicherungsvorgang.
function beginBackup(blobStorageUri: string, options?: KeyVaultBeginBackupOptions): Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>Parameter
- blobStorageUri
-
string
Die URL der Blobspeicherressource, einschließlich des Pfads zu dem Container, in dem die Sicherung letztendlich gespeichert wird.
- options
- KeyVaultBeginBackupOptions
Die optionalen Parameter.
Gibt zurück
beginBackup(string, string, KeyVaultBeginBackupOptions)
Beginnt mit dem Generieren einer Sicherung eines Azure-Key Vault für das angegebene Speicherblobkonto.
Diese Funktion gibt einen Abfragevorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault Sicherung generiert wird.
Beispielverwendung:
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);
Startet einen vollständigen Sicherungsvorgang.
function beginBackup(blobStorageUri: string, sasToken: string, options?: KeyVaultBeginBackupOptions): Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>Parameter
- blobStorageUri
-
string
Die URL der Blobspeicherressource, einschließlich des Pfads zu dem Container, in dem die Sicherung letztendlich gespeichert wird.
- sasToken
-
string
Das SAS-Token, das für den Zugriff auf die Blobspeicherressource verwendet wird.
- options
- KeyVaultBeginBackupOptions
Die optionalen Parameter.
Gibt zurück
beginRestore(string, KeyVaultBeginRestoreOptions)
Beginnt mit der Wiederherstellung aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist, wobei eine benutzerseitig zugewiesene verwaltete Identität für den Zugriff auf das Speicherkonto verwendet wird.
Diese Funktion gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie unbegrenzt warten können, bis der Key Vault Wiederherstellungsvorgang abgeschlossen ist.
Beispielverwendung:
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);
Startet einen vollständigen Wiederherstellungsvorgang.
function beginRestore(folderUri: string, options?: KeyVaultBeginRestoreOptions): Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>Parameter
- folderUri
-
string
Die URL der Blobspeicherressource, in der die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.
- options
- KeyVaultBeginRestoreOptions
Die optionalen Parameter.
Gibt zurück
beginRestore(string, string, KeyVaultBeginRestoreOptions)
Beginnt mit der Wiederherstellung aller wichtigen Materialien mithilfe des SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner verweist.
Diese Funktion gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie unbegrenzt warten können, bis der Key Vault Wiederherstellungsvorgang abgeschlossen ist.
Beispielverwendung:
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);
Startet einen vollständigen Wiederherstellungsvorgang.
function beginRestore(folderUri: string, sasToken: string, options?: KeyVaultBeginRestoreOptions): Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>Parameter
- folderUri
-
string
Die URL der Blobspeicherressource, in der die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.
- sasToken
-
string
Das SAS-Token. Wenn kein SAS-Token bereitgestellt wird, wird die vom Benutzer zugewiesene verwaltete Identität für den Zugriff auf die Blob storage-Ressource verwendet.
- options
- KeyVaultBeginRestoreOptions
Die optionalen Parameter.
Gibt zurück
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)
Beginnt mit der Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels in einem zuvor gespeicherten Azure Blob Storage-Sicherungsordner. Auf den Blob storage-Sicherungsordner wird mithilfe der benutzerseitig zugewiesenen verwalteten Identität zugegriffen.
Diese Funktion gibt einen Abfragevorgang mit langer Ausführung zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault selektiven Wiederherstellung abgeschlossen ist.
Beispielverwendung:
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();
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 storage-Ressource mit dem Ordnernamen des Blobs, in dem die vorherige erfolgreiche vollständige Sicherung gespeichert wurde.
Die optionalen Parameter.
Gibt zurück
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)
Beginnt mit der Wiederherstellung aller Schlüsselversionen eines bestimmten Schlüssels mithilfe des vom Benutzer bereitgestellten SAS-Tokens, das auf einen zuvor gespeicherten Azure Blob Storage-Sicherungsordner zeigt.
Diese Funktion gibt einen Abrufvorgang mit langer Ausführungsdauer zurück, mit dem Sie unbegrenzt warten können, bis die Key Vault selektive Wiederherstellung abgeschlossen ist.
Beispielverwendung:
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();
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 storage-Ressource 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 die vom Benutzer zugewiesene verwaltete Identität für den Zugriff auf die Blob storage-Ressource verwendet.
Die optionalen Parameter.