@azure/keyvault-keys package

  • Referencia

Clases

CryptographyClient

Un cliente que se usa para realizar operaciones criptográficas en una clave de Azure Key Vault o en un jsonWebKey local.
KeyClient

KeyClient proporciona métodos para administrar KeyVaultKey en azure Key Vault. El cliente admite la creación, recuperación, actualización, eliminación, purgado, copia de seguridad, restauración y enumeración de KeyVaultKeys. El cliente también admite enumerar DeletedKey para una eliminación temporal habilitada para Azure Key Vault.

Interfaces

AesCbcDecryptParameters

Parámetros de descifrado para algoritmos de cifrado AES-CBC.
AesCbcEncryptParameters

Parámetros de cifrado para algoritmos de cifrado AES-CBC.
AesGcmDecryptParameters

Parámetros de descifrado para algoritmos de cifrado AES-GCM.
AesGcmEncryptParameters

Parámetros de cifrado para algoritmos de cifrado AES-GCM.
BackupKeyOptions

Opciones de backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions

Interfaz que representa los parámetros opcionales a los que se puede pasar beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions

Interfaz que representa los parámetros opcionales a los que se puede pasar beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions

Interfaz que representa los parámetros opcionales a los que se puede pasar createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions

Interfaz que representa los parámetros opcionales a los que se puede pasar createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions

Interfaz que representa los parámetros opcionales a los que se puede pasar createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions

Interfaz que representa los parámetros opcionales a los que se puede pasar createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions

Los parámetros opcionales aceptados por cryptographyClient de KeyVault
CryptographyOptions

Una interfaz que representa las opciones de los métodos de la API de criptografía, vaya a CryptographyClient para obtener más información.
DecryptOptions

Opciones de decrypt(DecryptParameters, DecryptOptions).
DecryptResult

Resultado de la decrypt(DecryptParameters, DecryptOptions) operación.
DeletedKey

Interfaz que representa una clave de Key Vault eliminada.
EncryptOptions

Opciones de encrypt(EncryptParameters, EncryptOptions).
EncryptResult

Resultado de la encrypt(EncryptParameters, EncryptOptions) operación.
GetCryptographyClientOptions

Opciones para getCryptographyClient.
GetDeletedKeyOptions

Opciones de getDeletedKey(string, GetDeletedKeyOptions).
GetKeyOptions

Opciones de getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions

Opciones para <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions

Opciones para getRandomBytes
ImportKeyOptions

Interfaz que representa los parámetros opcionales a los que se puede pasar importKey(string, JsonWebKey_2, ImportKeyOptions)
JsonWebKey

A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions

Los parámetros opcionales aceptados por KeyVault KeyClient
KeyPollerOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a beginDeleteKey(string, BeginDeleteKeyOptions) y beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties

Interfaz que representa las propiedades de KeyVaultKey
KeyReleasePolicy

Reglas de directiva con las que se puede exportar una clave.
KeyRotationLifetimeAction

Una acción y su desencadenador correspondiente que realizará Key Vault durante la duración de una clave.
KeyRotationPolicy

La directiva de rotación de claves completa que pertenece a una clave.
KeyRotationPolicyProperties

Las propiedades de una directiva de rotación de claves que el cliente puede establecer para una clave determinada.

También puede restablecer la directiva de rotación de claves a sus valores predeterminados estableciendo lifetimeActions en una matriz vacía.
KeyVaultKey

Interfaz que representa una clave Key Vault, con su nombre, valor y KeyProperties.
KeyVaultKeyIdentifier

Representa los segmentos que componen un identificador de clave de Key Vault.
ListDeletedKeysOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas de KeyClient que se pasan a listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas de KeyClient que se pasan a listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas de KeyClient que se pasan a listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings

Interfaz que realiza un seguimiento de la configuración de la iteración paginada
PagedAsyncIterableIterator

Interfaz que permite la iteración asincrónica tanto al final como a la página.
PollOperationState

PollOperationState contiene una lista fundamentada del conjunto más pequeño de propiedades necesarias para definir cualquier sondeo de operación de larga duración.

Aunque la clase Poller funciona como mecanismo de control local para iniciar el desencadenamiento, esperar y cancelar potencialmente una operación de larga duración, PollOperationState documenta el estado de la operación remota de larga duración.

Debe actualizarse al menos cuando se inicia la operación, cuando finalice y cuando se cancele. Sin embargo, las implementaciones pueden tener cualquier otro número de propiedades que se puedan actualizar por otros motivos.
PollerLike

Representación abstracta de un sondeo, diseñada para exponer solo la API mínima con la que el usuario necesita trabajar.
PurgeDeletedKeyOptions

Opciones de purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions

Opciones de releaseKey
ReleaseKeyResult

Resultado de la operación releaseKey .
RestoreKeyBackupOptions

Opciones de restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions

Opciones de rotateKey
RsaDecryptParameters

Parámetros de descifrado para algoritmos de cifrado RSA.
RsaEncryptParameters

Parámetros de cifrado para algoritmos de cifrado RSA.
SignOptions

Opciones de sign(string, Uint8Array, SignOptions).
SignResult

Resultado de la sign(string, Uint8Array, SignOptions) operación.
UnwrapKeyOptions

Opciones de unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult

Resultado de la <xref:unwrap> operación.
UpdateKeyPropertiesOptions

Opciones de updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions

Opciones de updateKeyRotationPolicy
VerifyDataOptions

Opciones para verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions

Opciones de verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult

Resultado de la verify(string, Uint8Array, Uint8Array, VerifyOptions) operación.
WrapKeyOptions

Opciones de wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult

Resultado de la <xref:wrap> operación.

Alias de tipos

AesCbcEncryptionAlgorithm

Tipo de unión que representa todos los algoritmos de cifrado AES-CBC admitidos.
AesGcmEncryptionAlgorithm

Tipo de unión que representa todos los algoritmos de cifrado AES-GCM admitidos.
DecryptParameters

Tipo que representa todos los parámetros de descifrado admitidos actualmente a medida que se aplican a distintos algoritmos de cifrado.
DeletionRecoveryLevel

Define valores para DeletionRecoveryLevel.
KnownDeletionRecoveryLevel se puede usar indistintamente con DeletionRecoveryLevel, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Purgable: indica un estado de almacén en el que la eliminación es una operación irreversible, sin la posibilidad de recuperación. Este nivel no corresponde a ninguna protección disponible en una operación de eliminación; Los datos se pierden irrecuperablemente al aceptar una operación de eliminación en el nivel de entidad o superior (almacén, grupo de recursos, suscripción, etc.).
Recuperable+Purgable: denota un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purgar). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días), a menos que se solicite una operación de purga o se cancele la suscripción. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recuperable: indica un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días) y mientras la suscripción sigue estando disponible. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+ProtectedSubscription: indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar dentro del intervalo de retención (90 días), la eliminación inmediata y permanente (es decir, la purga) no está permitida y en la que la propia suscripción no se puede cancelar permanentemente. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
CustomizedRecoverable+Purgeable: denota un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención, a menos que se solicite una operación de purga o se cancele la suscripción.
CustomizedRecoverable: denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y mientras la suscripción sigue estando disponible.
CustomizedRecoverable+ProtectedSubscription: indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, la purga) no está permitida y en la que no se puede cancelar permanentemente la suscripción cuando 7<= SoftDeleteRetentionInDays < 90. Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y también refleja el hecho de que no se puede cancelar la propia suscripción.
EncryptParameters

Tipo que representa todos los parámetros de cifrado admitidos actualmente a medida que se aplican a distintos algoritmos de cifrado.
EncryptionAlgorithm

Define valores para JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> se puede usar indistintamente con JsonWebKeyEncryptionAlgorithm, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

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

Define valores para JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> se puede usar indistintamente con JsonWebKeyCurveName, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

P-256: Curva elíptica NIST P-256, curva AKA SECG curva SECP256R1.
P-384: Curva elíptica NIST P-384, curva AKA SECG curva SECP384R1.
P-521: Curva elíptica NIST P-521, curva AKA SECG curva SECP521R1.
P-256K: curva elíptica SECG SECP256K1.
KeyExportEncryptionAlgorithm

Define valores para KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm se puede usar indistintamente con KeyEncryptionAlgorithm, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384
KeyOperation

Define valores para JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> se puede usar indistintamente con JsonWebKeyOperation, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export
KeyRotationPolicyAction

Acción que se ejecutará.
KeyType

Define valores para JsonWebKeyType.
<xref:KnownJsonWebKeyType> se puede usar indistintamente con JsonWebKeyType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

EC: Curva elíptica.
EC-HSM: Curva elíptica con una clave privada que se almacena en el HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA con una clave privada que se almacena en el HSM.
oct: secuencia octeto (usada para representar claves simétricas)
oct-HSM: secuencia de octetos (que se usa para representar claves simétricas) que se almacena en el HSM.
KeyWrapAlgorithm

Algoritmos admitidos para el ajuste o desencapsulado de claves
RsaEncryptionAlgorithm

Tipo de unión que representa todos los algoritmos de cifrado RSA admitidos.
SignatureAlgorithm

Define valores para JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> se puede usar indistintamente con JsonWebKeySignatureAlgorithm, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

PS256: RSASSA-PSS con SHA-256 y MGF1 con SHA-256, como se describe en https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS con SHA-384 y MGF1 con SHA-384, como se describe en https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS mediante SHA-512 y MGF1 con SHA-512, como se describe en https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 mediante SHA-256, como se describe en https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 mediante SHA-384, como se describe en https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 mediante SHA-512, como se describe en https://tools.ietf.org/html/rfc7518
RSNULL: Reservado
ES256: ECDSA con P-256 y SHA-256, como se describe en https://tools.ietf.org/html/rfc7518.
ES384: ECDSA con P-384 y SHA-384, como se describe en https://tools.ietf.org/html/rfc7518
ES512: ECDSA con P-521 y SHA-512, como se describe en https://tools.ietf.org/html/rfc7518
ES256K: ECDSA con P-256K y SHA-256, como se describe en https://tools.ietf.org/html/rfc7518

Enumeraciones

KnownDeletionRecoveryLevel

Valores conocidos de DeletionRecoveryLevel que acepta el servicio.
KnownEncryptionAlgorithms

Valores conocidos de EncryptionAlgorithm que acepta el servicio.
KnownKeyCurveNames

Valores conocidos de <xref:JsonWebKeyCurveName> que acepta el servicio.
KnownKeyExportEncryptionAlgorithm

Valores conocidos de KeyExportEncryptionAlgorithm que acepta el servicio.
KnownKeyOperations

Valores conocidos de KeyOperation que acepta el servicio.
KnownKeyTypes

Valores conocidos de <xref:JsonWebKeyType> que acepta el servicio.
KnownSignatureAlgorithms

Valores conocidos de <xref:JsonWebKeySignatureAlgorithm> que acepta el servicio.

Funciones

parseKeyVaultKeyIdentifier(string)

Analiza el identificador de clave de Key Vault especificado. Un ejemplo es:

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

Al analizar el identificador anterior, esta función devuelve:

  {
     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>"
  }

Detalles de la función

parseKeyVaultKeyIdentifier(string)

Analiza el identificador de clave de Key Vault especificado. Un ejemplo es:

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

Al analizar el identificador anterior, esta función devuelve:

  {
     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

Parámetros

id

string

Identificador de la clave de Key Vault.

Devoluciones

KeyVaultKeyIdentifier