Megosztás a következőn keresztül:

KeyVaultBackupClient class

  • Referencia
Csomag:
@azure/keyvault-admin

A KeyVaultBackupClient metódusokat biztosít az adott Azure-Key Vault-példányok biztonsági mentéseinek létrehozásához és visszaállításához. Ez az ügyfél támogatja a teljes biztonsági mentések létrehozását, az egyes kulcsok szelektív visszaállítását és Key Vault példányok teljes visszaállítását.

Konstruktorok

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Létrehozza a KeyVaultBackupClient egy példányát.

Példahasználat:

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

Tulajdonságok

vaultUrl

A tároló alap URL-címe

Metódusok

beginBackup(string, KeyVaultBeginBackupOptions)

Megkezdi egy Azure-Key Vault biztonsági másolatának létrehozását a megadott Storage-blobfiókon egy felhasználó által hozzárendelt felügyelt identitás használatával a Storage-fiók eléréséhez.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg létre nem jön a Key Vault biztonsági másolat.

Példahasználat:

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

Elindít egy teljes biztonsági mentési műveletet.
beginBackup(string, string, KeyVaultBeginBackupOptions)

Megkezdi egy Azure-Key Vault biztonsági mentésének létrehozását a megadott Storage Blob-fiókon.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg létre nem jön a Key Vault biztonsági másolat.

Példahasználat:

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

Elindít egy teljes biztonsági mentési műveletet.
beginRestore(string, KeyVaultBeginRestoreOptions)

Megkezdi az összes kulcsanyag visszaállítását a korábban tárolt Azure Blob Storage biztonsági mentési mappájára mutató SAS-jogkivonat használatával, egy felhasználó által hozzárendelt felügyelt identitással a tárfiók eléréséhez.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault visszaállítási művelet befejeződik.

Példahasználat:

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

Elindít egy teljes visszaállítási műveletet.
beginRestore(string, string, KeyVaultBeginRestoreOptions)

Megkezdi az összes kulcsanyag visszaállítását a korábban tárolt Azure Blob Storage biztonsági mentési mappájára mutató SAS-jogkivonat használatával.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault visszaállítási művelet befejeződik.

Példahasználat:

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

Elindít egy teljes visszaállítási műveletet.
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Megkezdi egy adott kulcs összes kulcsverziójának visszaállítását a használatával egy korábban tárolt Azure Blob Storage biztonsági mentési mappába. A Blob Storage biztonsági mentési mappája a felhasználó által hozzárendelt felügyelt identitással lesz elérhető.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault szelektív visszaállítás befejeződik.

Példahasználat:

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

Új szerepkör-hozzárendelést hoz létre.
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Megkezdi egy adott kulcs összes kulcsverziójának visszaállítását a felhasználó által megadott SAS-jogkivonat használatával, amely egy korábban tárolt Azure Blob Storage biztonsági mentési mappára mutat.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault szelektív visszaállítás befejeződik.

Példahasználat:

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

Új szerepkör-hozzárendelést hoz létre.

Konstruktor adatai

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

Létrehozza a KeyVaultBackupClient egy példányát.

Példahasználat:

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

vaultUrl

string

a Key Vault URL-címe. Ennek az alakzatnak a következőnek kell lennie: https://${your-key-vault-name}.vault.azure.net. Ellenőrizze, hogy ez az URL-cím érvényes Key Vault vagy felügyelt HSM-erőforrásra hivatkozik-e. További részletek: https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Egy objektum, amely a TokenCredential szolgáltatásnak küldött kérések hitelesítéséhez használt felületet valósítja meg. @azure/identity A csomag használatával hozzon létre egy, az igényeinek megfelelő hitelesítő adatokat.

options
KeyVaultBackupClientOptions

Key Vault API-kérések konfigurálásához használt beállítások.

Tulajdonság adatai

vaultUrl

A tároló alap URL-címe

vaultUrl: string

Tulajdonság értéke

string

Metódus adatai

beginBackup(string, KeyVaultBeginBackupOptions)

Megkezdi egy Azure-Key Vault biztonsági másolatának létrehozását a megadott Storage-blobfiókon egy felhasználó által hozzárendelt felügyelt identitás használatával a Storage-fiók eléréséhez.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg létre nem jön a Key Vault biztonsági másolat.

Példahasználat:

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

Elindít egy teljes biztonsági mentési műveletet.

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

Paraméterek

blobStorageUri

string

A Blob Storage-erőforrás URL-címe, beleértve annak a tárolónak az elérési útját, ahol a biztonsági mentést végül tárolni fogják.

options
KeyVaultBeginBackupOptions

A választható paraméterek.

Válaszok

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Megkezdi egy Azure-Key Vault biztonsági mentésének létrehozását a megadott Storage Blob-fiókon.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg létre nem jön a Key Vault biztonsági másolat.

Példahasználat:

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

Elindít egy teljes biztonsági mentési műveletet.

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

Paraméterek

blobStorageUri

string

A Blob Storage-erőforrás URL-címe, beleértve annak a tárolónak az elérési útját, ahol a biztonsági mentést végül tárolni fogják.

sasToken

string

A Blob Storage-erőforrás eléréséhez használt SAS-jogkivonat.

options
KeyVaultBeginBackupOptions

A választható paraméterek.

Válaszok

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Megkezdi az összes kulcsanyag visszaállítását a korábban tárolt Azure Blob Storage biztonsági mentési mappájára mutató SAS-jogkivonat használatával, egy felhasználó által hozzárendelt felügyelt identitással a tárfiók eléréséhez.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault visszaállítási művelet befejeződik.

Példahasználat:

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

Elindít egy teljes visszaállítási műveletet.

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

Paraméterek

folderUri

string

Annak a Blob Storage-erőforrásnak az URL-címe, ahol az előző sikeres teljes biztonsági mentést tárolták.

options
KeyVaultBeginRestoreOptions

A választható paraméterek.

Válaszok

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Megkezdi az összes kulcsanyag visszaállítását a korábban tárolt Azure Blob Storage biztonsági mentési mappájára mutató SAS-jogkivonat használatával.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault visszaállítási művelet befejeződik.

Példahasználat:

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

Elindít egy teljes visszaállítási műveletet.

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

Paraméterek

folderUri

string

Annak a Blob Storage-erőforrásnak az URL-címe, ahol az előző sikeres teljes biztonsági mentést tárolták.

sasToken

string

Az SAS-jogkivonat. Ha nem ad meg SAS-jogkivonatot, a rendszer a felhasználó által hozzárendelt felügyelt identitást használja a blobtároló-erőforrás eléréséhez.

options
KeyVaultBeginRestoreOptions

A választható paraméterek.

Válaszok

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Megkezdi egy adott kulcs összes kulcsverziójának visszaállítását a használatával egy korábban tárolt Azure Blob Storage biztonsági mentési mappába. A Blob Storage biztonsági mentési mappája a felhasználó által hozzárendelt felügyelt identitással lesz elérhető.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault szelektív visszaállítás befejeződik.

Példahasználat:

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

Új szerepkör-hozzárendelést hoz létre.

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

Paraméterek

keyName

string

A visszaállítani kívánt kulcs neve.

folderUri

string

A blobtároló-erőforrás URL-címe annak a blobnak a nevével, ahol a korábbi sikeres teljes biztonsági mentést tárolták.

options
KeyVaultBeginSelectiveKeyRestoreOptions

A választható paraméterek.

Válaszok

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Megkezdi egy adott kulcs összes kulcsverziójának visszaállítását a felhasználó által megadott SAS-jogkivonat használatával, amely egy korábban tárolt Azure Blob Storage biztonsági mentési mappára mutat.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a Key Vault szelektív visszaállítás befejeződik.

Példahasználat:

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

Új szerepkör-hozzárendelést hoz létre.

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

Paraméterek

keyName

string

A visszaállítani kívánt kulcs neve.

folderUri

string

A blobtároló-erőforrás URL-címe annak a blobnak a nevével, ahol a korábbi sikeres teljes biztonsági mentést tárolták.

sasToken

string

Az SAS-jogkivonat. Ha nem ad meg SAS-jogkivonatot, a rendszer a felhasználó által hozzárendelt felügyelt identitást használja a blobtároló-erőforrás eléréséhez.

options
KeyVaultBeginSelectiveKeyRestoreOptions

A választható paraméterek.

Válaszok

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>