@azure/keyvault-keys package

Classi

CryptographyClient	Un client usato per eseguire operazioni di crittografia in una chiave dell'insieme di credenziali delle chiavi di Azure o in jsonWebKey locale.
KeyClient	KeyClient fornisce metodi per gestire KeyVaultKey nell'Key Vault di Azure. Il client supporta la creazione, il recupero, l'aggiornamento, l'eliminazione, l'eliminazione, il backup, il ripristino e l'elenco di KeyVaultKey. Il client supporta anche l'elenco di DeletedKey per un Key Vault di Azure abilitato per l'eliminazione temporanea.

Interfacce

AesCbcDecryptParameters	Parametri di decrittografia per algoritmi di crittografia AES-CBC.
AesCbcEncryptParameters	Parametri di crittografia per algoritmi di crittografia AES-CBC.
AesGcmDecryptParameters	Parametri di decrittografia per algoritmi di crittografia AES-GCM.
AesGcmEncryptParameters	Parametri di crittografia per algoritmi di crittografia AES-GCM.
BackupKeyOptions	Opzioni per backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions	Parametri facoltativi accettati da CryptographyClient di KeyVault
CryptographyOptions	Interfaccia che rappresenta le opzioni dei metodi api di crittografia, passare a CryptographyClient per altre informazioni.
DecryptOptions	Opzioni per decrypt(DecryptParameters, DecryptOptions).
DecryptResult	Risultato dell'operazione decrypt(DecryptParameters, DecryptOptions) .
DeletedKey	Interfaccia che rappresenta una chiave di Key Vault eliminata.
EncryptOptions	Opzioni per encrypt(EncryptParameters, EncryptOptions).
EncryptResult	Risultato dell'operazione encrypt(EncryptParameters, EncryptOptions) .
GetCryptographyClientOptions	Opzioni per getCryptographyClient.
GetDeletedKeyOptions	Opzioni per getDeletedKey(string, GetDeletedKeyOptions).
GetKeyOptions	Opzioni per getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions	Opzioni per <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions	Opzioni per getRandomBytes
ImportKeyOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a importKey(string, JsonWebKey_2, ImportKeyOptions)
JsonWebKey	A partire da http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions	Parametri facoltativi accettati dal KeyVault KeyClient
KeyPollerOptions	Interfaccia che rappresenta i parametri facoltativi che possono essere passati a beginDeleteKey(string, BeginDeleteKeyOptions) e beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties	Interfaccia che rappresenta le proprietà di KeyVaultKey
KeyReleasePolicy	Regole dei criteri in cui è possibile esportare una chiave.
KeyRotationLifetimeAction	Un'azione e il relativo trigger corrispondente che verranno eseguiti da Key Vault durante la durata di una chiave.
KeyRotationPolicy	Criterio di rotazione delle chiavi completo che appartiene a una chiave.
KeyRotationPolicyProperties	Proprietà di un criterio di rotazione delle chiavi che il client può impostare per una determinata chiave. È anche possibile reimpostare i criteri di rotazione delle chiavi nei relativi valori predefiniti impostando la durataActions su una matrice vuota.
KeyVaultKey	Interfaccia che rappresenta una chiave Key Vault, con il nome, il valore e le proprietà chiave.
KeyVaultKeyIdentifier	Rappresenta i segmenti che compongono un ID chiave Key Vault.
ListDeletedKeysOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di pagina KeyClient passate a listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di pagina KeyClient passate a listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di pagina KeyClient passate a listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings	Interfaccia che tiene traccia delle impostazioni per l'iterazione paginata
PagedAsyncIterableIterator	Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.
PollOperationState	PollOperationState contiene un elenco di opinioni del set più piccolo di proprietà necessarie per definire qualsiasi poller di operazione a esecuzione prolungata. Mentre la classe Poller funziona come meccanismo di controllo locale per avviare l'attivazione, attendere e annullare potenzialmente un'operazione a esecuzione prolungata, pollOperationState documenta lo stato dell'operazione a esecuzione prolungata remota. Deve essere aggiornato almeno all'avvio dell'operazione, al termine dell'operazione e al momento dell'annullamento. Tuttavia, le implementazioni possono avere qualsiasi altro numero di proprietà che possono essere aggiornate da altri motivi.
PollerLike	Rappresentazione astratta di un poller, destinata a esporre solo l'API minima con cui l'utente deve lavorare.
PurgeDeletedKeyOptions	Opzioni per purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions	Opzioni per releaseKey
ReleaseKeyResult	Risultato dell'operazione releaseKey .
RestoreKeyBackupOptions	Opzioni per restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions	Opzioni per ruotareKey
RsaDecryptParameters	Parametri di decrittografia per algoritmi di crittografia RSA.
RsaEncryptParameters	Parametri di crittografia per algoritmi di crittografia RSA.
SignOptions	Opzioni per sign(string, Uint8Array, SignOptions).
SignResult	Risultato dell'operazione sign(string, Uint8Array, SignOptions) .
UnwrapKeyOptions	Opzioni per unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	Risultato dell'operazione <xref:unwrap> .
UpdateKeyPropertiesOptions	Opzioni per updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions	Opzioni per updateKeyRotationPolicy
VerifyDataOptions	Opzioni per verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions	Opzioni per verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult	Risultato dell'operazione verify(string, Uint8Array, Uint8Array, VerifyOptions) .
WrapKeyOptions	Opzioni per wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	Risultato dell'operazione <xref:wrap> .

Alias tipo

AesCbcEncryptionAlgorithm	Tipo di unione che rappresenta tutti gli algoritmi di crittografia AES-CBC supportati.
AesGcmEncryptionAlgorithm	Tipo di unione che rappresenta tutti gli algoritmi di crittografia AES-GCM supportati.
DecryptParameters	Tipo che rappresenta tutti i parametri di decrittografia attualmente supportati quando si applicano a algoritmi di crittografia diversi.
DeletionRecoveryLevel	Definisce i valori per DeletionRecoveryLevel. NotaDeletionRecoveryLevel può essere usata in modo interscambiabile con DeletionRecoveryLevel, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Eliminabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è un'operazione irreversibile, senza la possibilità di ripristino. Questo livello corrisponde a nessuna protezione disponibile su un'operazione Di eliminazione; i dati sono irreperibili quando si accetta un'operazione Di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via) Recuperabile+Eliminabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio l'eliminazione). Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato Recuperabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio l'eliminazione). Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione(90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato Recuperabile+ProtectedSubscription: indica uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato CustomdRecoverable+Purgeable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente ,ad esempio, quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. CustomdRecoverable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminare immediatamente e definitivamente (ad esempio, eliminare quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile. CustomdRecoverable+ProtectedSubscription: indica uno stato dell'insieme di credenziali e della sottoscrizione in cui l'eliminazione è recuperabile, immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione e riflette anche il fatto che la sottoscrizione stessa non può essere annullata.
EncryptParameters	Tipo che rappresenta tutti i parametri di crittografia attualmente supportati quando si applicano a diversi algoritmi di crittografia.
EncryptionAlgorithm	Definisce i valori per JsonWebKeyEncryptionAlgorithm. <xref:KnownJsonWebKeyEncryptionAlgorithm> può essere usato in modo intercambiabile con JsonWebKeyEncryptionAlgorithm, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio RSA-OAEP RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	Definisce i valori per JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> può essere usato in modo interscambiabile con JsonWebKeyCurveName, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio P-256: curva NIST P-256 ellittica, curva SECG AKA SECG SECP256R1. P-384: curva ellitica NIST P-384, curva SECG AKA SECG SECP384R1. P-521: curva NIST P-521 ellittica, curva SECG AKA SECG SECP521R1. P-256K: curva ellittica SECG SECP256K1.
KeyExportEncryptionAlgorithm	Definisce i valori per KeyEncryptionAlgorithm. NotoKeyExportEncryptionAlgorithm può essere usato in modo interscambiabile con KeyEncryptionAlgorithm, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	Definisce i valori per JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> può essere usato in modo interscambiabile con JsonWebKeyOperation, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio encrypt Decrittografare sign verify wrappingKey unwrapKey import Esportazione
KeyRotationPolicyAction	Azione che verrà eseguita.
KeyType	Definisce i valori per JsonWebKeyType. <xref:KnownJsonWebKeyType> può essere usato in modo interscambiabile con JsonWebKeyType, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio EC: Curva ellittica. EC-HSM: Curva ellittica con una chiave privata archiviata nel modulo di protezione hardware. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA con una chiave privata archiviata nel modulo di protezione hardware. oct: sequenza ottet (usata per rappresentare chiavi simmetriche) oct-HSM: sequenza di ottet (utilizzata per rappresentare chiavi simmetriche) archiviata nel modulo di protezione hardware.
KeyWrapAlgorithm	Algoritmi supportati per il wrapping delle chiavi/unwrapping
RsaEncryptionAlgorithm	Tipo di unione che rappresenta tutti gli algoritmi di crittografia RSA supportati.
SignatureAlgorithm	Definisce i valori per JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> può essere usato in modo interscambiabile con JsonWebKeySignatureAlgorithm, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio PS256: RSASSA-PSS usando SHA-256 e MGF1 con SHA-256, come descritto in https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS usando SHA-384 e MGF1 con SHA-384, come descritto in https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS usando SHA-512 e MGF1 con SHA-512, come descritto in https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 usando SHA-256, come descritto in https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 usando SHA-384, come descritto in https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 usando SHA-512, come descritto in https://tools.ietf.org/html/rfc7518 RSNULL: riservato ES256: ECDSA usando P-256 e SHA-256, come descritto in https://tools.ietf.org/html/rfc7518. ES384: ECDSA usando P-384 e SHA-384, come descritto in https://tools.ietf.org/html/rfc7518 ES512: ECDSA usando P-521 e SHA-512, come descritto in https://tools.ietf.org/html/rfc7518 ES256K: ECDSA con P-256K e SHA-256, come descritto in https://tools.ietf.org/html/rfc7518

Enumerazioni

KnownDeletionRecoveryLevel	Valori noti di DeletionRecoveryLevel accettati dal servizio.
KnownEncryptionAlgorithms	Valori noti di EncryptionAlgorithm accettati dal servizio.
KnownKeyCurveNames	Valori noti di <xref:JsonWebKeyCurveName> che il servizio accetta.
KnownKeyExportEncryptionAlgorithm	Valori noti di KeyExportEncryptionAlgorithm accettati dal servizio.
KnownKeyOperations	Valori noti di KeyOperation accettati dal servizio.
KnownKeyTypes	Valori noti di <xref:JsonWebKeyType> che il servizio accetta.
KnownSignatureAlgorithms	Valori noti di <xref:JsonWebKeySignatureAlgorithm> che il servizio accetta.

Funzioni

parseKeyVaultKeyIdentifier(string)

Analizza l'ID chiave specificato Key Vault. Un esempio è: https://.vault.azure.net/keys// Nell'analisi dell'ID precedente, questa funzione restituisce: { 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>" }

Dettagli funzione

parseKeyVaultKeyIdentifier(string)

Analizza l'ID chiave specificato Key Vault. Un esempio è:

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

Nell'analisi dell'ID precedente, questa funzione restituisce:

  {
     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

Parametri

id

string

ID della chiave di Key Vault.

Restituisce

KeyVaultKeyIdentifier