Поделиться через

KeyVaultBackupClient class

  • Ссылка
Пакет:
@azure/keyvault-admin

KeyVaultBackupClient предоставляет методы для создания резервных копий и восстановления резервных копий любого экземпляра azure Key Vault. Этот клиент поддерживает создание полных резервных копий, выборочное восстановление определенных ключей и полное восстановление Key Vault экземпляров.

Конструкторы

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)

Начинает создавать резервную копию Key Vault Azure в указанной учетной записи BLOB-объектов хранилища, используя управляемое удостоверение, назначаемое пользователем, для доступа к учетной записи хранения.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать, пока не будет создана резервная копия Key Vault.

Пример использования:

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)

Начинает создание резервной копии Key Vault Azure в указанной учетной записи BLOB-объектов хранилища.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать, пока не будет создана резервная копия Key Vault.

Пример использования:

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, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure, используя управляемое удостоверение, назначаемое пользователем, для доступа к учетной записи хранения.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения операции восстановления Key Vault.

Пример использования:

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, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения операции восстановления Key Vault.

Пример использования:

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)

Начинает восстановление всех версий ключей заданного ключа с помощью в ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure. Доступ к папке резервного копирования хранилища BLOB-объектов будет осуществляться с помощью управляемого удостоверения, назначаемого пользователем.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения выборочного восстановления Key Vault.

Пример использования:

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, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения выборочного восстановления Key Vault.

Пример использования:

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-адрес Key Vault. Он должен иметь такую форму: https://${your-key-vault-name}.vault.azure.net. Убедитесь, что этот URL-адрес ссылается на допустимый Key Vault или управляемый ресурс HSM. Дополнительные сведения см. в разделе https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Объект , реализующий интерфейс, используемый TokenCredential для проверки подлинности запросов к службе. @azure/identity Используйте пакет для создания учетных данных, которые соответствуют вашим потребностям.

options
KeyVaultBackupClientOptions

параметры, используемые для настройки запросов API Key Vault.

Сведения о свойстве

vaultUrl

Базовый URL-адрес хранилища

vaultUrl: string

Значение свойства

string

Сведения о методе

beginBackup(string, KeyVaultBeginBackupOptions)

Начинает создавать резервную копию Key Vault Azure в указанной учетной записи BLOB-объектов хранилища, используя управляемое удостоверение, назначаемое пользователем, для доступа к учетной записи хранения.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать, пока не будет создана резервная копия Key Vault.

Пример использования:

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

URL-адрес ресурса хранилища BLOB-объектов, включая путь к контейнеру, в котором будет храниться резервная копия.

options
KeyVaultBeginBackupOptions

Необязательные параметры.

Возвращаемое значение

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginBackup(string, string, KeyVaultBeginBackupOptions)

Начинает создание резервной копии Key Vault Azure в указанной учетной записи BLOB-объектов хранилища.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать, пока не будет создана резервная копия Key Vault.

Пример использования:

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

URL-адрес ресурса хранилища BLOB-объектов, включая путь к контейнеру, в котором будет храниться резервная копия.

sasToken

string

Маркер SAS, используемый для доступа к ресурсу хранилища BLOB-объектов.

options
KeyVaultBeginBackupOptions

Необязательные параметры.

Возвращаемое значение

Promise<PollerLike<KeyVaultBackupOperationState, KeyVaultBackupResult>>

beginRestore(string, KeyVaultBeginRestoreOptions)

Начинает восстановление всех ключевых материалов с помощью маркера SAS, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure, используя управляемое удостоверение, назначаемое пользователем, для доступа к учетной записи хранения.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения операции восстановления Key Vault.

Пример использования:

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

URL-адрес ресурса хранилища BLOB-объектов, в котором была сохранена предыдущая успешная полная резервная копия.

options
KeyVaultBeginRestoreOptions

Необязательные параметры.

Возвращаемое значение

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginRestore(string, string, KeyVaultBeginRestoreOptions)

Начинает восстановление всех ключевых материалов с помощью маркера SAS, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения операции восстановления Key Vault.

Пример использования:

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

URL-адрес ресурса хранилища BLOB-объектов, в котором была сохранена предыдущая успешная полная резервная копия.

sasToken

string

Маркер SAS. Если маркер SAS не указан, для доступа к ресурсу хранилища BLOB-объектов будет использоваться управляемое удостоверение, назначаемое пользователем.

options
KeyVaultBeginRestoreOptions

Необязательные параметры.

Возвращаемое значение

Promise<PollerLike<KeyVaultRestoreOperationState, KeyVaultRestoreResult>>

beginSelectiveKeyRestore(string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Начинает восстановление всех версий ключей заданного ключа с помощью в ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure. Доступ к папке резервного копирования хранилища BLOB-объектов будет осуществляться с помощью управляемого удостоверения, назначаемого пользователем.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения выборочного восстановления Key Vault.

Пример использования:

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

URL-адрес ресурса хранилища BLOB-объектов с именем папки большого двоичного объекта, где была сохранена предыдущая успешная полная резервная копия.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Необязательные параметры.

Возвращаемое значение

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>

beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

Начинает восстановление всех версий ключей заданного ключа с помощью предоставленного пользователем маркера SAS, указывающего на ранее сохраненную папку резервного копирования хранилища BLOB-объектов Azure.

Эта функция возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения выборочного восстановления Key Vault.

Пример использования:

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

URL-адрес ресурса хранилища BLOB-объектов с именем папки большого двоичного объекта, где была сохранена предыдущая успешная полная резервная копия.

sasToken

string

Маркер SAS. Если маркер SAS не указан, для доступа к ресурсу хранилища BLOB-объектов будет использоваться управляемое удостоверение, назначаемое пользователем.

options
KeyVaultBeginSelectiveKeyRestoreOptions

Необязательные параметры.

Возвращаемое значение

Promise<PollerLike<KeyVaultSelectiveKeyRestoreOperationState, KeyVaultSelectiveKeyRestoreResult>>