@azure/keyvault-keys package

Előkelő társaság

CryptographyClient	Az Azure Key Vault-kulcson vagy egy helyi JsonWebKeyvégzett titkosítási műveletekhez használt ügyfél.
KeyClient	A KeyClient metódusokat biztosít KeyVaultKey kezeléséhez az Azure Key Vaultban. Az ügyfél támogatja a KeyVaultKeys létrehozását, lekérését, frissítését, törlését, törlését, biztonsági mentését, visszaállítását és listázását. Az ügyfél emellett támogatja a DeletedKey listázását a helyreállítható törlést engedélyező Azure Key Vaulthoz.

Felületek

AesCbcDecryptParameters	AES-CBC titkosítási algoritmusok visszafejtési paraméterei.
AesCbcEncryptParameters	Titkosítási paraméterek AES-CBC titkosítási algoritmusokhoz.
AesGcmDecryptParameters	AES-GCM titkosítási algoritmusok visszafejtési paraméterei.
AesGcmEncryptParameters	Titkosítási paraméterek AES-GCM titkosítási algoritmusokhoz.
BackupKeyOptions	A backupKey(string, BackupKeyOptions)beállításai.
BeginDeleteKeyOptions	A beginDeleteKey(string, BeginDeleteKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
BeginRecoverDeletedKeyOptions	A beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
CreateEcKeyOptions	A createEcKey(string, CreateEcKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
CreateKeyOptions	A createKey(string, string, CreateKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
CreateOctKeyOptions	A createOctKey(string, CreateOctKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
CreateRsaKeyOptions	A createRsaKey(string, CreateRsaKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
CryptographyClientOptions	A KeyVault CryptographyClient által elfogadott választható paraméterek
CryptographyOptions	A titkosítási API-metódusok lehetőségeit képviselő felület további információért lépjen a CryptographyClient.
DecryptOptions	A decrypt(DecryptParameters, DecryptOptions)beállításai.
DecryptResult	A decrypt(DecryptParameters, DecryptOptions) művelet eredménye.
DeletedKey	Törölt Key Vault-kulcsot jelképező felület.
EncryptOptions	A encrypt(EncryptParameters, EncryptOptions)beállításai.
EncryptResult	A encrypt(EncryptParameters, EncryptOptions) művelet eredménye.
GetCryptographyClientOptions	A getCryptographyClientbeállításai.
GetDeletedKeyOptions	A getDeletedKey(string, GetDeletedKeyOptions)beállításai.
GetKeyAttestationOptions	A getKeyAttestation(string, GetKeyAttestationOptions)beállításai.
GetKeyOptions	A getKey(string, GetKeyOptions)beállításai.
GetKeyRotationPolicyOptions	A <xref:KeyClient.getRotationPolicy> beállításai
GetRandomBytesOptions	A getRandomBytes beállításai
ImportKeyOptions	A importKey(string, JsonWebKey, ImportKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
JsonWebKey	http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyAttestation	Egy kulcs igazolásának tulajdonságait képviselő felület
KeyClientOptions	A KeyVault KeyClient által elfogadott választható paraméterek
KeyPollerOptions	A beginDeleteKey(string, BeginDeleteKeyOptions) és beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) számára továbbítható opcionális paramétereket képviselő felület
KeyProperties	A KeyVaultKey tulajdonságainak
KeyReleasePolicy	Azok a szabályzatszabályok, amelyek alapján a kulcs exportálható.
KeyRotationLifetimeAction	Egy műveletet és annak megfelelő eseményindítóját, amelyet a Key Vault egy kulcs élettartama alatt hajt végre.
KeyRotationPolicy	A kulcshoz tartozó teljes kulcsforgatási szabályzat.
KeyRotationPolicyProperties	Egy kulcsforgatási szabályzat tulajdonságai, amelyeket az ügyfél beállíthat egy adott kulcshoz. A kulcsforgatási szabályzatot az alapértelmezett értékre is visszaállíthatja a lifetimeActions üres tömbre való beállításával.
KeyVaultKey	Egy Key Vault-kulcsot jelképező felület, amelynek neve, értéke és KeyProperties.
KeyVaultKeyIdentifier	A Key Vault kulcsazonosítóját alkotó szegmenseket jelöli.
ListDeletedKeysOptions	Az listDeletedKeys(ListDeletedKeysOptions)átadott KeyClient-lapozott műveletek opcionális paramétereit képviselő felület.
ListPropertiesOfKeyVersionsOptions	Az listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)átadott KeyClient-lapozott műveletek opcionális paramétereit képviselő felület.
ListPropertiesOfKeysOptions	Az listPropertiesOfKeys(ListPropertiesOfKeysOptions)átadott KeyClient-lapozott műveletek opcionális paramétereit képviselő felület.
PageSettings	Egy felület, amely nyomon követi a lapozott iteráció beállításait
PagedAsyncIterableIterator	Egy felület, amely lehetővé teszi az aszinkron iterálást mind a befejezésig, mind az oldal szerint.
PollOperationState	A PollOperationState a hosszú ideig futó művelet pollerének meghatározásához szükséges legkisebb tulajdonságkészlet véleményezett listáját tartalmazza. Bár a Poller osztály helyi vezérlő mechanizmusként működik egy hosszú ideig futó művelet elindításához, várakozásához és esetleges megszakításához, a PollOperationState dokumentálja a távoli, hosszú ideig futó művelet állapotát. Legalább akkor kell frissíteni, amikor a művelet elkezdődik, amikor befejeződött, és ha a művelet megszakadt. Az implementációk azonban bármilyen más okból frissíthető tulajdonsággal rendelkezhetnek.
PollerLike	A poller absztrakt ábrázolása, amelynek célja, hogy a felhasználónak csak a minimális API-t tegye elérhetővé.
PurgeDeletedKeyOptions	A purgeDeletedKey(string, PurgeDeletedKeyOptions)beállításai.
ReleaseKeyOptions	A releaseKey beállításai
ReleaseKeyResult	A releaseKey művelet eredménye.
RestoreKeyBackupOptions	A restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)beállításai.
RotateKeyOptions	Az forgatókulcs- beállításai
RsaDecryptParameters	Az RSA titkosítási algoritmusok visszafejtési paraméterei.
RsaEncryptParameters	Az RSA titkosítási algoritmusok titkosítási paraméterei.
SignOptions	A sign(string, Uint8Array, SignOptions)beállításai.
SignResult	A sign(string, Uint8Array, SignOptions) művelet eredménye.
UnwrapKeyOptions	A unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)beállításai.
UnwrapResult	A <xref:unwrap> művelet eredménye.
UpdateKeyPropertiesOptions	A updateKeyProperties(string, string, UpdateKeyPropertiesOptions)beállításai.
UpdateKeyRotationPolicyOptions	Az updateKeyRotationPolicy beállításai
VerifyDataOptions	A verifyData(string, Uint8Array, Uint8Array, VerifyOptions) beállításai
VerifyOptions	A verify(string, Uint8Array, Uint8Array, VerifyOptions)beállításai.
VerifyResult	A verify(string, Uint8Array, Uint8Array, VerifyOptions) művelet eredménye.
WrapKeyOptions	A wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)beállításai.
WrapResult	A <xref:wrap> művelet eredménye.

Típus-aliasok

AesCbcEncryptionAlgorithm	Az összes támogatott AES-CBC titkosítási algoritmust képviselő egyesítő típus.
AesGcmEncryptionAlgorithm	Az összes támogatott AES-GCM titkosítási algoritmust képviselő egyesítő típus.
DecryptParameters	Az összes jelenleg támogatott visszafejtési paramétert képviselő típus, amely különböző titkosítási algoritmusokra vonatkozik.
DeletionRecoveryLevel	Az aktuális tárolóban lévő tanúsítványok törlési helyreállítási szintjét tükrözi. Ha "Törölhető" értéket tartalmaz, a tanúsítványt véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a tanúsítványt a megőrzési időköz végén. KnownDeletionRecoveryLevel felcserélhető a DeletionRecoveryLeveltel, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a törlési műveletekkel szembeni védelemnek; az adatok helyrehozhatatlanul elvesznek, ha egy törlési műveletet az entitás szintjén vagy annál magasabb szinten fogadnak el (tároló, erőforráscsoport, előfizetés stb.) Helyreállítható+Helyreállítható: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a törlést). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre (azaz törlésre) van lehetőség. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak (90 nap) alatt, és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre Recoveryable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés megőrzési idő (90 nap) alatt helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre CustomizedRecoverable+Purgeable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést is (azaz 7 <= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. CustomizedRecoverable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre van lehetőség (azaz 7 <= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és amíg az előfizetés továbbra is elérhető. CustomizedRecoverable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen, amikor 7 <= SoftDeleteRetentionInDays < 90. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és azt is tükrözi, hogy maga az előfizetés nem törölhető.
EncryptParameters	Az összes jelenleg támogatott titkosítási paramétert képviselő típus, amely a különböző titkosítási algoritmusokra vonatkozik.
EncryptionAlgorithm	Titkosításhoz és visszafejtéshez használt algoritmus. <xref:KnownJsonWebKeyEncryptionAlgorithm> a JsonWebKeyEncryptionAlgorithm használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek RSA-OAEP: [Nem ajánlott] Az RSAES az optimális aszimmetrikus titkosítási padding (OAEP) használatával, a https://tools.ietf.org/html/rfc3447leírtak szerint, az RFC 3447 által az A.2.1 szakaszban megadott alapértelmezett paraméterekkel. Ezek az alapértelmezett paraméterek az SHA-1 kivonatfüggvényét és az MGF1 és az SHA-1 maszkgenerálási függvényét használják. A Microsoft RSA_OAEP_256 vagy erősebb algoritmusok használatát javasolja a fokozott biztonság érdekében. A Microsoft nem javasolja RSA_OAEP, amely kizárólag a visszamenőleges kompatibilitás érdekében érhető el. RSA_OAEP sha1-et használ, amely ismert ütközési problémákkal rendelkezik. RSA-OAEP-256: AZ RSAES az optimális aszimmetrikus titkosítási paddingot használja az SHA-256 kivonatfüggvényével és az MGF1 maszkgenerálási funkciójával SHA-256-tal. RSA1_5: [Nem ajánlott] RSAES-PKCS1-V1_5 kulcstitkosítás, a https://tools.ietf.org/html/rfc3447. A Microsoft RSA_OAEP_256 vagy erősebb algoritmusok használatát javasolja a fokozott biztonság érdekében. A Microsoft nem javasolja a RSA_1_5, amely kizárólag a visszamenőleges kompatibilitás érdekében érhető el. A titkosítási szabványok már nem veszik figyelembe az RSA-t a titkosításhoz biztonságos PKCS#1 v1.5 párnázási sémával. A128GCM: 128 bites AES-GCM. A192GCM: 192 bites AES-GCM. A256GCM: 256 bites AES-GCM. A128KW: 128 bites AES-kulcsburkolás. A192KW: 192 bites AES-kulcsburkolás. A256KW: 256 bites AES kulcsburkolás. A128CBC: 128 bites AES-CBC. A192CBC: 192 bites AES-CBC. A256CBC: 256 bites AES-CBC. A128CBCPAD: 128 bites AES-CBC PKCS-párnázással. A192CBCPAD: 192 bites AES-CBC PKCS-párnázással. A256CBCPAD: 256 bites AES-CBC PKCS-párnázással. CKM_AES_KEY_WRAP: CKM AES kulcsburkolás. CKM_AES_KEY_WRAP_PAD: CKM AES kulcsburkolás párnával.
KeyCurveName	Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> a JsonWebKeyCurveName használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek P-256: A NIST P-256 háromliptikus görbe, AKA SECG-görbe SECP256R1. P-384: Az NIST P-384 háromliptikus görbe, az AKA SECG-görbe SECP384R1. P-521: A NIST P-521 háromliptikus görbe, AKA SECG-görbe SECP521R1. P-256K: A SECG SECP256K1 háromliptikus görbe.
KeyExportEncryptionAlgorithm	A KeyEncryptionAlgorithm értékeit határozza meg. KnownKeyExportEncryptionAlgorithm a KeyEncryptionAlgorithm használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	JSON-webkulcs-műveletek. További információ: JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> a JsonWebKeyOperation használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek titkosítási: Azt jelzi, hogy a kulcs használható a titkosításhoz. visszafejtési: Azt jelzi, hogy a kulcs használható a visszafejtéshez. aláírási: Azt jelzi, hogy a kulcs használható az aláíráshoz. ellenőrzése: Azt jelzi, hogy a kulcs használható az ellenőrzéshez. wrapKey: Azt jelzi, hogy a kulcs használható egy másik kulcs körbefuttatására. unwrapKey: Azt jelzi, hogy a kulcs egy másik kulcs kibontására használható. importálási: Azt jelzi, hogy a kulcs importálható a létrehozás során. exportálási: Azt jelzi, hogy a kulcs privát összetevője exportálható.
KeyRotationPolicyAction	A végrehajtandó művelet.
KeyType	JsonWebKey kulcstípus (kty), a https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. <xref:KnownJsonWebKeyType> a JsonWebKeyType használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek EC: Elliptikus görbe. EC-HSM: Elliptikus görbe a HSM-ben tárolt titkos kulccsal. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: A HSM-ben tárolt titkos kulccsal rendelkező RSA. okt.: Oktet sorozat (szimmetrikus kulcsok ábrázolására szolgál) okt-HSM: A HSM-ben tárolt oktett-sorozat (szimmetrikus kulcsok ábrázolására szolgál).
KeyWrapAlgorithm	Támogatott algoritmusok kulcsburkoláshoz/törléshez
RsaEncryptionAlgorithm	Az összes támogatott RSA-titkosítási algoritmust képviselő egyesítő típus.
SignatureAlgorithm	Az aláíró/ellenőrző algoritmus azonosítója. További információ a lehetséges algoritmustípusokról: JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> a JsonWebKeySignatureAlgorithm használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek PS256: RSASSA-PSS SHA-256 és MGF1 sha-256 használatával, a https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS SHA-384 és MGF1 sha-384 használatával, a https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS SHA-512 és MGF1 sha-512 használatával, a https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 SHA-256 használatával, a https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 SHA-384 használatával, a https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 SHA-512 használatával, a https://tools.ietf.org/html/rfc7518 HS256: HMAC sha-256 használatával, a https://tools.ietf.org/html/rfc7518 HS384: HMAC az SHA-384 használatával, az https://tools.ietf.org/html/rfc7518 HS512: HMAC az SHA-512 használatával, a https://tools.ietf.org/html/rfc7518 RSNULL: Fenntartott ES256: ECDSA p-256 és SHA-256 használatával, a https://tools.ietf.org/html/rfc7518. ES384: ECDSA p-384 és SHA-384 használatával, a https://tools.ietf.org/html/rfc7518 ES512: ECDSA p-521 és SHA-512 használatával, a https://tools.ietf.org/html/rfc7518 ES256K: ECDSA p-256K és SHA-256 használatával, a https://tools.ietf.org/html/rfc7518

Enums

KnownDeletionRecoveryLevel	Az aktuális tárolóban lévő tanúsítványok törlési helyreállítási szintjét tükrözi. Ha "Törölhető" értéket tartalmaz, a tanúsítványt véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a tanúsítványt a megőrzési időköz végén.
KnownEncryptionAlgorithms	Titkosításhoz és visszafejtéshez használt algoritmus.
KnownKeyCurveNames	Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName.
KnownKeyExportEncryptionAlgorithm	Az exportált kulcsok védelmére használható titkosítási algoritmus
KnownKeyOperations	A szolgáltatás által elfogadott KeyOperation ismert értékei.
KnownKeyTypes	JsonWebKey kulcstípus (kty), a https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KnownSignatureAlgorithms	Az aláíró/ellenőrző algoritmus azonosítója. További információ a lehetséges algoritmustípusokról: JsonWebKeySignatureAlgorithm.

Functions

parseKeyVaultKeyIdentifier(string)

Elemzi a megadott Key Vault-kulcsazonosítót. Ilyen például a következő: https://< kulcstartó-neve.vault.azure.net/keys/>< kulcsnév>/<egyedi-verzió-azonosító> A fenti azonosító elemzésekor a függvény a következőt adja vissza: { 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>" }

Változók

logger

A @azure/logger csomag konfigurációja.

Funkciók részletei

parseKeyVaultKeyIdentifier(string)

Elemzi a megadott Key Vault-kulcsazonosítót. Ilyen például a következő:

https://< kulcstartó-neve.vault.azure.net/keys/>< kulcsnév>/<egyedi-verzió-azonosító>

A fenti azonosító elemzésekor a függvény a következőt adja vissza:

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

Paraméterek

id

string

A Key Vault-kulcs azonosítója.

Visszatér

KeyVaultKeyIdentifier

Variable Details

logger

A @azure/logger csomag konfigurációja.

logger: AzureLogger

Típus

AzureLogger