@azure/keyvault-keys package

En klient som används för att utföra kryptografiska åtgärder på en Azure Key Vault-nyckel eller en lokal JsonWebKey.

KeyClient tillhandahåller metoder för att hantera KeyVaultKey i Azure Key Vault. Klienten stöder skapande, hämtning, uppdatering, borttagning, rensning, säkerhetskopiering, återställning och listning av KeyVaultKeys. Klienten stöder även listning av DeletedKey för en mjuk borttagning aktiverad Azure Key Vault.

Dekrypteringsparametrar för AES-CBC-krypteringsalgoritmer.

Krypteringsparametrar för AES-CBC-krypteringsalgoritmer.

Dekrypteringsparametrar för AES-GCM-krypteringsalgoritmer.

Krypteringsparametrar för AES-GCM-krypteringsalgoritmer.

Alternativ för backupKey(string, BackupKeyOptions).

Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginDeleteKey(string, BeginDeleteKeyOptions)

Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Ett gränssnitt som representerar de valfria parametrar som kan skickas till createEcKey(string, CreateEcKeyOptions)

Ett gränssnitt som representerar de valfria parametrar som kan skickas till createKey(string, string, CreateKeyOptions)

Ett gränssnitt som representerar de valfria parametrar som kan skickas till createOctKey(string, CreateOctKeyOptions)

Ett gränssnitt som representerar de valfria parametrar som kan skickas till createRsaKey(string, CreateRsaKeyOptions)

De valfria parametrarna som accepteras av KeyVaults CryptographyClient

Ett gränssnitt som representerar alternativen för kryptografi-API-metoderna går du till CryptographyClient för mer information.

Alternativ för decrypt(DecryptParameters, DecryptOptions).

Resultatet av åtgärden decrypt(DecryptParameters, DecryptOptions) .

Ett gränssnitt som representerar en borttagen Key Vault nyckel.

Alternativ för encrypt(EncryptParameters, EncryptOptions).

Resultatet av åtgärden encrypt(EncryptParameters, EncryptOptions) .

Alternativ för getCryptographyClient.

Alternativ för getDeletedKey(string, GetDeletedKeyOptions).

Alternativ för getKey(string, GetKeyOptions).

Alternativ för <xref:KeyClient.getRotationPolicy>

Alternativ för getRandomBytes

Ett gränssnitt som representerar de valfria parametrar som kan skickas till importKey(string, JsonWebKey_2, ImportKeyOptions)

Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

De valfria parametrarna som accepteras av KeyVaults KeyClient

Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginDeleteKey(string, BeginDeleteKeyOptions) och beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Ett gränssnitt som representerar egenskaperna för KeyVaultKey

De principregler som en nyckel kan exporteras under.

En åtgärd och dess motsvarande utlösare som utförs av Key Vault under en nyckels livslängd.

Den fullständiga nyckelrotationsprincipen som tillhör en nyckel.

Egenskaperna för en nyckelroteringsprincip som klienten kan ange för en viss nyckel.

Du kan också återställa nyckelroteringsprincipen till dess standardvärden genom att ange lifetimeActions till en tom matris.

Ett gränssnitt som representerar en Key Vault-nyckel, med dess namn, värde och KeyProperties.

Representerar de segment som utgör ett Key Vault nyckel-ID.

Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till listDeletedKeys(ListDeletedKeysOptions).

Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).

Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till listPropertiesOfKeys(ListPropertiesOfKeysOptions).

Ett gränssnitt som spårar inställningarna för växlings iteration

Ett gränssnitt som tillåter asynkron iterbar iteration både till slutförande och efter sida.

PollOperationState innehåller en åsiktslista över den minsta uppsättningen egenskaper som behövs för att definiera en tidskrävande åtgärdsbestämning.

Medan Poller-klassen fungerar som den lokala kontrollmekanismen för att börja utlösa, vänta på och eventuellt avbryta en tidskrävande åtgärd, dokumenterar PollOperationState statusen för fjärråtgärden som körs länge.

Den bör uppdateras åtminstone när åtgärden startas, när den är klar och när den avbryts. Implementeringar kan dock ha valfritt annat antal egenskaper som kan uppdateras av andra orsaker.

Abstrakt representation av en poller, avsedd att exponera bara det minimala API som användaren behöver arbeta med.

Alternativ för purgeDeletedKey(string, PurgeDeletedKeyOptions).

Alternativ för releaseKey

Resultatet av åtgärden releaseKey .

Alternativ för restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Alternativ för rotateKey

Dekrypteringsparametrar för RSA-krypteringsalgoritmer.

Krypteringsparametrar för RSA-krypteringsalgoritmer.

Alternativ för sign(string, Uint8Array, SignOptions).

Resultatet av åtgärden sign(string, Uint8Array, SignOptions) .

Alternativ för unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

Resultatet av åtgärden <xref:unwrap> .

Alternativ för updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Alternativ för updateKeyRotationPolicy

Alternativ för verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Alternativ för verify(string, Uint8Array, Uint8Array, VerifyOptions).

Resultatet av åtgärden verify(string, Uint8Array, Uint8Array, VerifyOptions) .

Alternativ för wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

Resultatet av åtgärden <xref:wrap> .

En unionstyp som representerar alla AES-CBC-krypteringsalgoritmer som stöds.

En unionstyp som representerar alla AES-GCM-krypteringsalgoritmer som stöds.

En typ som representerar alla dekrypteringsparametrar som stöds för närvarande när de gäller för olika krypteringsalgoritmer.

Definierar värden för DeletionRecoveryLevel.
KnownDeletionRecoveryLevel kan användas utbytbart med DeletionRecoveryLevel, det här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Rensningsbar: Anger ett valvtillstånd där borttagning är en oåterkallelig åtgärd, utan möjlighet till återställning. Den här nivån motsvarar att inget skydd är tillgängligt mot en borttagningsåtgärd. data går oåterkalleligen förlorade när en borttagningsåtgärd accepteras på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.)
Återställningsbar+rensningsbar: Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (t.ex. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar), såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Återställningsbar: Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar) och medan prenumerationen fortfarande är tillgänglig. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Recoverable+ProtectedSubscription: Anger ett valv- och prenumerationstillstånd där borttagning kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (d.v.s. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
CustomizedRecoverable+Purgeable: Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet, såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts.
CustomizedRecoverable: Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och medan prenumerationen fortfarande är tillgänglig.
CustomizedRecoverable+ProtectedSubscription: Anger ett valv- och prenumerationstillstånd där borttagningen kan återställas, omedelbar och permanent borttagning (dvs. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent när 7<= SoftDeleteRetentionInDays < 90. Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och återspeglar även det faktum att själva prenumerationen inte kan avbrytas.

En typ som representerar alla krypteringsparametrar som stöds för närvarande när de gäller för olika krypteringsalgoritmer.

Definierar värden för JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> kan användas utbytbart med JsonWebKeyEncryptionAlgorithm, innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

RSA-OAEP
RSA-OAEP-256
RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD

Definierar värden för JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> kan användas utbytbart med JsonWebKeyCurveName, innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

P-256: NIST P-256 elliptisk kurva, AKA SECG kurva SECP256R1.
P-384: NIST P-384 elliptisk kurva, AKA SECG kurva SECP384R1.
P-521: NIST P-521 elliptisk kurva, AKA SECG kurva SECP521R1.
P-256K: SECG SECP256K1 elliptisk kurva.

Definierar värden för KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm kan användas utbytbart med KeyEncryptionAlgorithm. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

Definierar värden för JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> kan användas utbytbart med JsonWebKeyOperation, innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Kryptera
Dekryptera
Tecken
Kontrollera
wrapKey
unwrapKey
Importera
Exportera

Den åtgärd som ska utföras.

Definierar värden för JsonWebKeyType.
<xref:KnownJsonWebKeyType> kan användas synonymt med JsonWebKeyType, innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

EC: Elliptisk kurva.
EC-HSM: Elliptisk kurva med en privat nyckel som lagras i HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA med en privat nyckel som lagras i HSM.
okt: Oktettsekvens (används för att representera symmetriska nycklar)
oct-HSM: Oktettsekvens (används för att representera symmetriska nycklar) som lagras HSM.

Algoritmer som stöds för nyckelomslutning/avskrivning

En unionstyp som representerar alla RSA-krypteringsalgoritmer som stöds.

Definierar värden för JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> kan användas synonymt med JsonWebKeySignatureAlgorithm, den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

PS256: RSASSA-PSS med SHA-256 och MGF1 med SHA-256, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS med SHA-384 och MGF1 med SHA-384, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS med SHA-512 och MGF1 med SHA-512, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 med SHA-256, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 med SHA-384, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 med SHA-512, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
RSNULL: Reserverad
ES256: ECDSA med P-256 och SHA-256, enligt beskrivningen i https://tools.ietf.org/html/rfc7518.
ES384: ECDSA med P-384 och SHA-384, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
ES512: ECDSA med P-521 och SHA-512, enligt beskrivningen i https://tools.ietf.org/html/rfc7518
ES256K: ECDSA med P-256K och SHA-256, enligt beskrivningen i https://tools.ietf.org/html/rfc7518

Kända värden för DeletionRecoveryLevel som tjänsten accepterar.

Kända värden för EncryptionAlgorithm som tjänsten accepterar.

Kända värden <xref:JsonWebKeyCurveName> för som tjänsten accepterar.

Kända värden för KeyExportEncryptionAlgorithm som tjänsten accepterar.

Kända värden för KeyOperation som tjänsten accepterar.

Kända värden <xref:JsonWebKeyType> för som tjänsten accepterar.

Kända värden <xref:JsonWebKeySignatureAlgorithm> för som tjänsten accepterar.

Parsar angivet Key Vault nyckel-ID. Ett exempel är:

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

Vid parsning av ovanstående ID returnerar den här funktionen:

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