@azure/keyvault-keys package

Třídy

CryptographyClient	Klient používaný k provádění kryptografických operací s klíčem služby Azure Key Vault nebo místním <xref:JsonWebKey>.
KeyClient	KeyClient poskytuje metody pro správu <xref:KeyVaultKey> ve službě Azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, mazání, zálohování, obnovení a výpis klíčů KeyVaultKeys. Klient také podporuje výpis <xref:DeletedKey> pro obnovitelné odstranění povolené služby Azure Key Vault.

Rozhraní

AesCbcDecryptParameters	Parametry dešifrování pro šifrovací algoritmy AES-CBC
AesCbcEncryptParameters	Parametry šifrování pro šifrovací algoritmy AES-CBC
AesGcmDecryptParameters	Parametry dešifrování pro šifrovací algoritmy AES-GCM
AesGcmEncryptParameters	Parametry šifrování pro šifrovací algoritmy AES-GCM
BackupKeyOptions	Možnosti pro <xref:backupKey>.
BeginDeleteKeyOptions	Rozhraní představující volitelné parametry, které lze předat <xref:beginDeleteKey>
BeginRecoverDeletedKeyOptions	Rozhraní představující volitelné parametry, které lze předat <xref:beginRecoverDeletedKey>
CreateEcKeyOptions	Rozhraní představující volitelné parametry, které lze předat <xref:createEcKey>
CreateKeyOptions	Rozhraní představující volitelné parametry, které lze předat <xref:createKey>
CreateOctKeyOptions	Rozhraní představující volitelné parametry, které lze předat <xref:createOctKey>
CreateRsaKeyOptions	Rozhraní představující volitelné parametry, které lze předat <xref:createRsaKey>
CryptographyClientOptions	Volitelné parametry akceptované kryptografickým klientem služby KeyVault
CryptographyOptions	Rozhraní představující možnosti metod rozhraní API kryptografie, přejděte na <xref:CryptographyClient> další informace.
DecryptOptions	Možnosti pro <xref:decrypt>.
DecryptResult	Výsledek operace <xref:decrypt>
DeletedKey	Rozhraní představující odstraněný klíč služby Key Vault.
EncryptOptions	Možnosti pro <xref:encrypt>.
EncryptResult	Výsledek operace <xref:encrypt>
GetDeletedKeyOptions	Možnosti pro <xref:getDeletedKey>.
GetKeyOptions	Možnosti pro <xref:getKey>.
ImportKeyOptions	Rozhraní představující volitelné parametry, které lze předat <xref:importKey>
JsonWebKey	Od http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions	Volitelné parametry akceptované keyClient služby KeyClient služby KeyVault
KeyPollerOptions	Rozhraní představující volitelné parametry, které lze předat <xref:beginDeleteKey> a <xref:beginRecoverDeletedKey>
KeyProperties	Rozhraní představující vlastnosti <xref:KeyVaultKey>
KeyVaultKey	Rozhraní představující klíč služby Key Vault s názvem, hodnotou a <xref:KeyProperties>.
KeyVaultKeyIdentifier	Představuje segmenty, které tvoří ID klíče služby Key Vault.
ListDeletedKeysOptions	Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané <xref:listDeletedKeys>.
ListPropertiesOfKeyVersionsOptions	Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané <xref:listPropertiesOfKeyVersions>.
ListPropertiesOfKeysOptions	Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané <xref:listPropertiesOfKeys>.
PurgeDeletedKeyOptions	Možnosti pro <xref:purgeDeletedKey>.
RestoreKeyBackupOptions	Možnosti pro <xref:restoreKeyBackup>.
RsaDecryptParameters	Dešifrovací parametry pro šifrovací algoritmy RSA.
RsaEncryptParameters	Parametry šifrování pro šifrovací algoritmy RSA
SignOptions	Možnosti pro <xref:sign>.
SignResult	Výsledek operace <xref:sign>
UnwrapKeyOptions	Možnosti pro <xref:unwrapKey>.
UnwrapResult	Výsledek operace <xref:unwrap>
UpdateKeyPropertiesOptions	Možnosti pro <xref:updateKeyProperties>.
VerifyDataOptions	Možnosti pro <xref:verifyData>
VerifyOptions	Možnosti pro <xref:verify>.
VerifyResult	Výsledek operace <xref:verify>
WrapKeyOptions	Možnosti pro <xref:wrapKey>.
WrapResult	Výsledek operace <xref:wrap>

Aliasy typu

AesCbcEncryptionAlgorithm	Typ sjednocení představující všechny podporované AES-CBC šifrovací algoritmy.
AesGcmEncryptionAlgorithm	Typ sjednocení představující všechny podporované AES-GCM šifrovací algoritmy.
DecryptParameters	Typ představující všechny aktuálně podporované parametry dešifrování, protože se vztahují na různé šifrovací algoritmy.
DeletionRecoveryLevel	Definuje hodnoty pro DeletionRecoveryLevel. <xref:KnownDeletionRecoveryLevel> lze použít zaměnitelně s DeletionRecoveryLevel, tento výčet obsahuje známé hodnoty, které služba podporuje. Znalost hodnot podporovaných službou vyprázdnění: Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde ke ztrátě dat. Obnovitelné+vyprázdnitelné: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů), pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. Obnovitelné: Označuje stav trezoru, ve kterém je odstranění možné obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. Obnovitelné +ProtectedSubscription: Označuje trezor a stav předplatného, ve kterém je odstranění možné obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vyprázdnění) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. CustomizedRecoverable+Purgeable: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vymazání, když 7<= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Vlastní: Označuje stav trezoru, ve kterém se odstranění dá obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění, když 7<= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a v době, kdy je předplatné stále dostupné. CustomizedRecoverable+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém je odstranění možné obnovit, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, když 7<= SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a také odráží skutečnost, že samotné předplatné nelze zrušit.
EncryptParameters	Typ představující všechny aktuálně podporované parametry šifrování, protože se vztahují na různé šifrovací algoritmy.
EncryptionAlgorithm	Definuje hodnoty pro JsonWebKeyEncryptionAlgorithm. <xref:KnownJsonWebKeyEncryptionAlgorithm> lze zaměnitelně s JsonWebKeyEncryptionAlgorithm, tento výčet obsahuje známé hodnoty, které služba podporuje. Znalost hodnot podporovaných službou RSA-OAEP RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	Definuje hodnoty jsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> lze použít zaměnitelně s JsonWebKeyCurveName, tento výčet obsahuje známé hodnoty, které služba podporuje. Znalost hodnot podporovaných službou P-256: elliptická křivka NIST P-256, křivka AKA SECG SECP256R1. P-384: elliptická křivka NIST P-384, křivka AKA SECG SECP384R1. P-521: elliptická křivka NIST P-521, křivka AKA SECG SECP521R1. P-256K: SECG SECP256K1 tři tečky.
KeyOperation	Definuje hodnoty pro JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> lze zaměnitelně s JsonWebKeyOperation, tento výčet obsahuje známé hodnoty, které služba podporuje. Znalost hodnot podporovaných službou šifrování dešifrování znaménko ověření wrapKey rozbalení klíče importu
KeyType	Definuje hodnoty jsonWebKeyType. <xref:KnownJsonWebKeyType> lze použít zaměnitelně s JsonWebKeyType, tento výčet obsahuje známé hodnoty, které služba podporuje. Znalost hodnot podporovaných službou EC: elliptická křivka. EC-HSM: Tři tečky křivky s privátním klíčem, který není možné exportovat z HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA s privátním klíčem, který nejde exportovat z MODULU HARDWAROVÉHO ZABEZPEČENÍ. osmičkové: sekvence octetu (použitá k reprezentaci symetrických klíčů) oct-HSM: Sekvence octetu (použitá k reprezentaci symetrických klíčů), která se nedá exportovat z HSM.
KeyWrapAlgorithm	Podporované algoritmy pro zabalení nebo rozbalení klíče
RsaEncryptionAlgorithm	Typ sjednocení představující všechny podporované šifrovací algoritmy RSA.
SignatureAlgorithm	Definuje hodnoty jsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> lze použít zaměnitelně s JsonWebKeySignatureAlgorithm, tento výčet obsahuje známé hodnoty, které služba podporuje. Znalost hodnot podporovaných službou PS256: RSASSA-PSS pomocí SHA-256 a MGF1 s SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS pomocí SHA-384 a MGF1 s SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS pomocí SHA-512 a MGF1 s SHA-512, jak je popsáno v https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 pomocí SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 pomocí SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 pomocí SHA-512, jak je popsáno v https://tools.ietf.org/html/rfc7518 RSNULL: Vyhrazeno ES256: ECDSA používající P-256 a SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518. ES384: ECDSA používající P-384 a SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518 ES512: ECDSA používající P-521 a SHA-512, jak je popsáno v https://tools.ietf.org/html/rfc7518 ES256K: ECDSA s využitím P-256K a SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518

Výčty

KnownDeletionRecoveryLevel	Známé hodnoty <xref:DeletionRecoveryLevel>, které služba přijímá.
KnownEncryptionAlgorithms	Známé hodnoty <xref:JsonWebKeyEncryptionAlgorithm>, které služba přijímá.
KnownKeyCurveNames	Známé hodnoty <xref:JsonWebKeyCurveName>, které služba přijímá.
KnownKeyOperations	Známé hodnoty <xref:JsonWebKeyOperation>, které služba přijímá.
KnownKeyTypes	Známé hodnoty <xref:JsonWebKeyType>, které služba přijímá.
KnownSignatureAlgorithms	Známé hodnoty <xref:JsonWebKeySignatureAlgorithm>, které služba přijímá.

Funkce

parseKeyVaultKeyIdentifier(string)

Analyzuje dané ID klíče trezoru klíčů. Příklad: https://< název-trezoru.vault.azure.net/keys/>< název-klíče/><id_jedinečné-verze-> Při analýze výše uvedeného ID vrátí tato funkce: { 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>" }

Podrobnosti funkce

parseKeyVaultKeyIdentifier(string)

Analyzuje dané ID klíče trezoru klíčů. Příklad: https://< název-trezoru.vault.azure.net/keys/>< název-klíče/><id_jedinečné-verze->

Při analýze výše uvedeného ID vrátí tato funkce:

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

Parametry

id

string

ID klíče služby Key Vault.

Návraty

KeyVaultKeyIdentifier