@azure/keyvault-keys package

Klasser

CryptographyClient	En klient som används för att utföra kryptografiska åtgärder på en Azure Key Vault-nyckel eller en lokal <xref:JsonWebKey>.
KeyClient	KeyClient innehåller metoder för att hantera <xref:KeyVaultKey> i Azure Key Vault. Klienten har stöd för att skapa, hämta, uppdatera, ta bort, rensa, säkerhetskopiera, återställa och lista KeyVaultKeys. Klienten har också stöd för att lista <xref:DeletedKey> för en mjuk borttagning aktiverad Azure Key Vault.

Gränssnitt

AesCbcDecryptParameters	Dekrypteringsparametrar för AES-CBC krypteringsalgoritmer.
AesCbcEncryptParameters	Krypteringsparametrar för AES-CBC krypteringsalgoritmer.
AesGcmDecryptParameters	Dekrypteringsparametrar för AES-GCM krypteringsalgoritmer.
AesGcmEncryptParameters	Krypteringsparametrar för AES-GCM krypteringsalgoritmer.
BackupKeyOptions	Alternativ för <xref:backupKey>.
BeginDeleteKeyOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:beginDeleteKey>
BeginRecoverDeletedKeyOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:beginRecoverDeletedKey>
CreateEcKeyOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:createEcKey>
CreateKeyOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:createKey>
CreateOctKeyOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:createOctKey>
CreateRsaKeyOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:createRsaKey>
CryptographyClientOptions	De valfria parametrar som godkänts av KeyVaults CryptographyClient
CryptographyOptions	Ett gränssnitt som representerar alternativen för kryptografi-API-metoderna går du till <xref:CryptographyClient> för mer information.
DecryptOptions	Alternativ för <xref:decrypt>.
DecryptResult	Resultatet av åtgärden <xref:decrypt>.
DeletedKey	Ett gränssnitt som representerar en borttagen Key Vault-nyckel.
EncryptOptions	Alternativ för <xref:encrypt>.
EncryptResult	Resultatet av åtgärden <xref:encrypt>.
GetDeletedKeyOptions	Alternativ för <xref:getDeletedKey>.
GetKeyOptions	Alternativ för <xref:getKey>.
ImportKeyOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:importKey>
JsonWebKey	Från och med http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions	De valfria parametrar som godkänts av KeyVaults KeyClient
KeyPollerOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:beginDeleteKey> och <xref:beginRecoverDeletedKey>
KeyProperties	Ett gränssnitt som representerar egenskaperna för <xref:KeyVaultKey>
KeyVaultKey	Ett gränssnitt som representerar en Key Vault-nyckel med dess namn, värde och <xref:KeyProperties>.
KeyVaultKeyIdentifier	Representerar de segment som utgör ett Key Vault-nyckel-ID.
ListDeletedKeysOptions	Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till <xref:listDeletedKeys>.
ListPropertiesOfKeyVersionsOptions	Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till <xref:listPropertiesOfKeyVersions>.
ListPropertiesOfKeysOptions	Ett gränssnitt som representerar valfria parametrar för KeyClient-sidåtgärder som skickas till <xref:listPropertiesOfKeys>.
PurgeDeletedKeyOptions	Alternativ för <xref:purgeDeletedKey>.
RestoreKeyBackupOptions	Alternativ för <xref:restoreKeyBackup>.
RsaDecryptParameters	Dekrypteringsparametrar för RSA-krypteringsalgoritmer.
RsaEncryptParameters	Krypteringsparametrar för RSA-krypteringsalgoritmer.
SignOptions	Alternativ för <xref:sign>.
SignResult	Resultatet av åtgärden <xref:sign>.
UnwrapKeyOptions	Alternativ för <xref:unwrapKey>.
UnwrapResult	Resultatet av åtgärden <xref:unwrap>.
UpdateKeyPropertiesOptions	Alternativ för <xref:updateKeyProperties>.
VerifyDataOptions	Alternativ för <xref:verifyData>
VerifyOptions	Alternativ för <xref:verify>.
VerifyResult	Resultatet av åtgärden <xref:verify>.
WrapKeyOptions	Alternativ för <xref:wrapKey>.
WrapResult	Resultatet av åtgärden <xref:wrap>.

Typalias

AesCbcEncryptionAlgorithm	En unionstyp som representerar alla AES-CBC krypteringsalgoritmer som stöds.
AesGcmEncryptionAlgorithm	En unionstyp som representerar alla AES-GCM krypteringsalgoritmer som stöds.
DecryptParameters	En typ som representerar alla dekrypteringsparametrar som stöds för närvarande när de gäller för olika krypteringsalgoritmer.
DeletionRecoveryLevel	Definierar värden för DeletionRecoveryLevel. <xref:KnownDeletionRecoveryLevel> kan användas utbytbart med DeletionRecoveryLevel innehåller den här uppräkningen de kända värden som tjänsten stöder. Känna till värden som stöds av tjänsten Purgeable: 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 godkänns på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.) Recoverable+Purgeable: Anger ett valvtillstånd där borttagningen kan återställas och som också tillåter omedelbar och permanent borttagning (d.v.s. 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 borttagningen 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 borttagningen kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (d.v.s. rensning) är inte tillåten och där själva prenumerationen inte kan avbrytas permanent. Systemet tar bort det permanent efter 90 dagar, om det inte återställs CustomdRecoverable+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. CustomdRecoverable: 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. CustomdRecoverable+ProtectedSubscription: Anger ett valv- och prenumerationstillstånd där borttagning 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.
EncryptParameters	En typ som representerar alla krypteringsparametrar som stöds för närvarande när de gäller för olika krypteringsalgoritmer.
EncryptionAlgorithm	Definierar värden för JsonWebKeyEncryptionAlgorithm. <xref:KnownJsonWebKeyEncryptionAlgorithm> kan användas utbytbart med JsonWebKeyEncryptionAlgorithm innehåller den här uppräkningen de kända värden som tjänsten stöder. Känna till 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
KeyCurveName	Definierar värden för JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> kan användas omväxlande med JsonWebKeyCurveName innehåller den här uppräkningen de kända värden som tjänsten stöder. Känna till värden som stöds av tjänsten P-256: DEN NIST P-256 elliptiska kurvan, AKA SECG kurva SECP256R1. P-384: DEN NIST P-384 elliptiska kurvan, AKA SECG kurva SECP384R1. P-521: NIST P-521 elliptisk kurva, AKA SECG-kurva SECP521R1. P-256K: SECG-SECP256K1 elliptisk kurva.
KeyOperation	Definierar värden för JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> kan användas omväxlande med JsonWebKeyOperation innehåller den här uppräkningen de kända värden som tjänsten stöder. Känna till värden som stöds av tjänsten kryptera dekryptera signera verifiera wrapKey importera
KeyType	Definierar värden för JsonWebKeyType. <xref:KnownJsonWebKeyType> kan användas omväxlande med JsonWebKeyType innehåller den här uppräkningen de kända värden som tjänsten stöder. Känna till värden som stöds av tjänsten EC: Elliptisk kurva. EC-HSM: Elliptisk kurva med en privat nyckel som inte kan exporteras från HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA med en privat nyckel som inte kan exporteras från HSM. okt: Oktettsekvens (används för att representera symmetriska nycklar) oct-HSM: Oktettsekvens (används för att representera symmetriska nycklar) som inte kan exporteras från HSM.
KeyWrapAlgorithm	Algoritmer som stöds för nyckelomslutning/avskrivning
RsaEncryptionAlgorithm	En unionstyp som representerar alla RSA-krypteringsalgoritmer som stöds.
SignatureAlgorithm	Definierar värden för JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> kan användas utbytbart med JsonWebKeySignatureAlgorithm innehåller den här uppräkningen de kända värden som tjänsten stöder. Känna till 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

Uppräkningar

KnownDeletionRecoveryLevel	Kända värden för <xref:DeletionRecoveryLevel> som tjänsten accepterar.
KnownEncryptionAlgorithms	Kända värden för <xref:JsonWebKeyEncryptionAlgorithm> som tjänsten accepterar.
KnownKeyCurveNames	Kända värden för <xref:JsonWebKeyCurveName> som tjänsten accepterar.
KnownKeyOperations	Kända värden för <xref:JsonWebKeyOperation> som tjänsten accepterar.
KnownKeyTypes	Kända värden för <xref:JsonWebKeyType> som tjänsten accepterar.
KnownSignatureAlgorithms	Kända värden för <xref:JsonWebKeySignatureAlgorithm> som tjänsten accepterar.

Funktioner

parseKeyVaultKeyIdentifier(string)

Parsar det angivna Key Vault nyckel-ID:t. Ett exempel är: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>

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

Funktionsinformation

parseKeyVaultKeyIdentifier(string)

Parsar det angivna Key Vault nyckel-ID:t. Ett exempel är: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>

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

function parseKeyVaultKeyIdentifier(id: string)

Parametrar

id: string

ID:t för Key Vault-nyckeln.

Returer

KeyVaultKeyIdentifier

Feedback

Var den här sidan till hjälp?

Dela via

@azure/keyvault-keys package

Klasser

Gränssnitt

Typalias

Känna till värden som stöds av tjänsten

Känna till värden som stöds av tjänsten

Känna till värden som stöds av tjänsten

Känna till värden som stöds av tjänsten

Känna till värden som stöds av tjänsten

Känna till värden som stöds av tjänsten

Uppräkningar

Funktioner

Funktionsinformation

parseKeyVaultKeyIdentifier(string)

Parametrar

Returer

Feedback