@azure/keyvault-keys package

‏‏المرجع

الفصول

CryptographyClient	عميل يستخدم لتنفيذ عمليات التشفير على مفتاح Azure Key vault أو JsonWebKey المحلي.
KeyClient	يوفر KeyClient أساليب لإدارة KeyVaultKey في Azure Key Vault. يدعم العميل إنشاء مفاتيح KeyVaultKeys واستردادها وتحديثها وحذفها وتطهيرها ونسخها احتياطيا واستعادتها وإدراجها. يدعم العميل أيضا سرد DeletedKey ل Azure Key Vault ممكن للحذف المبدئي.

الواجهات

AesCbcDecryptParameters	معلمات فك التشفير لخوارزميات التشفير AES-CBC.
AesCbcEncryptParameters	معلمات التشفير لخوارزميات التشفير AES-CBC.
AesGcmDecryptParameters	معلمات فك التشفير لخوارزميات التشفير AES-GCM.
AesGcmEncryptParameters	معلمات التشفير لخوارزميات التشفير AES-GCM.
BackupKeyOptions	خيارات backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions	المعلمات الاختيارية المقبولة من قبل KeyVault's CryptographyClient
CryptographyOptions	واجهة تمثل خيارات أساليب واجهة برمجة تطبيقات التشفير، انتقل إلى تشفير للحصول على مزيد من المعلومات.
DecryptOptions	خيارات decrypt(DecryptParameters, DecryptOptions).
DecryptResult	نتيجة عملية decrypt(DecryptParameters, DecryptOptions).
DeletedKey	واجهة تمثل مفتاح Key Vault محذوف.
EncryptOptions	خيارات encrypt(EncryptParameters, EncryptOptions).
EncryptResult	نتيجة عملية encrypt(EncryptParameters, EncryptOptions).
GetCryptographyClientOptions	خيارات getCryptographyClient.
GetDeletedKeyOptions	خيارات getDeletedKey(string, GetDeletedKeyOptions).
GetKeyOptions	خيارات getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions	خيارات <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions	خيارات getRandomBytes
ImportKeyOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى importKey(string, JsonWebKey, ImportKeyOptions)
JsonWebKey	اعتبارا من http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions	المعلمات الاختيارية المقبولة من قبل KeyVault's KeyClient
KeyPollerOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginDeleteKey(string, BeginDeleteKeyOptions)beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties	واجهة تمثل خصائص KeyVaultKey
KeyReleasePolicy	قواعد النهج التي يمكن بموجبها تصدير مفتاح.
KeyRotationLifetimeAction	إجراء ومشغله المقابل الذي سيتم تنفيذه بواسطة Key Vault على مدى عمر المفتاح.
KeyRotationPolicy	نهج تدوير المفتاح الكامل الذي ينتمي إلى مفتاح.
KeyRotationPolicyProperties	خصائص نهج تدوير المفتاح الذي يمكن للعميل تعيينه لمفتاح معين. يمكنك أيضا إعادة تعيين نهج تدوير المفتاح إلى قيمه الافتراضية عن طريق تعيين lifetimeActions إلى صفيف فارغ.
KeyVaultKey	واجهة تمثل مفتاح Key Vault، باسمه وقيمته KeyProperties.
KeyVaultKeyIdentifier	يمثل المقاطع التي تقوم بإنشاء معرف مفتاح Key Vault.
ListDeletedKeysOptions	واجهة تمثل معلمات اختيارية لعمليات KeyClient المصفحة التي تم تمريرها إلى listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions	واجهة تمثل معلمات اختيارية لعمليات KeyClient المصفحة التي تم تمريرها إلى listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions	واجهة تمثل معلمات اختيارية لعمليات KeyClient المصفحة التي تم تمريرها إلى listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings	واجهة تتعقب إعدادات التكرار المصفح
PagedAsyncIterableIterator	واجهة تسمح بالتكرار غير المتزامن حتى الاكتمال والصفحة.
PollOperationState	يحتوي PollOperationState على قائمة تم إبداء الرأي فيها لأصغر مجموعة من الخصائص اللازمة لتحديد أي مناقصات العمليات طويلة الأمد. بينما تعمل فئة Poller كآلية تحكم محلية لبدء التشغيل والانتظار والإلغاء المحتمل لعملية تشغيل طويلة، توثق PollOperationState حالة عملية التشغيل الطويل البعيد. يجب تحديثه على الأقل عند بدء العملية، ومتى تنتهي، ومتى يتم إلغاؤها. على الرغم من ذلك، يمكن أن يكون للتطبيقات أي عدد آخر من الخصائص التي يمكن تحديثها لأسباب أخرى.
PollerLike	تمثيل تجريدي للمطلع، يهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.
PurgeDeletedKeyOptions	خيارات purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions	خيارات releaseKey
ReleaseKeyResult	نتيجة عملية releaseKey .
RestoreKeyBackupOptions	خيارات restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions	خيارات rotateKey
RsaDecryptParameters	معلمات فك التشفير لخوارزميات تشفير RSA.
RsaEncryptParameters	معلمات التشفير لخوارزميات تشفير RSA.
SignOptions	خيارات sign(string, Uint8Array, SignOptions).
SignResult	نتيجة عملية sign(string, Uint8Array, SignOptions).
UnwrapKeyOptions	خيارات unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	نتيجة عملية <xref:unwrap>.
UpdateKeyPropertiesOptions	خيارات updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions	خيارات updateKeyRotationPolicy
VerifyDataOptions	خيارات verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions	خيارات verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult	نتيجة عملية verify(string, Uint8Array, Uint8Array, VerifyOptions).
WrapKeyOptions	خيارات wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	نتيجة عملية <xref:wrap>.

النوع أسماء مستعارة

AesCbcEncryptionAlgorithm	نوع موحد يمثل جميع خوارزميات تشفير AES-CBC المدعومة.
AesGcmEncryptionAlgorithm	نوع موحد يمثل جميع خوارزميات تشفير AES-GCM المدعومة.
DecryptParameters	نوع يمثل جميع معلمات فك التشفير المدعومة حاليا كما تنطبق على خوارزميات التشفير المختلفة.
DeletionRecoveryLevel	تعريف قيم DeleteionRecoveryLevel. KnownDeletionRecoveryLevel يمكن استخدامها بالتبادل مع DeleteionRecoveryLevel، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة القابلة للإزالة: تشير إلى حالة المخزن التي يكون فيها الحذف عملية لا رجعة فيها، دون إمكانية الاسترداد. يتوافق هذا المستوى مع عدم توفر أي حماية ضد عملية الحذف؛ يتم فقدان البيانات بشكل لا يمكن إصلاحه عند قبول عملية حذف على مستوى الكيان أو أعلى (المخزن ومجموعة الموارد والاشتراك وما إلى ذلك) Recoverable+Purgeable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد، والذي يسمح أيضا بالحذف الفوري والدائم (أي الإزالة). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء (90 يوما)، ما لم يتم طلب عملية إزالة، أو تم إلغاء الاشتراك. النظام حذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده قابل للاسترداد: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد دون إمكانية الحذف الفوري والدائم (أي الإزالة). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء (90 يوما) وبينما لا يزال الاشتراك متوفرا. النظام حذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده Recoverable+ProtectedSubscription: يشير إلى حالة المخزن والاشتراك التي يكون فيها الحذف قابلا للاسترداد خلال فترة الاستبقاء (90 يوما)، ولا يسمح بالحذف الفوري والدائم (أي التطهير)، ولا يمكن فيه إلغاء الاشتراك نفسه نهائيا. النظام حذفه نهائيا بعد 90 يوما، إذا لم يتم استرداده CustomizedRecoverable+Purgeable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد، والذي يسمح أيضا بالحذف الفوري والدائم (أي الإزالة عند 7<= SoftDeleteRetentionInDays < 90). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء، ما لم يتم طلب عملية إزالة، أو تم إلغاء الاشتراك. CustomizedRecoverable: يشير إلى حالة المخزن التي يكون فيها الحذف قابلا للاسترداد دون إمكانية الحذف الفوري والدائم (أي الإزالة عند 7<= SoftDeleteRetentionInDays < 90). يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء الفاصل الزمني للاستبقاء وبينما لا يزال الاشتراك متوفرا. CustomizedRecoverable+ProtectedSubscription: يشير إلى حالة المخزن والاشتراك التي يكون فيها الحذف قابلا للاسترداد، والحذف الفوري والدائم (أي الإزالة)، ولا يمكن فيه إلغاء الاشتراك نفسه بشكل دائم عند 7<= SoftDeleteRetentionInDays < 90. يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء فترة الاستبقاء، ويعكس أيضا حقيقة أنه لا يمكن إلغاء الاشتراك نفسه.
EncryptParameters	نوع يمثل جميع معلمات التشفير المدعومة حاليا كما تنطبق على خوارزميات التشفير المختلفة.
EncryptionAlgorithm	تعريف قيم JsonWebKeyEncryptionAlgorithm. يمكن استخدام <xref:KnownJsonWebKeyEncryptionAlgorithm> بالتبادل مع JsonWebKeyEncryptionAlgorithm، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة RSA-OAEP RSA-OAEP-256 RSA1_5 A128GCM A192GCM A256GCM A128KW A192KW A256KW A128CBC A192CBC A256CBC A128CBCPAD A192CBCPAD A256CBCPAD
KeyCurveName	تعريف قيم JsonWebKeyCurveName. يمكن استخدام <xref:KnownJsonWebKeyCurveName> بالتبادل مع JsonWebKeyCurveName، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة P-256: منحنى القطع الناقص NIST P-256، منحنى AKA SECG SECP256R1. P-384: منحنى القطع الناقص NIST P-384، منحنى AKA SECG SECP384R1. P-521: منحنى القطع الناقص NIST P-521، منحنى AKA SECG SECP521R1. P-256K: المنحنى الناقص SECP256K1 SECG.
KeyExportEncryptionAlgorithm	تعريف قيم KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm يمكن استخدامها بالتبادل مع KeyEncryptionAlgorithm، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	تعريف قيم JsonWebKeyOperation. يمكن استخدام <xref:KnownJsonWebKeyOperation> بالتبادل مع JsonWebKeyOperation، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة تشفير فك تشفير توقيع التحقق wrapKey unwrapKey استيراد تصدير
KeyRotationPolicyAction	الإجراء الذي سيتم تنفيذه.
KeyType	تعريف قيم JsonWebKeyType. يمكن استخدام <xref:KnownJsonWebKeyType> بالتبادل مع JsonWebKeyType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة EC: منحنى القطع الناقص. EC-HSM: منحنى القطع الناقص مع مفتاح خاص يتم تخزينه في HSM. RSA : RSA () RSA-HSM: RSA مع مفتاح خاص يتم تخزينه في HSM. oct: تسلسل ثماني (يستخدم لتمثيل المفاتيح المتماثلة) oct-HSM: تسلسل Octet (يستخدم لتمثيل المفاتيح المتماثلة) المخزنة في HSM.
KeyWrapAlgorithm	خوارزميات مدعومة لالتفاف/فك التفاف المفتاح
RsaEncryptionAlgorithm	نوع موحد يمثل جميع خوارزميات تشفير RSA المدعومة.
SignatureAlgorithm	تعريف قيم JsonWebKeySignatureAlgorithm. يمكن استخدام <xref:KnownJsonWebKeySignatureAlgorithm> بالتبادل مع JsonWebKeySignatureAlgorithm، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة PS256: RSASSA-PSS باستخدام SHA-256 وMGF1 مع SHA-256، كما هو موضح في https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS باستخدام SHA-384 وMGF1 مع SHA-384، كما هو موضح في https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS باستخدام SHA-512 وMGF1 مع SHA-512، كما هو موضح في https://tools.ietf.org/html/rfc7518 RS256: RSASSA-PKCS1-v1_5 باستخدام SHA-256، كما هو موضح في https://tools.ietf.org/html/rfc7518 RS384: RSASSA-PKCS1-v1_5 باستخدام SHA-384، كما هو موضح في https://tools.ietf.org/html/rfc7518 RS512: RSASSA-PKCS1-v1_5 باستخدام SHA-512، كما هو موضح في https://tools.ietf.org/html/rfc7518 RSNULL: محجوز ES256: ECDSA باستخدام P-256 وSHA-256، كما هو موضح في https://tools.ietf.org/html/rfc7518. ES384: ECDSA باستخدام P-384 وSHA-384، كما هو موضح في https://tools.ietf.org/html/rfc7518 ES512: ECDSA باستخدام P-521 وSHA-512، كما هو موضح في https://tools.ietf.org/html/rfc7518 ES256K: ECDSA باستخدام P-256K وSHA-256، كما هو موضح في https://tools.ietf.org/html/rfc7518

التعدادات

KnownDeletionRecoveryLevel	القيم المعروفة DeleteionRecoveryLevel التي تقبلها الخدمة.
KnownEncryptionAlgorithms	القيم المعروفة EncryptionAlgorithm تقبلها الخدمة.
KnownKeyCurveNames	القيم المعروفة <xref:JsonWebKeyCurveName> التي تقبلها الخدمة.
KnownKeyExportEncryptionAlgorithm	القيم المعروفة KeyExportEncryptionAlgorithm تقبلها الخدمة.
KnownKeyOperations	القيم المعروفة KeyOperation التي تقبلها الخدمة.
KnownKeyTypes	القيم المعروفة <xref:JsonWebKeyType> التي تقبلها الخدمة.
KnownSignatureAlgorithms	القيم المعروفة <xref:JsonWebKeySignatureAlgorithm> التي تقبلها الخدمة.

الوظائف

parseKeyVaultKeyIdentifier(string)

تحليل معرف مفتاح Key Vault المحدد. مثال على ذلك:

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

عند تحليل المعرف أعلاه، ترجع هذه الدالة:

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

تفاصيل الوظيفة

parseKeyVaultKeyIdentifier(string)

تحليل معرف مفتاح Key Vault المحدد. مثال على ذلك:

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

عند تحليل المعرف أعلاه، ترجع هذه الدالة:

  {
     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

المعلمات

id: string

معرف مفتاح Key Vault.

المرتجعات

KeyVaultKeyIdentifier

مشاركة عبر

@azure/keyvault-keys package

الفصول

الواجهات

النوع أسماء مستعارة

القيم المعروفة التي تدعمها الخدمة

القيم المعروفة التي تدعمها الخدمة

القيم المعروفة التي تدعمها الخدمة

القيم المعروفة التي تدعمها الخدمة

القيم المعروفة التي تدعمها الخدمة

القيم المعروفة التي تدعمها الخدمة

القيم المعروفة التي تدعمها الخدمة

التعدادات

الوظائف

تفاصيل الوظيفة

parseKeyVaultKeyIdentifier(string)

المعلمات

المرتجعات

الموارد الإضافية