@azure/keyvault-keys package

Classi

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

Interfacce

AesCbcDecryptParameters	Parametri di decrittografia per AES-CBC algoritmi di crittografia.
AesCbcEncryptParameters	Parametri di crittografia per gli algoritmi di crittografia AES-CBC.
AesGcmDecryptParameters	Parametri di decrittografia per AES-GCM algoritmi di crittografia.
AesGcmEncryptParameters	Parametri di crittografia per gli 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 dell'API di crittografia, passare al CryptographyClient per altre informazioni.
DecryptOptions	Opzioni per decrypt(DecryptParameters, DecryptOptions).
DecryptResult	Risultato dell'operazione di decrypt(DecryptParameters, DecryptOptions).
DeletedKey	Interfaccia che rappresenta una chiave di Key Vault eliminata.
EncryptOptions	Opzioni per encrypt(EncryptParameters, EncryptOptions).
EncryptResult	Risultato dell'operazione di encrypt(EncryptParameters, EncryptOptions).
GetCryptographyClientOptions	Opzioni per getCryptographyClient.
GetDeletedKeyOptions	Opzioni per getDeletedKey(string, GetDeletedKeyOptions).
GetKeyAttestationOptions	Opzioni per getKeyAttestation(string, GetKeyAttestationOptions).
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, ImportKeyOptions)
JsonWebKey	A partire da http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyAttestation	Interfaccia che rappresenta le proprietà dell'attestazione di una chiave
KeyClientOptions	Parametri facoltativi accettati da KeyClient dell'insieme di credenziali delle chiavi
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 base alle quali è possibile esportare una chiave.
KeyRotationLifetimeAction	Un'azione e il trigger corrispondente che verranno eseguiti da Key Vault per tutta la durata di una chiave.
KeyRotationPolicy	Criteri di rotazione delle chiavi completi che appartengono 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 sui valori predefiniti impostando lifetimeActions su una matrice vuota.
KeyVaultKey	Interfaccia che rappresenta una chiave dell'insieme di credenziali delle chiavi, con il nome, il valore e Proprietà chiave.
KeyVaultKeyIdentifier	Rappresenta i segmenti che compongono un ID chiave dell'insieme di credenziali delle chiavi.
ListDeletedKeysOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging KeyClient passate a listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging KeyClient passate a listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions	Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging KeyClient passate a listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings	Interfaccia che tiene traccia delle impostazioni per l'iterazione di paging
PagedAsyncIterableIterator	Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.
PollOperationState	PollOperationState contiene un elenco di opinioni del set di proprietà più piccolo necessario per definire un poller di operazione a esecuzione prolungata. Mentre la classe Poller funziona come meccanismo di controllo locale per avviare l'attivazione, attendere e potenzialmente annullare 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 di releaseKey.
RestoreKeyBackupOptions	Opzioni per restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions	Opzioni per rotateKey
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 di sign(string, Uint8Array, SignOptions).
UnwrapKeyOptions	Opzioni per unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	Risultato dell'operazione di <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 di verify(string, Uint8Array, Uint8Array, VerifyOptions).
WrapKeyOptions	Opzioni per wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	Risultato dell'operazione di <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	Riflette il livello di ripristino di eliminazione attualmente attivo per i certificati nell'insieme di credenziali corrente. Se contiene "Purgeable", il certificato può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può ripulire il certificato, alla fine dell'intervallo di conservazione. KnownDeletionRecoveryLevel può essere usato in modo intercambiabile con DeletionRecoveryLevel, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio purgeable: 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 per un'operazione di eliminazione; i dati vengono persi in modo irreversibile quando si accetta un'operazione di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via) Ripristinabile+Eliminabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio ripulitura). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di ripulitura o che la sottoscrizione venga annullata. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato Ripristinabile: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio ripulitura). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato Recoverable+ProtectedSubscription: indica un insieme di credenziali e uno stato della sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ad esempio l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata in modo permanente. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato CustomizedRecoverable+Purgeable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio, ripulire quando 7 <= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di ripulitura o che la sottoscrizione venga annullata. CustomizedRecoverable: indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio, ripulire quando 7 <= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile. CustomizedRecoverable+ProtectedSubscription: indica un insieme di credenziali e uno stato di 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 recuperabilità 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 algoritmi di crittografia diversi.
EncryptionAlgorithm	Algoritmo usato per la crittografia e la decrittografia. <xref:KnownJsonWebKeyEncryptionAlgorithm> può essere usato in modo intercambiabile con JsonWebKeyEncryptionAlgorithm, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio RSA-OAEP: [Non consigliato] RSAES con padding OAEP (Optimal Asymmetric Encryption Padding), come descritto in https://tools.ietf.org/html/rfc3447, con i parametri predefiniti specificati da RFC 3447 nella sezione A.2.1. Tali parametri predefiniti usano una funzione hash di SHA-1 e una funzione di generazione della maschera MGF1 con SHA-1. Microsoft consiglia di usare RSA_OAEP_256 o algoritmi più avanzati per migliorare la sicurezza. Microsoft non consiglia RSA_OAEP, inclusa esclusivamente per la compatibilità con le versioni precedenti. RSA_OAEP utilizza SHA1, che presenta problemi di collisione noti. RSA-OAEP-256: RSAES con padding di crittografia asimmetrica ottimale con una funzione hash SHA-256 e una funzione di generazione mask di MGF1 con SHA-256. RSA1_5: [Non consigliato] RSAES- crittografia della chiavePKCS1-V1_5, come descritto in https://tools.ietf.org/html/rfc3447. Microsoft consiglia di usare RSA_OAEP_256 o algoritmi più avanzati per migliorare la sicurezza. Microsoft non consiglia RSA_1_5, incluso esclusivamente per la compatibilità con le versioni precedenti. Gli standard crittografici non considerano più RSA con lo schema di riempimento PKCS#1 v1.5 sicuro per la crittografia. A128GCM: AES-GCM a 128 bit. A192GCM: AES-GCM a 192 bit. A256GCM: AES-GCM a 256 bit. A128KW: ritorno a capo della chiave AES a 128 bit. A192KW: ritorno a capo della chiave AES a 192 bit. A256KW: ritorno a capo della chiave AES a 256 bit. A128CBC: AES-CBC a 128 bit. A192CBC: AES-CBC a 192 bit. A256CBC: AES-CBC a 256 bit. A128CBCPAD: AES-CBC a 128 bit con spaziatura interna PKCS. A192CBCPAD: AES-CBC a 192 bit con spaziatura interna PKCS. A256CBCPAD: AES-CBC a 256 bit con spaziatura interna PKCS. CKM_AES_KEY_WRAP: ritorno a capo del tasto AES CKM. CKM_AES_KEY_WRAP_PAD: ritorno a capo chiave AES CKM con spaziatura interna.
KeyCurveName	Nome curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> può essere usato in modo intercambiabile con JsonWebKeyCurveName, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio curva ellittica P-256: curva ellittica NIST P-256, curva AKA SECG SECP256R1. P-384: curva ellittica NIST P-384, curva AKA SECG SECP384R1. P-521: curva ellittica NIST P-521, curva AKA SECG SECP521R1. P-256K: la curva ellittica SECP256K1 SECG.
KeyExportEncryptionAlgorithm	Definisce i valori per KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm può essere usato in modo intercambiabile 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	Operazioni della chiave Web JSON. Per altre informazioni, vedere JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> può essere usato in modo intercambiabile con JsonWebKeyOperation, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio crittografare: indica che la chiave può essere usata per crittografare. decrittografare: indica che la chiave può essere usata per decrittografare. firma: indica che la chiave può essere usata per firmare. verificare: indica che la chiave può essere usata per verificare. wrapKey: indica che la chiave può essere usata per eseguire il wrapping di un'altra chiave. unwrapKey: indica che la chiave può essere usata per annullare il wrapping di un'altra chiave. importare: indica che la chiave può essere importata durante la creazione. 'esportazione: indica che il componente privato della chiave può essere esportato.
KeyRotationPolicyAction	Azione che verrà eseguita.
KeyType	Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. <xref:KnownJsonWebKeyType> può essere usato in modo intercambiabile con JsonWebKeyType, questa 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 ottetto (usata per rappresentare chiavi simmetriche) oct-HSM: sequenza ottet (usata per rappresentare chiavi simmetriche) archiviata nel modulo di protezione hardware.
KeyWrapAlgorithm	Algoritmi supportati per il wrapping delle chiavi/annullamento del wrapping delle chiavi
RsaEncryptionAlgorithm	Tipo di unione che rappresenta tutti gli algoritmi di crittografia RSA supportati.
SignatureAlgorithm	Identificatore dell'algoritmo di firma/verifica. Per altre informazioni sui possibili tipi di algoritmo, vedere JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> può essere usato in modo intercambiabile con JsonWebKeySignatureAlgorithm, questa 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 con SHA-384 e MGF1 con SHA-384, come descritto in https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS con SHA-512 e MGF1 con SHA-512, come descritto in https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 con SHA-256, come descritto in https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 con SHA-384, come descritto in https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 con SHA-512, come descritto in https://tools.ietf.org/html/rfc7518 HS256: HMAC con SHA-256, come descritto in https://tools.ietf.org/html/rfc7518 HS384: HMAC con SHA-384, come descritto in https://tools.ietf.org/html/rfc7518 HS512: HMAC con SHA-512, come descritto in https://tools.ietf.org/html/rfc7518 RSNULL: riservato ES256: ECDSA con P-256 e SHA-256, come descritto in https://tools.ietf.org/html/rfc7518. ES384: ECDSA con P-384 e SHA-384, come descritto in https://tools.ietf.org/html/rfc7518 ES512: ECDSA con 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	Riflette il livello di ripristino di eliminazione attualmente attivo per i certificati nell'insieme di credenziali corrente. Se contiene "Purgeable", il certificato può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può ripulire il certificato, alla fine dell'intervallo di conservazione.
KnownEncryptionAlgorithms	Algoritmo usato per la crittografia e la decrittografia.
KnownKeyCurveNames	Nome curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName.
KnownKeyExportEncryptionAlgorithm	Algoritmo di crittografia da usare per proteggere il materiale della chiave esportata
KnownKeyOperations	Valori noti di KeyOperation accettati dal servizio.
KnownKeyTypes	Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KnownSignatureAlgorithms	Identificatore dell'algoritmo di firma/verifica. Per altre informazioni sui possibili tipi di algoritmo, vedere JsonWebKeySignatureAlgorithm.

Funzioni

parseKeyVaultKeyIdentifier(string)

Analizza l'ID chiave dell'insieme di credenziali delle chiavi specificato. Un esempio è: https://< nome-cassaforte.vault.azure.net/keys/>< nome-chiave>/<id-versione-univoco> Durante l'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 dell'insieme di credenziali delle chiavi specificato. Un esempio è:

https://< nome-cassaforte.vault.azure.net/keys/>< nome-chiave>/<id-versione-univoco>

Durante l'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 dell'insieme di credenziali delle chiavi.

Restituisce

KeyVaultKeyIdentifier