@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 <xref:JsonWebKey>locale. |
| KeyClient |
KeyClient fornisce metodi per gestire <xref: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 <xref: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 <xref:backupKey>. |
| BeginDeleteKeyOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:beginDeleteKey> |
| BeginRecoverDeletedKeyOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:beginRecoverDeletedKey> |
| CreateEcKeyOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:createEcKey> |
| CreateKeyOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:createKey> |
| CreateOctKeyOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:createOctKey> |
| CreateRsaKeyOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:createRsaKey> |
| CryptographyClientOptions |
Parametri facoltativi accettati da CryptographyClient di KeyVault |
| CryptographyOptions |
Interfaccia che rappresenta le opzioni dei metodi dell'API di crittografia, passare al <xref:CryptographyClient> per altre informazioni. |
| DecryptOptions |
Opzioni per <xref:decrypt>. |
| DecryptResult |
Risultato dell'operazione di <xref:decrypt>. |
| DeletedKey |
Interfaccia che rappresenta una chiave di Key Vault eliminata. |
| EncryptOptions |
Opzioni per <xref:encrypt>. |
| EncryptResult |
Risultato dell'operazione di <xref:encrypt>. |
| GetDeletedKeyOptions |
Opzioni per <xref:getDeletedKey>. |
| GetKeyOptions |
Opzioni per <xref:getKey>. |
| ImportKeyOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:importKey> |
| JsonWebKey |
A partire da http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
| KeyClientOptions |
Parametri facoltativi accettati da KeyClient dell'insieme di credenziali delle chiavi |
| KeyPollerOptions |
Interfaccia che rappresenta i parametri facoltativi che possono essere passati a <xref:beginDeleteKey> e <xref:beginRecoverDeletedKey> |
| KeyProperties |
Interfaccia che rappresenta le proprietà di <xref:KeyVaultKey> |
| KeyVaultKey |
Interfaccia che rappresenta una chiave dell'insieme di credenziali delle chiavi, con il nome, il valore e <xref:KeyProperties>. |
| 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 <xref:listDeletedKeys>. |
| ListPropertiesOfKeyVersionsOptions |
Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging KeyClient passate a <xref:listPropertiesOfKeyVersions>. |
| ListPropertiesOfKeysOptions |
Interfaccia che rappresenta i parametri facoltativi per le operazioni di paging KeyClient passate a <xref:listPropertiesOfKeys>. |
| PurgeDeletedKeyOptions |
Opzioni per <xref:purgeDeletedKey>. |
| RestoreKeyBackupOptions |
Opzioni per <xref:restoreKeyBackup>. |
| RsaDecryptParameters |
Parametri di decrittografia per algoritmi di crittografia RSA. |
| RsaEncryptParameters |
Parametri di crittografia per algoritmi di crittografia RSA. |
| SignOptions |
Opzioni per <xref:sign>. |
| SignResult |
Risultato dell'operazione di <xref:sign>. |
| UnwrapKeyOptions |
Opzioni per <xref:unwrapKey>. |
| UnwrapResult |
Risultato dell'operazione di <xref:unwrap>. |
| UpdateKeyPropertiesOptions |
Opzioni per <xref:updateKeyProperties>. |
| VerifyDataOptions |
Opzioni per <xref:verifyData> |
| VerifyOptions |
Opzioni per <xref:verify>. |
| VerifyResult |
Risultato dell'operazione di <xref:verify>. |
| WrapKeyOptions |
Opzioni per <xref:wrapKey>. |
| 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 |
Definisce i valori per DeletionRecoveryLevel. Conoscere i valori 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) |
| EncryptParameters |
Tipo che rappresenta tutti i parametri di crittografia attualmente supportati quando si applicano a algoritmi di crittografia diversi. |
| EncryptionAlgorithm |
Definisce i valori per JsonWebKeyEncryptionAlgorithm. Conoscere i valori supportati dal servizio
RSA-OAEP |
| KeyCurveName |
Definisce i valori per JsonWebKeyCurveName. Conoscere i valori supportati dal servizio
curva ellittica P-256: curva ellittica NIST P-256, curva AKA SECG SECP256R1. |
| KeyOperation |
Definisce i valori per JsonWebKeyOperation. Conoscere i valori supportati dal servizio
crittografare |
| KeyType |
Definisce i valori per JsonWebKeyType. Conoscere i valori supportati dal servizio
EC: curva ellittica. |
| 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 |
Definisce i valori per JsonWebKeySignatureAlgorithm. Conoscere i valori supportati dal servizio
PS256: RSASSA-PSS usando SHA-256 e MGF1 con SHA-256, come descritto in https://tools.ietf.org/html/rfc7518 |
Enumerazioni
| KnownDeletionRecoveryLevel |
Valori noti di <xref:DeletionRecoveryLevel> accettati dal servizio. |
| KnownEncryptionAlgorithms |
Valori noti di <xref:JsonWebKeyEncryptionAlgorithm> accettati dal servizio. |
| KnownKeyCurveNames |
Valori noti di <xref:JsonWebKeyCurveName> accettati dal servizio. |
| KnownKeyOperations |
Valori noti di <xref:JsonWebKeyOperation> accettati dal servizio. |
| KnownKeyTypes |
Valori noti di <xref:JsonWebKeyType> accettati dal servizio. |
| KnownSignatureAlgorithms |
Valori noti di <xref:JsonWebKeySignatureAlgorithm> accettati dal servizio. |
Funzioni
| parse |
Analizza l'ID chiave dell'insieme di credenziali delle chiavi specificato. Un esempio è: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id> Durante l'analisi dell'ID precedente, questa funzione restituisce:
|
Dettagli funzione
parseKeyVaultKeyIdentifier(string)
Analizza l'ID chiave dell'insieme di credenziali delle chiavi specificato. Un esempio è: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>
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)
Parametri
- id
-
string
ID della chiave dell'insieme di credenziali delle chiavi.