@azure/keyvault-keys package

‏‏المرجع

الفصول

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

الواجهات

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'sCryptographyClient
CryptographyOptions	واجهة تمثل خيارات أساليب واجهة برمجة تطبيقات التشفير، انتقل إلى CryptographyClient لمزيد من المعلومات.
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_2, 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	خيارات مفتاح الإصدار
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 بالتبادل مع DeletionRecoveryLevel، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة قابل للإزالة: يشير إلى حالة المخزن التي يكون فيها الحذف عملية لا رجعة فيها، دون إمكانية الاسترداد. يتوافق هذا المستوى مع عدم توفر أي حماية ضد عملية الحذف؛ يتم فقدان البيانات بشكل لا يمكن إصلاحه عند قبول عملية حذف على مستوى الكيان أو أعلى (المخزن ومجموعة الموارد والاشتراك وما إلى ذلك) 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: منحنى القطع الناقص SECG SECP256K1.
KeyExportEncryptionAlgorithm	يحدد قيم KeyEncryptionAlgorithm. يمكن استخدام KnownKeyExportEncryptionAlgorithm بالتبادل مع KeyEncryptionAlgorithm، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة CKM_RSA_AES_KEY_WRAP RSA_AES_KEY_WRAP_256 RSA_AES_KEY_WRAP_384
KeyOperation	يحدد قيم JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> يمكن استخدامها بالتبادل مع JsonWebKeyOperation، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة encrypt decrypt sign التحقق wrapKey unwrapKey استيراد تصدير
KeyRotationPolicyAction	الإجراء الذي سيتم تنفيذه.
KeyType	يحدد قيم JsonWebKeyType. <xref:KnownJsonWebKeyType> يمكن استخدام بالتبادل مع JsonWebKeyType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة EC: منحنى القطع الناقص. EC-HSM: منحنى ناقص مع مفتاح خاص يتم تخزينه في HSM. RSA: RSA (https://tools.ietf.org/html/rfc3447) RSA-HSM: RSA مع مفتاح خاص يتم تخزينه في HSM. oct: Octet sequence (يستخدم لتمثيل المفاتيح المتماثلة) 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)

المعلمات

المرتجعات

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