共用方式為

KeyVaultBackupClient class

  • 參考
套件:
@azure/keyvault-admin

KeyVaultBackupClient 提供方法來產生任何指定 Azure 金鑰保存庫 實例的備份和還原備份。 此用戶端支援產生完整備份、選擇性還原特定密鑰，以及 金鑰保存庫 實例的完整還原。

建構函式

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

建立 KeyVaultBackupClient 的實例。

使用方式範例：

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

屬性

vaultUrl

保存庫的基底 URL

方法

beginBackup(string, KeyVaultBeginBackupOptions)

開始在指定的記憶體 Blob 帳戶上產生 Azure 金鑰保存庫 的備份，並使用使用者指派的受控識別來存取記憶體帳戶。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到產生 金鑰保存庫 備份為止。

使用方式範例：

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

啟動完整備份作業。
beginBackup(string, string, KeyVaultBeginBackupOptions)

開始在指定的記憶體 Blob 帳戶上產生 Azure 金鑰保存庫 的備份。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到產生 金鑰保存庫 備份為止。

使用方式範例：

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

啟動完整備份作業。
beginRestore(string, KeyVaultBeginRestoreOptions)

使用指向先前儲存的 Azure Blob 記憶體備份資料夾的 SAS 令牌，使用使用者指派的受控識別來存取記憶體帳戶，開始還原所有密鑰數據。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候 金鑰保存庫 還原作業完成。

使用方式範例：

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

啟動完整還原作業。
beginRestore(string, string, KeyVaultBeginRestoreOptions)

使用指向先前儲存的 Azure Blob 記憶體備份資料夾的 SAS 令牌，開始還原所有密鑰數據。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候 金鑰保存庫 還原作業完成。

使用方式範例：

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

啟動完整還原作業。
beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

開始將指定金鑰的所有金鑰版本，使用 還原至先前儲存的 Azure Blob 記憶體備份資料夾。 Blob 記憶體備份資料夾將會使用使用者指派的受控識別來存取。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到 金鑰保存庫 選擇性還原完成為止。

使用方式範例：

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

建立新的角色指派。
beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

使用使用者提供的 SAS 令牌，開始還原指定金鑰的所有金鑰版本，指向先前儲存的 Azure Blob 記憶體備份資料夾。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到 金鑰保存庫 選擇性還原完成為止。

使用方式範例：

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

建立新的角色指派。

建構函式詳細資料

KeyVaultBackupClient(string, TokenCredential, KeyVaultBackupClientOptions)

建立 KeyVaultBackupClient 的實例。

使用方式範例：

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)

參數

vaultUrl

string

金鑰保存庫的 URL。 它應該具有此圖形： https://${your-key-vault-name}.vault.azure.net。 您應該驗證此 URL 參考有效的 金鑰保存庫 或受控 HSM 資源。 如需詳細資訊，請參閱＜https://aka.ms/azsdk/blog/vault-uri＞。

credential
TokenCredential

實作 介面的物件， TokenCredential 用來驗證對服務的要求。 @azure/identity使用套件來建立符合您需求的認證。

options
KeyVaultBackupClientOptions

用來設定 金鑰保存庫 API 要求的選項。

屬性詳細資料

vaultUrl

保存庫的基底 URL

vaultUrl: string

屬性值

string

方法詳細資料

beginBackup(string, KeyVaultBeginBackupOptions)

開始在指定的記憶體 Blob 帳戶上產生 Azure 金鑰保存庫 的備份，並使用使用者指派的受控識別來存取記憶體帳戶。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到產生 金鑰保存庫 備份為止。

使用方式範例：

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

啟動完整備份作業。

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

參數

blobStorageUri

string

Blob 記憶體資源的 URL，包括備份最後會儲存所在的容器路徑。

options
KeyVaultBeginBackupOptions

選擇性參數。

傳回

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

開始在指定的記憶體 Blob 帳戶上產生 Azure 金鑰保存庫 的備份。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到產生 金鑰保存庫 備份為止。

使用方式範例：

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

啟動完整備份作業。

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

參數

blobStorageUri

string

Blob 記憶體資源的 URL，包括備份最後會儲存所在的容器路徑。

sasToken

string

用來存取 Blob 記憶體資源的 SAS 令牌。

options
KeyVaultBeginBackupOptions

選擇性參數。

傳回

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

使用指向先前儲存的 Azure Blob 記憶體備份資料夾的 SAS 令牌，使用使用者指派的受控識別來存取記憶體帳戶，開始還原所有密鑰數據。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候 金鑰保存庫 還原作業完成。

使用方式範例：

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

啟動完整還原作業。

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

參數

folderUri

string

儲存先前成功完整備份之 Blob 記憶體資源的 URL。

options
KeyVaultBeginRestoreOptions

選擇性參數。

傳回

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

使用指向先前儲存的 Azure Blob 記憶體備份資料夾的 SAS 令牌，開始還原所有密鑰數據。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候 金鑰保存庫 還原作業完成。

使用方式範例：

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

啟動完整還原作業。

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

參數

folderUri

string

儲存先前成功完整備份之 Blob 記憶體資源的 URL。

sasToken

string

SAS 令牌。 如果未提供 SAS 令牌，則會使用使用者指派的受控識別來存取 Blob 記憶體資源。

options
KeyVaultBeginRestoreOptions

選擇性參數。

傳回

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

開始將指定金鑰的所有金鑰版本，使用 還原至先前儲存的 Azure Blob 記憶體備份資料夾。 Blob 記憶體備份資料夾將會使用使用者指派的受控識別來存取。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到 金鑰保存庫 選擇性還原完成為止。

使用方式範例：

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

建立新的角色指派。

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

參數

keyName

string

要還原的金鑰名稱。

folderUri

string

Blob 記憶體資源的 URL，其中包含儲存先前成功完整備份之 Blob 的資料夾名稱。

options
KeyVaultBeginSelectiveKeyRestoreOptions

選擇性參數。

傳回

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

使用使用者提供的 SAS 令牌，開始還原指定金鑰的所有金鑰版本，指向先前儲存的 Azure Blob 記憶體備份資料夾。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到 金鑰保存庫 選擇性還原完成為止。

使用方式範例：

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

建立新的角色指派。

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

參數

keyName

string

要還原的金鑰名稱。

folderUri

string

Blob 記憶體資源的 URL，其中包含儲存先前成功完整備份之 Blob 的資料夾名稱。

sasToken

string

SAS 令牌。 如果未提供 SAS 令牌，則會使用使用者指派的受控識別來存取 Blob 記憶體資源。

options
KeyVaultBeginSelectiveKeyRestoreOptions

選擇性參數。

傳回

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>