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

KeyClient class

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

KeyClient предоставляет методы для управления KeyVaultKey в Key Vault Azure. Клиент поддерживает создание, получение, обновление, удаление, очистку, резервное копирование, восстановление и перечисление Ключей KeyVaultKeys. Клиент также поддерживает перечисление DeletedKey для azure Key Vault с поддержкой обратимого удаления.

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

KeyClient(string, TokenCredential, KeyClientOptions)

Создает экземпляр 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);

Свойства

vaultUrl

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

Методы

backupKey(string, BackupKeyOptions)

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

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

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

Резервное копирование указанного ключа.
beginDeleteKey(string, BeginDeleteKeyOptions)

Операция удаления применяется к любому ключу, хранящейся в 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);

Удаляет ключ из указанного хранилища ключей.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

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

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

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

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

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

Восстанавливает удаленный ключ до последней версии.
createEcKey(string, CreateEcKeyOptions)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Возвращает указанный удаленный ключ.
getKey(string, GetKeyOptions)

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

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

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

Получение указанного ключа из заданного хранилища ключей.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

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

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

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

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

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

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

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

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

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

Импортирует созданный извне ключ, сохраняет его, а также возвращает параметры и свойства ключа клиенту.
listDeletedKeys(ListDeletedKeysOptions)

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

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

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

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

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

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

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

Вывод списка всех ключей в хранилище
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

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

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);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

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

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

Безвозвратно удаляет указанный ключ.
releaseKey(string, string, ReleaseKeyOptions)

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

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

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

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

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

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

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

Восстанавливает резервную копию ключа в хранилище.
rotateKey(string, RotateKeyOptions)

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

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

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

Метод 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 });

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

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

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

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

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

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

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

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

Сведения о конструкторе

KeyClient(string, TokenCredential, KeyClientOptions)

Создает экземпляр 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)

Параметры

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

pipelineOptions
KeyClientOptions

Параметры конвейера, используемые для настройки Key Vault запросов API. Пропустите этот параметр, чтобы использовать конфигурацию конвейера по умолчанию.

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

vaultUrl

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

vaultUrl: string

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

string

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

backupKey(string, BackupKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя ключа.

options
BackupKeyOptions

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

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

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

Операция удаления применяется к любому ключу, хранящейся в 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>>

Параметры

name

string

Имя ключа.

options
BeginDeleteKeyOptions

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

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

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя удаленного ключа.

options
BeginRecoverDeletedKeyOptions

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

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

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

createEcKey(string, CreateEcKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя ключа.

options
CreateEcKeyOptions

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

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

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

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

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

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>

Параметры

name

string

Имя ключа.

keyType

string

Тип ключа. Один из следующих элементов: "EC", "EC-HSM", "RSA", "RSA-HSM", "oct".

options
CreateKeyOptions

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

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

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя ключа.

options
CreateOctKeyOptions

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

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

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя ключа.

options
CreateRsaKeyOptions

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

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

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

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

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

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

Параметры

keyName

string

options
GetCryptographyClientOptions

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

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

getDeletedKey(string, GetDeletedKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя ключа.

options
GetDeletedKeyOptions

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

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

Promise<DeletedKey>

getKey(string, GetKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя ключа.

options
GetKeyOptions

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

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

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

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

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

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

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

Параметры

keyName

string

Имя ключа.

options
GetKeyRotationPolicyOptions

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

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

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

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

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

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

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

Параметры

count

number

Число байтов для создания в диапазоне от 1 до 128 включительно.

options
GetRandomBytesOptions

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

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

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя импортированного ключа.

key
JsonWebKey

Веб-ключ JSON.

options
ImportKeyOptions

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

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

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

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

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

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>

Параметры

options
ListDeletedKeysOptions

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

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

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

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

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

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>

Параметры

options
ListPropertiesOfKeysOptions

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

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

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

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

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>

Параметры

name

string

Имя ключа для получения версий

options
ListPropertiesOfKeyVersionsOptions

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

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

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

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

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>

Параметры

name

string

Имя ключа.

options
PurgeDeletedKeyOptions

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

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

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

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

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

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

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

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

Параметры

name

string

Имя ключа.

targetAttestationToken

string

Утверждение аттестации для целевого объекта выпуска ключа.

options
ReleaseKeyOptions

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

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

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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

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

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>

Параметры

backup

Uint8Array

Резервный BLOB-объект, связанный с пакетом ключей.

options
RestoreKeyBackupOptions

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

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

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

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

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

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

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

Параметры

name

string

Имя ключа для поворота.

options
RotateKeyOptions

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

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

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

Метод 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>

Параметры

name

string

Имя ключа.

keyVersion

string

Версия ключа.

options
UpdateKeyPropertiesOptions

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

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

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

Метод 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>

Параметры

name

string

Имя ключа.

options
UpdateKeyPropertiesOptions

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

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

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Обновления политики смены ключа 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>

Параметры

keyName

string

Имя ключа.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

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

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

Promise<KeyRotationPolicy>