KeyClient class

Создает экземпляр KeyClient.

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

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)

Параметры

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

vaultUrl: string

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

Запрашивает скачивание резервной копии указанного ключа клиенту. Будут загружены все версии ключа. Для этой операции требуется разрешение на ключи или резервное копирование.

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

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

Резервное копирование указанного ключа.

function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>

Параметры

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

Операция удаления применяется к любому ключу, хранящейся в Azure Key Vault. Отдельные версии ключа нельзя удалить, только все версии заданного ключа одновременно.

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

Для этой операции требуется разрешение на ключи или удаление.

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

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);

Удаляет ключ из указанного хранилища ключей.

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Параметры

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

Восстанавливает удаленный ключ в указанном хранилище. Эта операция может выполняться только в хранилище с поддержкой обратимого удаления.

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

Для этой операции требуется разрешение на ключи или восстановление.

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

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);

Восстанавливает удаленный ключ до последней версии.

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Параметры

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

Метод createEcKey создает новый ключ с многоточием кривой в Azure Key Vault. Если именованный ключ уже существует, Azure Key Vault создает новую версию ключа. Для этого требуется разрешение на ключи или создание.

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

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

Создает новый ключ, сохраняет его, а затем возвращает ключевые параметры и свойства клиенту.

function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>

Параметры

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

Операцию создания ключа можно использовать для создания любого типа ключа в Azure Key Vault. Если именованный ключ уже существует, Azure Key Vault создает новую версию ключа. Для этого требуется разрешение на ключи или создание.

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

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

Создает новый ключ, сохраняет его, а затем возвращает ключевые параметры и свойства клиенту.

function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>

Параметры

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

Метод createOctKey создает новый ключ OCT в Azure Key Vault. Если именованный ключ уже существует, Azure Key Vault создает новую версию ключа. Для этого требуется разрешение на ключи или создание.

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

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

Создает новый ключ, сохраняет его, а затем возвращает ключевые параметры и свойства клиенту.

function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>

Параметры

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

Метод createRSAKey создает новый ключ RSA в Azure Key Vault. Если именованный ключ уже существует, Azure Key Vault создает новую версию ключа. Для этого требуется разрешение на ключи или создание.

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

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

Создает новый ключ, сохраняет его, а затем возвращает ключевые параметры и свойства клиенту.

function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>

Параметры

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

Возвращает шифрования для заданного ключа.

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

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");

function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient

Параметры

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

• CryptographyClient с теми же параметрами, учетными данными и http-клиентом, что и этот KeyClient

Метод getDeletedKey возвращает указанный удаленный ключ вместе со своими свойствами. Для этой операции требуются ключи и разрешения на получение.

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

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

Возвращает указанный удаленный ключ.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>

Параметры

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

Метод getKey получает указанный ключ и применяется к любому ключу, хранящейся в Azure Key Vault. Для этой операции требуются ключи и разрешения на получение.

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

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

Получите указанный ключ из заданного хранилища ключей.

function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>

Параметры

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

Возвращает политику поворота ключа Key Vault. По умолчанию все ключи имеют политику, которая будет уведомлять 30 дней до истечения срока действия.

Для этой операции требуются ключи и разрешения на получение. Пример использования:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");

function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Параметры

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

Возвращает запрошенное число байтов, содержащих случайные значения из управляемого HSM. Для этой операции требуется разрешение managedHsm/rng.

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

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);

function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>

Параметры

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

Операция импорта ключа может использоваться для импорта любого типа ключа в Azure Key Vault. Если именованный ключ уже существует, Azure Key Vault создает новую версию ключа. Для этой операции требуются разрешения на ключи и импорт.

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

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

Импортирует внешний ключ, сохраняет его и возвращает ключевые параметры и свойства клиенту.

function importKey(name: string, key: JsonWebKey, options?: ImportKeyOptions): Promise<KeyVaultKey>

Параметры

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

Выполняет итерацию удаленных ключей в хранилище. Полный идентификатор ключа и свойства предоставляются в ответе. Значения для ключей не возвращаются. Для этих операций требуется разрешение на ключи или список.

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

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

Вывод списка всех ключей в хранилище

function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

Параметры

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

Выполняет итерацию последней версии всех ключей в хранилище. Полный идентификатор ключа и свойства предоставляются в ответе. Значения для ключей не возвращаются. Для этих операций требуется разрешение на ключи или список.

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

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

Вывод списка всех ключей в хранилище

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Параметры

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

Выполняет итерацию всех версий заданного ключа в хранилище. Полный идентификатор ключа, свойства и теги предоставляются в ответе. Для этой операции требуется разрешение на ключи или список.

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

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}

function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Параметры

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

Операция очистки удаленного ключа окончательно удаляет ключ без возможности восстановления. Эта операция может быть включена только в хранилище с поддержкой обратимого удаления. Для этой операции требуется разрешение на ключи или очистку.

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

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

Окончательно удаляет указанный ключ.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>

Параметры

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

Освобождает ключ из управляемого HSM.

Операция ключа выпуска применима ко всем типам ключей. Для операции требуется, чтобы ключ был помечен как экспортируемый, так и разрешения на ключи или выпуск.

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

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)

function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>

Параметры

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

Восстанавливает резервную копию ключа и все его версии в хранилище. Для этой операции требуется разрешение на ключи или восстановление.

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

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

Восстанавливает резервную копию ключа в хранилище.

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>

Параметры

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

Сменяет ключ на основе политики ключей, создав новую версию ключа. Для этой операции требуется разрешение клавиш или смены.

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

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");

function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>

Параметры

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

Метод updateKeyProperties изменяет указанные свойства существующего сохраненного ключа. Свойства, которые не указаны в запросе, остаются неизменными. Невозможно изменить значение самого ключа. Для этой операции требуется разрешение на ключи или набор.

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

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

Обновляет свойства, связанные с указанным ключом в заданном хранилище ключей.

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Параметры

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

Метод updateKeyProperties изменяет указанные свойства последней версии существующего сохраненного ключа. Свойства, которые не указаны в запросе, остаются неизменными. Невозможно изменить значение самого ключа. Для этой операции требуется разрешение на ключи или набор.

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

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

Обновляет свойства, связанные с указанным ключом в заданном хранилище ключей.

function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Параметры

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

Обновляет политику смены ключа Key Vault. Для этой операции требуется разрешение на ключи или обновление.

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

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Параметры

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