Compartir a través de

@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 una instancia local <xref:JsonWebKey>de .
KeyClient

KeyClient proporciona métodos para administrar <xref: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 la lista <xref:DeletedKey> de 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 <xref:backupKey>.
BeginDeleteKeyOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:beginDeleteKey>
BeginRecoverDeletedKeyOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:beginRecoverDeletedKey>
CreateEcKeyOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:createEcKey>
CreateKeyOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:createKey>
CreateOctKeyOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:createOctKey>
CreateRsaKeyOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:createRsaKey>
CryptographyClientOptions

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 <xref:CryptographyClient> para obtener más información.
DecryptOptions

Opciones de <xref:decrypt>.
DecryptResult

Resultado de la <xref:decrypt> operación.
DeletedKey

Interfaz que representa una clave de Key Vault eliminada.
EncryptOptions

Opciones de <xref:encrypt>.
EncryptResult

Resultado de la <xref:encrypt> operación.
GetDeletedKeyOptions

Opciones de <xref:getDeletedKey>.
GetKeyOptions

Opciones de <xref:getKey>.
ImportKeyOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:importKey>
JsonWebKey

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

Parámetros opcionales aceptados por KeyVault KeyClient
KeyPollerOptions

Interfaz que representa los parámetros opcionales que se pueden pasar a <xref:beginDeleteKey> y <xref:beginRecoverDeletedKey>
KeyProperties

Interfaz que representa las propiedades de <xref:KeyVaultKey>
KeyVaultKey

Interfaz que representa una clave de Key Vault, con su nombre, valor y <xref: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 keyClient pasadas a <xref:listDeletedKeys>.
ListPropertiesOfKeyVersionsOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas keyClient pasadas a <xref:listPropertiesOfKeyVersions>.
ListPropertiesOfKeysOptions

Interfaz que representa parámetros opcionales para las operaciones paginadas keyClient pasadas a <xref:listPropertiesOfKeys>.
PurgeDeletedKeyOptions

Opciones de <xref:purgeDeletedKey>.
RestoreKeyBackupOptions

Opciones de <xref:restoreKeyBackup>.
RsaDecryptParameters

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

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

Opciones de <xref:sign>.
SignResult

Resultado de la <xref:sign> operación.
UnwrapKeyOptions

Opciones de <xref:unwrapKey>.
UnwrapResult

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

Opciones de <xref:updateKeyProperties>.
VerifyDataOptions

Opciones para <xref:verifyData>
VerifyOptions

Opciones de <xref:verify>.
VerifyResult

Resultado de la <xref:verify> operación.
WrapKeyOptions

Opciones de <xref:wrapKey>.
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 los valores de DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> se puede usar indistintamente con DeletionRecoveryLevel, esta enumeración contiene los valores conocidos que admite el servicio.

Conocer valores 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: indica 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, purga). 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
Recuperable+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), no se permite la eliminación inmediata y permanente (es decir, purga) 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, purga) no está permitida y en la que la propia suscripción no se puede cancelar permanentemente 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.

Conocer valores 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.

Conocer valores admitidos por el servicio

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

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

Conocer valores admitidos por el servicio

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
KeyType

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

Conocer valores admitidos por el servicio

EC: Curva elíptica.
EC-HSM: curva elíptica con una clave privada que no se puede exportar desde el HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA con una clave privada que no se puede exportar desde el HSM.
oct: secuencia octeto (usada para representar claves simétricas)
oct-HSM: secuencia de octetos (usada para representar claves simétricas) que no se pueden exportar desde 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.

Conocer valores 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 con 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 <xref:DeletionRecoveryLevel> que acepta el servicio.
KnownEncryptionAlgorithms

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

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

Valores conocidos de <xref:JsonWebKeyOperation> 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)

Parámetros

id

string

Identificador de la clave de Key Vault.

Devoluciones

KeyVaultKeyIdentifier