Condividi tramite


@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.
<xref:KnownDeletionRecoveryLevel> possono essere usati in modo intercambiabile con DeletionRecoveryLevel, questa enumerazione contiene i valori noti supportati dal servizio.

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)
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 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

Definisce i valori per JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> può essere usato in modo intercambiabile con JsonWebKeyEncryptionAlgorithm, questa enumerazione contiene i valori noti supportati dal servizio.

Conoscere i valori 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 intercambiabile con JsonWebKeyCurveName, questa enumerazione contiene i valori noti supportati dal servizio.

Conoscere i valori 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.

KeyOperation

Definisce i valori per JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> può essere usato in modo intercambiabile con JsonWebKeyOperation, questa enumerazione contiene i valori noti supportati dal servizio.

Conoscere i valori supportati dal servizio

crittografare
decrittografare
firmare
verificare
wrapKey
unwrapKey
importare

KeyType

Definisce i valori per JsonWebKeyType.
<xref:KnownJsonWebKeyType> può essere usato in modo intercambiabile con JsonWebKeyType, questa enumerazione contiene i valori noti supportati dal servizio.

Conoscere i valori supportati dal servizio

EC: curva ellittica.
EC-HSM: curva ellittica con una chiave privata che non è esportabile dal modulo di protezione hardware.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA con una chiave privata che non è esportabile dal modulo di protezione hardware.
oct: sequenza ottetto (usata per rappresentare chiavi simmetriche)
oct-HSM: sequenza ottet (usata per rappresentare chiavi simmetriche) che non è esportabile dal 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

Definisce i valori per JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> può essere usato in modo intercambiabile con JsonWebKeySignatureAlgorithm, questa enumerazione contiene i valori noti supportati dal servizio.

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
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
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

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

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

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.

Restituisce