通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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)

使用 SAS 令牌开始还原所有密钥材料，该令牌指向以前存储的 Azure Blob 存储备份文件夹，使用用户分配的托管标识访问存储帐户。

此函数返回一个长时间运行的操作轮询器，使你可以无限期地等待密钥保管库还原操作完成。

用法示例：

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)

使用 SAS 令牌开始还原所有密钥材料，该令牌指向以前存储的 Azure Blob 存储备份文件夹。

此函数返回一个长时间运行的操作轮询器，使你可以无限期地等待密钥保管库还原操作完成。

用法示例：

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)

使用用户提供的指向以前存储的 Azure Blob 存储备份文件夹的 SAS 令牌开始还原给定密钥的所有密钥版本。

此函数返回一个长时间运行的操作轮询器，允许无限期地等待密钥保管库选择性还原完成。

用法示例：

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)

使用 SAS 令牌开始还原所有密钥材料，该令牌指向以前存储的 Azure Blob 存储备份文件夹，使用用户分配的托管标识访问存储帐户。

此函数返回一个长时间运行的操作轮询器，使你可以无限期地等待密钥保管库还原操作完成。

用法示例：

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)

使用 SAS 令牌开始还原所有密钥材料，该令牌指向以前存储的 Azure Blob 存储备份文件夹。

此函数返回一个长时间运行的操作轮询器，使你可以无限期地等待密钥保管库还原操作完成。

用法示例：

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)

使用用户提供的指向以前存储的 Azure Blob 存储备份文件夹的 SAS 令牌开始还原给定密钥的所有密钥版本。

此函数返回一个长时间运行的操作轮询器，允许无限期地等待密钥保管库选择性还原完成。

用法示例：

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