@azure/keyvault-keys package
الفصول
CryptographyClient |
عميل يستخدم لتنفيذ عمليات التشفير على مفتاح Azure Key vault أو JsonWebKey المحلي. |
KeyClient |
يوفر KeyClient أساليب لإدارة KeyVaultKey |
الواجهات
AesCbcDecryptParameters |
معلمات فك التشفير لخوارزميات التشفير AES-CBC. |
AesCbcEncryptParameters |
معلمات التشفير لخوارزميات التشفير AES-CBC. |
AesGcmDecryptParameters |
معلمات فك التشفير لخوارزميات التشفير AES-GCM. |
AesGcmEncryptParameters |
معلمات التشفير لخوارزميات التشفير AES-GCM. |
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 | |
DecryptResult |
نتيجة عملية decrypt(DecryptParameters, DecryptOptions). |
DeletedKey |
واجهة تمثل مفتاح Key Vault محذوف. |
EncryptOptions | |
EncryptResult |
نتيجة عملية encrypt(EncryptParameters, EncryptOptions). |
GetCryptographyClientOptions |
خيارات getCryptographyClient. |
GetDeletedKeyOptions | |
GetKeyAttestationOptions | |
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 |
KeyAttestation |
واجهة تمثل خصائص إثبات المفتاح |
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 | |
ReleaseKeyOptions |
خيارات releaseKey |
ReleaseKeyResult |
نتيجة عملية releaseKey |
RestoreKeyBackupOptions |
خيارات restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions). |
RotateKeyOptions |
خيارات |
RsaDecryptParameters |
معلمات فك التشفير لخوارزميات تشفير RSA. |
RsaEncryptParameters |
معلمات التشفير لخوارزميات تشفير RSA. |
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 |
يعكس مستوى استرداد الحذف الساري حاليا للشهادات في المخزن الحالي. إذا كان يحتوي على "قابل للإزالة"، يمكن حذف الشهادة نهائيا من قبل مستخدم متميز؛ وإلا، يمكن للنظام فقط إزالة الشهادة، في نهاية الفاصل الزمني للاحتفاظ. القيم المعروفة التي تدعمها الخدمة
القابلة للإزالة: تشير إلى حالة المخزن التي يكون فيها الحذف عملية لا رجعة فيها، دون إمكانية الاسترداد. يتوافق هذا المستوى مع عدم توفر أي حماية ضد عملية الحذف؛ يتم فقدان البيانات بشكل لا يمكن إصلاحه عند قبول عملية حذف على مستوى الكيان أو أعلى (المخزن ومجموعة الموارد والاشتراك وما إلى ذلك) |
EncryptParameters |
نوع يمثل جميع معلمات التشفير المدعومة حاليا كما تنطبق على خوارزميات التشفير المختلفة. |
EncryptionAlgorithm |
خوارزمية تستخدم للتشفير وفك التشفير. القيم المعروفة التي تدعمها الخدمة
RSA-OAEP: [غير مستحسن] RSAES باستخدام ترك مساحة التشفير غير المتماثل الأمثل (OAEP)، كما هو موضح في https://tools.ietf.org/html/rfc3447، مع المعلمات الافتراضية المحددة بواسطة RFC 3447 في القسم A.2.1. تستخدم هذه المعلمات الافتراضية دالة تجزئة SHA-1 ووظيفة إنشاء قناع MGF1 مع SHA-1. توصي Microsoft باستخدام خوارزميات RSA_OAEP_256 أو أقوى لتحسين الأمان. لا توصي Microsoft RSA_OAEP، والتي يتم تضمينها فقط للتوافق مع الإصدارات السابقة. يستخدم RSA_OAEP SHA1، الذي يعرف مشاكل التصادم. |
KeyCurveName |
اسم المنحنى الناقص. للحصول على قيم صالحة، راجع JsonWebKeyCurveName. القيم المعروفة التي تدعمها الخدمة
P-256: منحنى القطع الناقص NIST P-256، منحنى AKA SECG SECP256R1. |
KeyExportEncryptionAlgorithm |
تعريف قيم KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm يمكن استخدامها بالتبادل مع KeyEncryptionAlgorithm، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة
CKM_RSA_AES_KEY_WRAP |
KeyOperation |
عمليات مفتاح ويب JSON. لمزيد من المعلومات، راجع JsonWebKeyOperation. القيم المعروفة التي تدعمها الخدمة
تشفير: يشير إلى أنه يمكن استخدام المفتاح للتشفير. |
KeyRotationPolicyAction |
الإجراء الذي سيتم تنفيذه. |
KeyType |
نوع مفتاح JsonWebKey (kty)، كما هو محدد في https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. القيم المعروفة التي تدعمها الخدمة
EC: منحنى القطع الناقص. |
KeyWrapAlgorithm |
خوارزميات مدعومة لالتفاف/فك التفاف المفتاح |
RsaEncryptionAlgorithm |
نوع موحد يمثل جميع خوارزميات تشفير RSA المدعومة. |
SignatureAlgorithm |
معرف خوارزمية التوقيع/التحقق. لمزيد من المعلومات حول أنواع الخوارزميات المحتملة، راجع JsonWebKeySignatureAlgorithm. القيم المعروفة التي تدعمها الخدمة
PS256: RSASSA-PSS باستخدام SHA-256 وMGF1 مع SHA-256، كما هو موضح في https://tools.ietf.org/html/rfc7518 |
التعدادات
KnownDeletionRecoveryLevel |
يعكس مستوى استرداد الحذف الساري حاليا للشهادات في المخزن الحالي. إذا كان يحتوي على "قابل للإزالة"، يمكن حذف الشهادة نهائيا من قبل مستخدم متميز؛ وإلا، يمكن للنظام فقط إزالة الشهادة، في نهاية الفاصل الزمني للاحتفاظ. |
KnownEncryptionAlgorithms |
خوارزمية تستخدم للتشفير وفك التشفير. |
KnownKeyCurveNames |
اسم المنحنى الناقص. للحصول على قيم صالحة، راجع JsonWebKeyCurveName. |
KnownKeyExportEncryptionAlgorithm |
خوارزمية التشفير لاستخدامها لحماية المواد الرئيسية المصدرة |
KnownKeyOperations |
القيم المعروفة |
KnownKeyTypes |
نوع مفتاح JsonWebKey (kty)، كما هو محدد في https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
KnownSignatureAlgorithms |
معرف خوارزمية التوقيع/التحقق. لمزيد من المعلومات حول أنواع الخوارزميات المحتملة، راجع JsonWebKeySignatureAlgorithm. |
الوظائف
parse |
تحليل معرف مفتاح Key Vault المحدد. مثال على ذلك: https://.vault.azure.net/keys// عند تحليل المعرف أعلاه، ترجع هذه الدالة:
|
تفاصيل الوظيفة
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.