@azure/keyvault-keys package

Référence

Classes

CryptographyClient	Un client utilisé pour effectuer des opérations de chiffrement sur une clé Azure Key Vault ou une JsonWebKey locale.
KeyClient	KeyClient fournit des méthodes pour gérer KeyVaultKey dans Azure Key Vault. Le client prend en charge la création, la récupération, la mise à jour, la suppression, la purge, la sauvegarde, la restauration et la liste des KeyVaultKeys. Le client prend également en charge la liste des DeletedKey pour une suppression réversible d’Azure Key Vault.

Interfaces

AesCbcDecryptParameters	Paramètres de déchiffrement pour les algorithmes de chiffrement AES-CBC.
AesCbcEncryptParameters	Paramètres de chiffrement pour les algorithmes de chiffrement AES-CBC.
AesGcmDecryptParameters	Paramètres de déchiffrement pour les algorithmes de chiffrement AES-GCM.
AesGcmEncryptParameters	Paramètres de chiffrement pour les algorithmes de chiffrement AES-GCM.
BackupKeyOptions	Options de backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions	Paramètres facultatifs acceptés par le CryptographyClient du Coffre de clés
CryptographyOptions	Interface représentant les options des méthodes de l’API de chiffrement, accédez au CryptographyClient pour plus d’informations.
DecryptOptions	Options de decrypt(DecryptParameters, DecryptOptions).
DecryptResult	Résultat de l’opération de decrypt(DecryptParameters, DecryptOptions).
DeletedKey	Interface représentant une clé Key Vault supprimée.
EncryptOptions	Options de encrypt(EncryptParameters, EncryptOptions).
EncryptResult	Résultat de l’opération de encrypt(EncryptParameters, EncryptOptions).
GetCryptographyClientOptions	Options pour getCryptographyClient.
GetDeletedKeyOptions	Options de getDeletedKey(string, GetDeletedKeyOptions).
GetKeyOptions	Options de getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions	Options de <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions	Options pour getRandomBytes
ImportKeyOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à importKey(string, JsonWebKey, ImportKeyOptions)
JsonWebKey	À partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions	Paramètres facultatifs acceptés par keyClient de KeyVault
KeyPollerOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginDeleteKey(string, BeginDeleteKeyOptions) et beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties	Interface représentant les propriétés de KeyVaultKey
KeyReleasePolicy	Règles de stratégie sous lesquelles une clé peut être exportée.
KeyRotationLifetimeAction	Action et son déclencheur correspondant qui seront effectués par Key Vault au cours de la durée de vie d’une clé.
KeyRotationPolicy	Stratégie de rotation de clé complète qui appartient à une clé.
KeyRotationPolicyProperties	Propriétés d’une stratégie de rotation de clé que le client peut définir pour une clé donnée. Vous pouvez également réinitialiser la stratégie de rotation de clé à ses valeurs par défaut en définissant lifetimeActions sur un tableau vide.
KeyVaultKey	Interface représentant une clé Key Vault, avec son nom, sa valeur et KeyProperties.
KeyVaultKeyIdentifier	Représente les segments qui composent un ID de clé Key Vault.
ListDeletedKeysOptions	Interface représentant des paramètres facultatifs pour les opérations paginées KeyClient passées à listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions	Interface représentant des paramètres facultatifs pour les opérations paginées KeyClient passées à listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions	Interface représentant des paramètres facultatifs pour les opérations paginées KeyClient passées à listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings	Interface qui suit les paramètres de l’itération paginée
PagedAsyncIterableIterator	Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.
PollOperationState	PollOperationState contient une liste opinionnée du plus petit ensemble de propriétés nécessaire pour définir tout polleur d’opérations de longue durée. Bien que la classe Poller fonctionne comme mécanisme de contrôle local pour démarrer le déclenchement, attendre et éventuellement annuler une opération de longue durée, PollOperationState documente l’état de l’opération de longue durée distante. Elle doit être mise à jour au moins au démarrage de l’opération, quand elle est terminée et quand elle est annulée. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour par d’autres raisons.
PollerLike	Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.
PurgeDeletedKeyOptions	Options de purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions	Options pour releaseKey
ReleaseKeyResult	Résultat de l’opération releaseKey .
RestoreKeyBackupOptions	Options de restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions	Options pour rotationKey
RsaDecryptParameters	Paramètres de déchiffrement pour les algorithmes de chiffrement RSA.
RsaEncryptParameters	Paramètres de chiffrement pour les algorithmes de chiffrement RSA.
SignOptions	Options de sign(string, Uint8Array, SignOptions).
SignResult	Résultat de l’opération de sign(string, Uint8Array, SignOptions).
UnwrapKeyOptions	Options de unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	Résultat de l’opération de <xref:unwrap>.
UpdateKeyPropertiesOptions	Options de updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions	Options de updateKeyRotationPolicy
VerifyDataOptions	Options de verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions	Options de verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult	Résultat de l’opération de verify(string, Uint8Array, Uint8Array, VerifyOptions).
WrapKeyOptions	Options de wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	Résultat de l’opération de <xref:wrap>.

Alias de type

AesCbcEncryptionAlgorithm	Type d’union représentant tous les algorithmes de chiffrement AES-CBC pris en charge.
AesGcmEncryptionAlgorithm	Type d’union représentant tous les algorithmes de chiffrement AES-GCM pris en charge.
DecryptParameters	Type représentant tous les paramètres de déchiffrement actuellement pris en charge, car ils s’appliquent à différents algorithmes de chiffrement.
DeletionRecoveryLevel	Définit des valeurs pour DeletionRecoveryLevel. KnownDeletionRecoveryLevel pouvez être utilisé de manière interchangeable avec DeleteRecoveryLevel, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service purgeable : désigne un état de coffre dans lequel la suppression est irréversible, sans possibilité de récupération. Ce niveau correspond à aucune protection disponible contre une opération De suppression ; les données sont irrécupérablement perdues lors de l’acceptation d’une opération Delete au niveau de l’entité ou supérieure (coffre, groupe de ressources, abonnement, etc.) récupérable+purgeable: indique un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (c’est-à-dire purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de vidage est demandée ou si l’abonnement est annulé. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré récupérable : désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré récupérable+ProtectedSubscription: indique un coffre et un état d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée, et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré CustomRecoverable+Purgeable: indique un état de coffre dans lequel la suppression est récupérable, et qui permet également une suppression immédiate et définitive (c’est-à-dire purger lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de vidage est demandée ou si l’abonnement est annulé. CustomRecoverable: indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger lorsque 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant la disponibilité de l’abonnement. CustomRecoverable+ProtectedSubscription: indique un coffre et un état d’abonnement dans lequel la suppression est récupérable, immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement lorsque 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.
EncryptParameters	Type représentant tous les paramètres de chiffrement actuellement pris en charge, car ils s’appliquent à différents algorithmes de chiffrement.
EncryptionAlgorithm	Définit des valeurs pour JsonWebKeyEncryptionAlgorithm. <xref:KnownJsonWebKeyEncryptionAlgorithm> pouvez être utilisé de manière interchangeable avec JsonWebKeyEncryptionAlgorithm, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service RSA-OAEP RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	Définit des valeurs pour JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> pouvez être utilisé de manière interchangeable avec JsonWebKeyCurveName, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service P-256: courbe elliptique NIST P-256, courbe AKA SCG SECP256R1. P-384: courbe elliptique NIST P-384, courbe AKA SCG SECP384R1. P-521: courbe elliptique NIST P-521, courbe AKA SCG SECP521R1. P-256K : la courbe elliptique SECP256K1 SCG.
KeyExportEncryptionAlgorithm	Définit des valeurs pour KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm peut être utilisé de manière interchangeable avec KeyEncryptionAlgorithm, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	Définit des valeurs pour JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> pouvez être utilisé de manière interchangeable avec JsonWebKeyOperation, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service chiffrer déchiffrer signer vérifier wrapKey unwrapKey d’importation exporter
KeyRotationPolicyAction	Action qui sera exécutée.
KeyType	Définit des valeurs pour JsonWebKeyType. <xref:KnownJsonWebKeyType> pouvez être utilisé de manière interchangeable avec JsonWebKeyType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service EC: courbe elliptique. EC-HSM: Courbe elliptique avec une clé privée stockée dans le HSM. RSA : RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA avec une clé privée stockée dans le HSM. oct: séquence d’octets (utilisée pour représenter des clés symétriques) oct-HSM: séquence d’octets (utilisée pour représenter des clés symétriques) qui est stockée le HSM.
KeyWrapAlgorithm	Algorithmes pris en charge pour le wrapping/unwrapping de clé
RsaEncryptionAlgorithm	Type d’union représentant tous les algorithmes de chiffrement RSA pris en charge.
SignatureAlgorithm	Définit des valeurs pour JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> pouvez être utilisé de manière interchangeable avec JsonWebKeySignatureAlgorithm, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service PS256 : RSASSA-PSS à l’aide de SHA-256 et MGF1 avec SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518 PS384 : RSASSA-PSS à l’aide de SHA-384 et MGF1 avec SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518 PS512 : RSASSA-PSS à l’aide de SHA-512 et MGF1 avec SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 à l’aide de SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518 RS384 : RSASSA-PKCS1-v1_5 à l’aide de SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518 RS512 : RSASSA-PKCS1-v1_5 à l’aide de SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518 RSNULL: Réservé ES256: ECDSA utilisant P-256 et SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518. ES384: ECDSA utilisant P-384 et SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518 ES512: ECDSA utilisant P-521 et SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518 ES256K : ECDSA utilisant P-256K et SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518

Énumérations

KnownDeletionRecoveryLevel	Valeurs connues de DeletionRecoveryLevel que le service accepte.
KnownEncryptionAlgorithms	Valeurs connues de EncryptionAlgorithm que le service accepte.
KnownKeyCurveNames	Valeurs connues de <xref:JsonWebKeyCurveName> que le service accepte.
KnownKeyExportEncryptionAlgorithm	Valeurs connues de KeyExportEncryptionAlgorithm que le service accepte.
KnownKeyOperations	Valeurs connues de KeyOperation que le service accepte.
KnownKeyTypes	Valeurs connues de <xref:JsonWebKeyType> que le service accepte.
KnownSignatureAlgorithms	Valeurs connues de <xref:JsonWebKeySignatureAlgorithm> que le service accepte.

Functions

parseKeyVaultKeyIdentifier(string)

Analyse l’ID de clé Key Vault donné. Voici un exemple :

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

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

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

Informations relatives à la fonction

parseKeyVaultKeyIdentifier(string)

Analyse l’ID de clé Key Vault donné. Voici un exemple :

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

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

  {
     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

Paramètres

id: string

ID de la clé Key Vault.

Retours

KeyVaultKeyIdentifier

Partager via

@azure/keyvault-keys package

Classes

Interfaces

Alias de type

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Valeurs connues prises en charge par le service

Énumérations

Functions

Informations relatives à la fonction

parseKeyVaultKeyIdentifier(string)

Paramètres

Retours

Ressources supplémentaires