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

@azure/keyvault-keys package

Классы

CryptographyClient

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

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

Интерфейсы

AesCbcDecryptParameters

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

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

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

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

Параметры <xref:backupKey>.
BeginDeleteKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:beginDeleteKey>
BeginRecoverDeletedKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:beginRecoverDeletedKey>
CreateEcKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:createEcKey>
CreateKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:createKey>
CreateOctKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:createOctKey>
CreateRsaKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:createRsaKey>
CryptographyClientOptions

Необязательные параметры, принятые криптографией KeyVault.
CryptographyOptions

Интерфейс, представляющий параметры методов API шифрования, перейдите к <xref:CryptographyClient> для получения дополнительных сведений.
DecryptOptions

Параметры <xref:decrypt>.
DecryptResult

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

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

Параметры <xref:encrypt>.
EncryptResult

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

Параметры <xref:getDeletedKey>.
GetKeyOptions

Параметры <xref:getKey>.
ImportKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:importKey>
JsonWebKey

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

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

Интерфейс, представляющий необязательные параметры, которые можно передать в <xref:beginDeleteKey> и <xref:beginRecoverDeletedKey>
KeyProperties

Интерфейс, представляющий свойства <xref:KeyVaultKey>
KeyVaultKey

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

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

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

Интерфейс, представляющий необязательные параметры для операций с страницами KeyClient, передаваемых в <xref:listPropertiesOfKeyVersions>.
ListPropertiesOfKeysOptions

Интерфейс, представляющий необязательные параметры для операций с страницами KeyClient, передаваемых в <xref:listPropertiesOfKeys>.
PurgeDeletedKeyOptions

Параметры <xref:purgeDeletedKey>.
RestoreKeyBackupOptions

Параметры <xref:restoreKeyBackup>.
RsaDecryptParameters

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

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

Параметры <xref:sign>.
SignResult

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

Параметры <xref:unwrapKey>.
UnwrapResult

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

Параметры <xref:updateKeyProperties>.
VerifyDataOptions

Параметры <xref:verifyData>
VerifyOptions

Параметры <xref:verify>.
VerifyResult

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

Параметры <xref:wrapKey>.
WrapResult

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

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

AesCbcEncryptionAlgorithm

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

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

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

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

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

очистка: обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень не соответствует защите от операции delete; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.).
Восстановление и очистка: обозначает состояние хранилища, в котором можно восстановить, а также разрешает немедленное и постоянное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если операция очистки не запрашивается или подписка отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
можно восстановить: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней) и пока подписка по-прежнему доступна. Система будет окончательно удалять ее через 90 дней, если не восстановлена
recoveryable+ProtectedSubscription: обозначает хранилище и состояние подписки, в котором удаление можно восстановить в течение интервала хранения (90 дней), немедленное и постоянное удаление (т. е. очистка) не допускается, и при этом сама подписка не может быть окончательно отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
Настраиваемыйrecoverable+Purgeable: обозначает состояние хранилища, в котором можно восстановить удаление, а также разрешает немедленное и постоянное удаление (т. е. очистка при 7<= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, если не запрашивается операция очистки или подписка отменена.
Настраиваемый: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистка при 7<= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время периода хранения и пока подписка по-прежнему доступна.
Настраиваемая настройкаRecoverable+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 с многоточием, кривая AKA SECG SECP521R1.
P-256K: SECP256K1 эллиптической кривой SECG.
KeyOperation

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

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

шифрования
расшифровка
знак
проверить
wrapKey
unwrapKey
импорт
KeyType

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

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

EC: эллиптическая кривая.
EC-HSM: эллиптическая кривая с закрытым ключом, который не экспортируется из HSM.
ЮАР: ЮАР (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA с закрытым ключом, который не экспортируется из HSM.
окт: последовательность октетов (используется для представления симметричные ключи)
окт-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

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

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

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

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

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

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

Функции

parseKeyVaultKeyIdentifier(string)

Анализирует заданный идентификатор ключа Key Vault. Пример: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>

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

  {
     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://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>

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

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

Параметры

id

string

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

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

KeyVaultKeyIdentifier