@azure/keyvault-keys package

  • Ссылка

Классы

CryptographyClient

Клиент, используемый для выполнения криптографических операций с ключом Хранилища ключей Azure или локальным ключом JsonWebKey.
KeyClient

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

Интерфейсы

AesCbcDecryptParameters

Параметры расшифровки для алгоритмов шифрования AES-CBC.
AesCbcEncryptParameters

Параметры шифрования для алгоритмов шифрования AES-CBC.
AesGcmDecryptParameters

Параметры расшифровки для алгоритмов шифрования AES-GCM.
AesGcmEncryptParameters

Параметры шифрования для алгоритмов шифрования AES-GCM.
BackupKeyOptions

Параметры для backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions

Интерфейс, представляющий необязательные параметры, которые могут быть переданы в beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions

Интерфейс, представляющий необязательные параметры, которые могут быть переданы в beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions

Интерфейс, представляющий необязательные параметры, которые могут быть переданы в createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions

Интерфейс, представляющий необязательные параметры, которые могут быть переданы в createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions

Интерфейс, представляющий необязательные параметры, которые могут быть переданы в createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions

Интерфейс, представляющий необязательные параметры, которые могут быть переданы в createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions

Необязательные параметры, принимаемые CryptographyClient keyVault
CryptographyOptions

Интерфейс, представляющий параметры методов API шифрования. Дополнительные сведения см. в разделе CryptographyClient .
DecryptOptions

Параметры для decrypt(DecryptParameters, DecryptOptions).
DecryptResult

decrypt(DecryptParameters, DecryptOptions) Результат операции.
DeletedKey

Интерфейс, представляющий удаленный ключ Key Vault.
EncryptOptions

Параметры для encrypt(EncryptParameters, EncryptOptions).
EncryptResult

encrypt(EncryptParameters, EncryptOptions) Результат операции.
GetCryptographyClientOptions

Параметры для getCryptographyClient.
GetDeletedKeyOptions

Параметры для getDeletedKey(string, GetDeletedKeyOptions).
GetKeyOptions

Параметры для getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions

Варианты использования <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions

Параметры для getRandomBytes
ImportKeyOptions

Интерфейс, представляющий необязательные параметры, которые могут быть переданы в importKey(string, JsonWebKey_2, ImportKeyOptions)
JsonWebKey

По состоянию на http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions

Необязательные параметры, принимаемые KeyClient Хранилища ключей
KeyPollerOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteKey(string, BeginDeleteKeyOptions) и beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties

Интерфейс, представляющий свойства KeyVaultKey.
KeyReleasePolicy

Правила политики, в соответствии с которыми можно экспортировать ключ.
KeyRotationLifetimeAction

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

Полная политика смены ключей, принадлежающая ключу.
KeyRotationPolicyProperties

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

Вы также можете сбросить политику смены ключей до значений по умолчанию, задав для параметра lifetimeActions пустой массив.
KeyVaultKey

Интерфейс, представляющий ключ Key Vault с его именем, значением и свойствами KeyProperties.
KeyVaultKeyIdentifier

Представляет сегменты, составляющие идентификатор ключа Key Vault.
ListDeletedKeysOptions

Интерфейс, представляющий необязательные параметры для операций со страницами KeyClient, передаваемых в listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions

Интерфейс, представляющий необязательные параметры для операций со страницами KeyClient, передаваемых в listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions

Интерфейс, представляющий необязательные параметры для операций со страницами KeyClient, передаваемых в listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings

Интерфейс, отслеживающий параметры итерации с разбиением по страницам.
PagedAsyncIterableIterator

Интерфейс, который позволяет асинхронно итерировать итерацию как до завершения, так и по страницам.
PollOperationState

PollOperationState содержит список с наименьшим набором свойств, необходимых для определения любого длительно выполняющегося опрашителя операций.

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

Его следует обновлять по крайней мере при запуске операции, после ее завершения и при отмене операции. Однако реализации могут иметь любое другое количество свойств, которые могут быть обновлены по другим причинам.
PollerLike

Абстрактное представление средства опроса, предназначенного для предоставления только минимального API, с которым должен работать пользователь.
PurgeDeletedKeyOptions

Параметры для purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions

Параметры releaseKey
ReleaseKeyResult

Результат операции releaseKey .
RestoreKeyBackupOptions

Параметры для restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions

Параметры для rotateKey
RsaDecryptParameters

Параметры расшифровки для алгоритмов шифрования RSA.
RsaEncryptParameters

Параметры шифрования для алгоритмов шифрования RSA.
SignOptions

Параметры для sign(string, Uint8Array, SignOptions).
SignResult

sign(string, Uint8Array, SignOptions) Результат операции.
UnwrapKeyOptions

Параметры для unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult

<xref:unwrap> Результат операции.
UpdateKeyPropertiesOptions

Параметры для updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions

Параметры updateKeyRotationPolicy
VerifyDataOptions

Варианты использования verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions

Параметры для verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult

verify(string, Uint8Array, Uint8Array, VerifyOptions) Результат операции.
WrapKeyOptions

Параметры для wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult

<xref:wrap> Результат операции.

Псевдонимы типа

AesCbcEncryptionAlgorithm

Тип объединения, представляющий все поддерживаемые алгоритмы шифрования AES-CBC.
AesGcmEncryptionAlgorithm

Тип объединения, представляющий все поддерживаемые алгоритмы шифрования AES-GCM.
DecryptParameters

Тип, представляющий все поддерживаемые в настоящее время параметры расшифровки, которые применяются к разным алгоритмам шифрования.
DeletionRecoveryLevel

Определяет значения для Параметра DeletionRecoveryLevel.
KnownDeletionRecoveryLevel можно использовать взаимозаменяемо с Методом УдаленияRecoveryLevel. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Очищаемый. Обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень соответствует отсутствием защиты от операции удаления; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.);
Recoverable+Purgeable: обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение периода хранения (90 дней), если не запрошена операция очистки или подписка не отменена. Система окончательно удалите его через 90 дней, если она не восстановлена
Возможность восстановления. Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение периода хранения (90 дней) и пока подписка остается доступной. Система окончательно удалите его через 90 дней, если она не восстановлена
Recoverable+ProtectedSubscription. Обозначает состояние хранилища и подписки, в котором удаление можно восстановить в течение периода хранения (90 дней), немедленное и окончательное удаление (т. е. очистка) запрещено, а сама подписка не может быть окончательно отменена. Система окончательно удалите его через 90 дней, если она не восстановлена
CustomizedRecoverable+Purgeable: обозначает состояние хранилища, в котором удаление можно восстановить, а также позволяет немедленное и окончательное удаление (т. е. очистка, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, если не запрошена операция очистки или подписка не отменена.
CustomizedRecoverable. Обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и окончательного удаления (т. е. очистка, когда 7< = SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения и в то время, когда подписка по-прежнему доступна.
CustomizedRecoverable+ProtectedSubscription: обозначает состояние хранилища и подписки, в котором удаление можно восстановить, немедленное и окончательное удаление (т. е. очистка) запрещено, а сама подписка не может быть окончательно отменена, если 7< = SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.
EncryptParameters

Тип, представляющий все поддерживаемые в настоящее время параметры шифрования, которые применяются к разным алгоритмам шифрования.
EncryptionAlgorithm

Определяет значения для JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> может использоваться взаимозаменяемо с JsonWebKeyEncryptionAlgorithm. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

RSA-OAEP
RSA-OAEP-256
RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD
KeyCurveName

Определяет значения для JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> можно использовать взаимозаменяемо с JsonWebKeyCurveName. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

P-256: эллиптическая кривая NIST P-256, AKA SECG кривая SECP256R1.
P-384: эллиптическая кривая NIST P-384, AKA SECG кривая SECP384R1.
P-521: эллиптическая кривая NIST P-521, кривая SECG SECP521R1.
P-256K: эллиптическая кривая SECG SECP256K1.
KeyExportEncryptionAlgorithm

Определяет значения для KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm можно использовать взаимозаменяемо с KeyEncryptionAlgorithm. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384
KeyOperation

Определяет значения для JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> можно использовать взаимозаменяемо с JsonWebKeyOperation. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export
KeyRotationPolicyAction

Действие, которое будет выполнено.
KeyType

Определяет значения для JsonWebKeyType.
<xref:KnownJsonWebKeyType> может использоваться взаимозаменяемо с JsonWebKeyType. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

EC: эллиптическая кривая.
EC-HSM: эллиптическая кривая с закрытым ключом, который хранится в HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA с закрытым ключом, который хранится в HSM.
oct: последовательность октетов (используется для представления симметричного ключа)
oct-HSM: последовательность октетов (используется для представления симметричного ключа), которая хранится в HSM.
KeyWrapAlgorithm

Поддерживаемые алгоритмы для упаковки и распашивания ключей
RsaEncryptionAlgorithm

Тип объединения, представляющий все поддерживаемые алгоритмы шифрования RSA.
SignatureAlgorithm

Определяет значения для JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> может использоваться взаимозаменяемо с JsonWebKeySignatureAlgorithm. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

PS256: RSASSA-PSS с использованием SHA-256 и MGF1 с SHA-256, как описано в разделе https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS с использованием SHA-384 и MGF1 с SHA-384, как описано в разделе https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS с использованием SHA-512 и MGF1 с SHA-512, как описано в разделе https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 с использованием SHA-256, как описано в разделе https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 с использованием SHA-384, как описано в разделе https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 с использованием SHA-512, как описано в разделе https://tools.ietf.org/html/rfc7518
RSNULL: зарезервировано
ES256: ECDSA с использованием P-256 и SHA-256, как описано в разделе https://tools.ietf.org/html/rfc7518.
ES384: ECDSA с использованием P-384 и SHA-384, как описано в разделе https://tools.ietf.org/html/rfc7518
ES512: ECDSA с использованием P-521 и SHA-512, как описано в разделе https://tools.ietf.org/html/rfc7518
ES256K: ECDSA с использованием P-256K и SHA-256, как описано в разделе https://tools.ietf.org/html/rfc7518

Перечисления

KnownDeletionRecoveryLevel

Известные значения DeletionRecoveryLevel , которые принимает служба.
KnownEncryptionAlgorithms

Известные значения EncryptionAlgorithm , которые принимает служба.
KnownKeyCurveNames

Известные значения, <xref:JsonWebKeyCurveName> которые принимает служба.
KnownKeyExportEncryptionAlgorithm

Известные значения KeyExportEncryptionAlgorithm , которые принимает служба.
KnownKeyOperations

Известные значения KeyOperation , которые принимает служба.
KnownKeyTypes

Известные значения, <xref:JsonWebKeyType> которые принимает служба.
KnownSignatureAlgorithms

Известные значения, <xref:JsonWebKeySignatureAlgorithm> которые принимает служба.

Функции

parseKeyVaultKeyIdentifier(string)

Анализирует заданный идентификатор ключа Key Vault. Пример:

https://.vault.azure.net/keys//

При анализе приведенного выше идентификатора эта функция возвращает следующее:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<key-name>"
  }

Сведения о функции

parseKeyVaultKeyIdentifier(string)

Анализирует заданный идентификатор ключа Key Vault. Пример:

https://.vault.azure.net/keys//

При анализе приведенного выше идентификатора эта функция возвращает следующее:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<key-name>"
  }

function parseKeyVaultKeyIdentifier(id: string): KeyVaultKeyIdentifier

Параметры

id

string

Идентификатор ключа Key Vault.

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

KeyVaultKeyIdentifier