@azure/keyvault-keys package

Sınıflar

CryptographyClient	Azure Key Vault anahtarında veya yerel bir JsonWebKeyüzerinde şifreleme işlemleri gerçekleştirmek için kullanılan bir istemci.
KeyClient	KeyClient, Azure Key Vault'ta KeyVaultKey yönetmek için yöntemler sağlar. İstemci KeyVaultKeys oluşturma, alma, güncelleştirme, silme, temizleme, yedekleme, geri yükleme ve listelemeyi destekler. İstemci ayrıca geçici silme özelliği etkinleştirilmiş Azure Key Vault için DeletedKey listelemeyi de destekler.

Arabirimler

AesCbcDecryptParameters	AES-CBC şifreleme algoritmaları için şifre çözme parametreleri.
AesCbcEncryptParameters	AES-CBC şifreleme algoritmaları için şifreleme parametreleri.
AesGcmDecryptParameters	AES-GCM şifreleme algoritmaları için şifre çözme parametreleri.
AesGcmEncryptParameters	AES-GCM şifreleme algoritmaları için şifreleme parametreleri.
BackupKeyOptions	backupKey(string, BackupKeyOptions)seçenekleri.
BeginDeleteKeyOptions	beginDeleteKey(string, BeginDeleteKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
BeginRecoverDeletedKeyOptions	beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CreateEcKeyOptions	createEcKey(string, CreateEcKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CreateKeyOptions	createKey(string, string, CreateKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CreateOctKeyOptions	createOctKey(string, CreateOctKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CreateRsaKeyOptions	createRsaKey(string, CreateRsaKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
CryptographyClientOptions	KeyVault'un CryptographyClient tarafından kabul edilen isteğe bağlı parametreler
CryptographyOptions	Şifreleme API'sinin yöntemlerinin seçeneklerini temsil eden bir arabirim, daha fazla bilgi için CryptographyClient gidin.
DecryptOptions	decrypt(DecryptParameters, DecryptOptions)seçenekleri.
DecryptResult	decrypt(DecryptParameters, DecryptOptions) işleminin sonucu.
DeletedKey	Silinmiş bir Key Vault Anahtarını temsil eden arabirim.
EncryptOptions	encrypt(EncryptParameters, EncryptOptions)seçenekleri.
EncryptResult	encrypt(EncryptParameters, EncryptOptions) işleminin sonucu.
GetCryptographyClientOptions	getCryptographyClientseçenekleri.
GetDeletedKeyOptions	getDeletedKey(string, GetDeletedKeyOptions)seçenekleri.
GetKeyAttestationOptions	getKeyAttestation(string, GetKeyAttestationOptions)seçenekleri.
GetKeyOptions	getKey(string, GetKeyOptions)seçenekleri.
GetKeyRotationPolicyOptions	<xref:KeyClient.getRotationPolicy> seçenekleri
GetRandomBytesOptions	getRandomBytes seçenekleri
ImportKeyOptions	importKey(string, JsonWebKey, ImportKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
JsonWebKey	http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 itibariyle
KeyAttestation	Anahtarın kanıtlama özelliklerini temsil eden arabirim
KeyClientOptions	KeyVault'un KeyClient tarafından kabul edilen isteğe bağlı parametreler
KeyPollerOptions	beginDeleteKey(string, BeginDeleteKeyOptions) ve beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim
KeyProperties	KeyVaultKey Özelliklerini temsil eden arabirim
KeyReleasePolicy	Anahtarın dışarı aktarılabildiği ilke kuralları.
KeyRotationLifetimeAction	Key Vault tarafından bir anahtarın ömrü boyunca gerçekleştirilecek bir eylem ve buna karşılık gelen tetikleyici.
KeyRotationPolicy	Bir anahtara ait tam anahtar döndürme ilkesi.
KeyRotationPolicyProperties	İstemcinin belirli bir anahtar için ayarlayabileceğiniz anahtar döndürme ilkesinin özellikleri. Ayrıca lifetimeActions değerini boş bir diziye ayarlayarak anahtar döndürme ilkesini varsayılan değerlerine sıfırlayabilirsiniz.
KeyVaultKey	Key Vault Anahtarını temsil eden, adı, değeri ve KeyPropertiesile bir arabirim.
KeyVaultKeyIdentifier	Key Vault Anahtar Kimliği oluşturan kesimleri temsil eder.
ListDeletedKeysOptions	listDeletedKeys(ListDeletedKeysOptions)'a geçirilen KeyClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
ListPropertiesOfKeyVersionsOptions	listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)'a geçirilen KeyClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
ListPropertiesOfKeysOptions	listPropertiesOfKeys(ListPropertiesOfKeysOptions)'a geçirilen KeyClient disk belleği işlemleri için isteğe bağlı parametreleri temsil eden bir arabirim.
PageSettings	Sayfalanmış yineleme ayarlarını izleyen bir arabirim
PagedAsyncIterableIterator	Zaman uyumsuz yinelenebilir yinelemeye hem tamamlamaya hem de sayfaya izin veren bir arabirim.
PollOperationState	PollOperationState, uzun süre çalışan işlem poller'lerini tanımlamak için gereken en küçük özellik kümesinin fikirli bir listesini içerir. Poller sınıfı, uzun süre çalışan bir işlemi tetiklemeye, beklemeye ve potansiyel olarak iptal etmeye yönelik yerel denetim mekanizması olarak çalışsa da PollOperationState, uzak uzun süre çalışan işlemin durumunu belgeler. En azından işlem başladığında, tamamlandığında ve iptal edildiğinde güncelleştirilmelidir. Ancak, uygulamalar başka nedenlerle güncelleştirilebilecek başka sayıda özelliğe sahip olabilir.
PollerLike	Kullanıcının çalışması gereken en düşük API'yi kullanıma sunma amaçlı bir poller'in soyut gösterimi.
PurgeDeletedKeyOptions	purgeDeletedKey(string, PurgeDeletedKeyOptions)seçenekleri.
ReleaseKeyOptions	releaseKey seçenekleri
ReleaseKeyResult	releaseKey işleminin sonucu.
RestoreKeyBackupOptions	restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)seçenekleri.
RotateKeyOptions	rotateKey seçenekleri
RsaDecryptParameters	RSA şifreleme algoritmaları için şifre çözme parametreleri.
RsaEncryptParameters	RSA şifreleme algoritmaları için şifreleme parametreleri.
SignOptions	sign(string, Uint8Array, SignOptions)seçenekleri.
SignResult	sign(string, Uint8Array, SignOptions) işleminin sonucu.
UnwrapKeyOptions	unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)seçenekleri.
UnwrapResult	<xref:unwrap> işleminin sonucu.
UpdateKeyPropertiesOptions	updateKeyProperties(string, string, UpdateKeyPropertiesOptions)seçenekleri.
UpdateKeyRotationPolicyOptions	updateKeyRotationPolicy seçenekleri
VerifyDataOptions	verifyData(string, Uint8Array, Uint8Array, VerifyOptions) seçenekleri
VerifyOptions	verify(string, Uint8Array, Uint8Array, VerifyOptions)seçenekleri.
VerifyResult	verify(string, Uint8Array, Uint8Array, VerifyOptions) işleminin sonucu.
WrapKeyOptions	wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)seçenekleri.
WrapResult	<xref:wrap> işleminin sonucu.

Tür Diğer Adları

AesCbcEncryptionAlgorithm	Desteklenen tüm AES-CBC şifreleme algoritmalarını temsil eden birleşim türü.
AesGcmEncryptionAlgorithm	Desteklenen tüm AES-GCM şifreleme algoritmalarını temsil eden birleşim türü.
DecryptParameters	Şu anda desteklenen tüm şifre çözme parametrelerini farklı şifreleme algoritmalarına uygulandığında temsil eden bir tür.
DeletionRecoveryLevel	Geçerli kasadaki sertifikalar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa, sertifika ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, bekletme aralığının sonunda sertifikayı yalnızca sistem temizleyebilir. KnownDeletionRecoveryLevel, DeletionRecoveryLevel ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler Temizlenebilir: Kurtarma olanağı olmadan silme işleminin geri alınamaz bir işlem olduğu kasa durumunu belirtir. Bu düzey, silme işlemine karşı kullanılabilir koruma olmamasına karşılık gelir; Varlık düzeyinde veya daha yüksek bir düzeyde (kasa, kaynak grubu, abonelik vb.) silme işlemi kabul edildikten sonra veriler kurtarılamaz şekilde kaybolur. Recoverable+Purgeable: Silmenin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye (temizleme) izin veren bir kasa durumunu belirtir. Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama aralığı (90 gün) boyunca silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler Kurtarılabilir: Silme işleminin anında ve kalıcı silme (temizleme) olasılığı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir. Bu düzey, saklama aralığı (90 gün) boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler Recoverable+ProtectedSubscription: Silme işleminin saklama aralığı (90 gün) içinde kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemeyeceği bir kasayı ve abonelik durumunu belirtir. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler CustomizedRecoverable+Purgeable: Silmenin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (örneğin, 7 <= SoftDeleteRetentionInDays < 90). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder. CustomizedRecoverable: Silme işleminin anında ve kalıcı silme olanağı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir (örneğin, 7 <= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, saklama aralığı boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder. CustomizedRecoverable+ProtectedSubscription: 90 < 7 <= SoftDeleteRetentionInDays olduğunda silinmeye izin verilmeyen, anında ve kalıcı silmeye (temizleme) izin verilmeyen ve aboneliğin kendisinin kalıcı olarak iptal edilemeyeceği bir kasayı ve abonelik durumunu belirtir. Bu düzey, bekletme aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder ve ayrıca aboneliğin kendisinin iptal edilemediğini yansıtır.
EncryptParameters	Şu anda desteklenen tüm şifreleme parametrelerini farklı şifreleme algoritmalarına uygulandığında temsil eden bir tür.
EncryptionAlgorithm	Şifreleme ve şifre çözme için kullanılan bir algoritma. <xref:KnownJsonWebKeyEncryptionAlgorithm> JsonWebKeyEncryptionAlgorithm ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler RSA-OAEP: [Önerilmez] RSAES, https://tools.ietf.org/html/rfc3447'de açıklandığı gibi, Rfc 3447 tarafından Bölüm A.2.1'de belirtilen varsayılan parametrelerle en uygun Asimetrik Şifreleme Doldurmasını (OAEP) kullanır. Bu varsayılan parametreler SHA-1 karma işlevini ve SHA-1 ile MGF1'in maske oluşturma işlevini kullanır. Microsoft, gelişmiş güvenlik için RSA_OAEP_256 veya daha güçlü algoritmalar kullanılmasını önerir. Microsoft, yalnızca geriye dönük uyumluluk için dahil olan RSA_OAEP önermez. RSA_OAEP bilinen çarpışma sorunları olan SHA1'i kullanır. RSA-OAEP-256: SHA-256 karma işlevi ve SHA-256 ile MGF1'in maske oluşturma işlevi ile Optimal Asimetrik Şifreleme Doldurma kullanan RSAES. RSA1_5: [Önerilmez] https://tools.ietf.org/html/rfc3447'de açıklandığı gibi RSAES-PKCS1-V1_5 anahtar şifrelemesi. Microsoft, gelişmiş güvenlik için RSA_OAEP_256 veya daha güçlü algoritmalar kullanılmasını önerir. Microsoft, yalnızca geriye dönük uyumluluk için dahil olan RSA_1_5 önermez. Şifreleme standartları artık şifreleme için güvenli PKCS#1 v1.5 doldurma düzeniyle RSA'yı dikkate almamaktadır. A128GCM: 128 bit AES-GCM. A192GCM: 192 bit AES-GCM. A256GCM: 256 bit AES-GCM. A128KW: 128 bit AES anahtar kaydırma. A192KW: 192 bit AES anahtar kaydırma. A256KW: 256 bit AES anahtar kaydırma. A128CBC: 128 bit AES-CBC. A192CBC: 192 bit AES-CBC. A256CBC: 256 bit AES-CBC. A128CBCPAD: PKCS doldurma ile 128 bit AES-CBC. A192CBCPAD: PKCS doldurma ile 192 bit AES-CBC. A256CBCPAD: PKCS doldurma ile 256 bit AES-CBC. CKM_AES_KEY_WRAP: CKM AES anahtar kaydırma. CKM_AES_KEY_WRAP_PAD: CKM AES anahtar doldurma ile sarmalama.
KeyCurveName	Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> JsonWebKeyCurveName ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler P-256: NIST P-256 üç nokta eğrisi, SECG eğrisi SECP256R1. P-384: NIST P-384 üç nokta eğrisi, SECG eğrisi SECP384R1. P-521: NIST P-521 üç nokta eğrisi, SECG eğrisi SECP521R1. P-256K: SECG üç nokta eğrisi SECP256K1.
KeyExportEncryptionAlgorithm	KeyEncryptionAlgorithm değerlerini tanımlar. KnownKeyExportEncryptionAlgorithm KeyEncryptionAlgorithm ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	JSON web anahtarı işlemleri. Daha fazla bilgi için bkz. JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> JsonWebKeyOperation ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler şifreleme: Anahtarın şifrelemek için kullanılabileceğini gösterir. şifresini çözmek: Anahtarın şifresini çözmek için kullanılabileceğini gösterir. imzalama: Anahtarın imzalamak için kullanılabileceğini gösterir. doğrulama: Anahtarın doğrulamak için kullanılabileceğini gösterir. wrapKey: Anahtarın başka bir anahtarı sarmak için kullanılabileceğini gösterir. unwrapKey: Anahtarın başka bir anahtarı açmak için kullanılabileceğini gösterir. içeri aktarma: Anahtarın oluşturma sırasında içeri aktarılabildiğini gösterir. dışarı aktarma: Anahtarın özel bileşeninin dışarı aktarılabildiğini gösterir.
KeyRotationPolicyAction	Yürütülecek eylem.
KeyType	https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40'de tanımlandığı gibi JsonWebKey Anahtar Türü (kty). <xref:KnownJsonWebKeyType> JsonWebKeyType ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler EC: Elips Eğrisi. EC-HSM: HSM'de depolanan özel anahtarla Üç Nokta Eğrisi. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: HSM'de depolanan özel anahtarla RSA. ekim: Sekizli sıra (simetrik anahtarları temsil etmek için kullanılır) oct-HSM: HSM'de depolanan sekizli dizi (simetrik anahtarları temsil etmek için kullanılır).
KeyWrapAlgorithm	Anahtar sarmalama/açma için desteklenen algoritmalar
RsaEncryptionAlgorithm	Desteklenen tüm RSA şifreleme algoritmalarını temsil eden birleşim türü.
SignatureAlgorithm	İmzalama/doğrulama algoritması tanımlayıcısı. Olası algoritma türleri hakkında daha fazla bilgi için bkz. JsonWebKeySignatureAlgorithm. <xref:KnownJsonWebKeySignatureAlgorithm> JsonWebKeySignatureAlgorithm ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler PS256: https://tools.ietf.org/html/rfc7518'da açıklandığı gibi SHA-256 ve MGF1'i SHA-256 ile RSASSA-PSS PS384: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi SHA-384 ve MGF1'i SHA-384 ile RSASSA-PSS PS512: https://tools.ietf.org/html/rfc7518'da açıklandığı gibi SHA-512 ve MGF1'i SHA-512 ile RSASSA-PSS RS256: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi SHA-256 kullanan RSASSA-PKCS1-v1_5 RS384: https://tools.ietf.org/html/rfc7518'da açıklandığı gibi SHA-384 kullanan RSASSA-PKCS1-v1_5 RS512: https://tools.ietf.org/html/rfc7518'da açıklandığı gibi SHA-512 kullanan RSASSA-PKCS1-v1_5 HS256: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi SHA-256 kullanan HMAC HS384: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi SHA-384 kullanan HMAC HS512: https://tools.ietf.org/html/rfc7518'da açıklandığı gibi SHA-512 kullanan HMAC RSNULL: Ayrılmış ES256: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi P-256 ve SHA-256 kullanan ECDSA. ES384: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi P-384 ve SHA-384 kullanan ECDSA ES512: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi P-521 ve SHA-512 kullanan ECDSA ES256K: https://tools.ietf.org/html/rfc7518'de açıklandığı gibi P-256K ve SHA-256 kullanan ECDSA

Numaralandırmalar

KnownDeletionRecoveryLevel	Geçerli kasadaki sertifikalar için geçerli olan silme kurtarma düzeyini yansıtır. 'Temizlenebilir' içeriyorsa, sertifika ayrıcalıklı bir kullanıcı tarafından kalıcı olarak silinebilir; aksi takdirde, bekletme aralığının sonunda sertifikayı yalnızca sistem temizleyebilir.
KnownEncryptionAlgorithms	Şifreleme ve şifre çözme için kullanılan bir algoritma.
KnownKeyCurveNames	Elips eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.
KnownKeyExportEncryptionAlgorithm	Dışarı aktarılan anahtar malzemesini korumak için kullanılacak şifreleme algoritması
KnownKeyOperations	Hizmetin kabul KeyOperation bilinen değerleri.
KnownKeyTypes	https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40'de tanımlandığı gibi JsonWebKey Anahtar Türü (kty).
KnownSignatureAlgorithms	İmzalama/doğrulama algoritması tanımlayıcısı. Olası algoritma türleri hakkında daha fazla bilgi için bkz. JsonWebKeySignatureAlgorithm.

İşlevler

parseKeyVaultKeyIdentifier(string)

Verilen Key Vault Anahtar Kimliğini ayrıştırıyor. Örnek olarak: https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id> Yukarıdaki kimliği ayrıştırırken bu işlev şunları döndürür: { 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>" }

Değişkenler

logger

@azure/logger Bu paketin yapılandırması.

İşlev Ayrıntıları

parseKeyVaultKeyIdentifier(string)

Verilen Key Vault Anahtar Kimliğini ayrıştırıyor. Örnek olarak:

https://< keyvault-name.vault.azure.net/keys/>< key-name>/<unique-version-id>

Yukarıdaki kimliği ayrıştırırken bu işlev şunları döndürür:

  {
     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

Parametreler

id

string

Key Vault Anahtarının Kimliği.

Döndürülenler

KeyVaultKeyIdentifier

Variable Details

logger

@azure/logger Bu paketin yapılandırması.

logger: AzureLogger

Tür

AzureLogger