@azure/keyvault-secrets package

الفصول

SecretClient

يوفر SecretClient أساليب لإدارة KeyVaultSecret في Key Vault Azure. يدعم العميل إنشاء KeyVaultSecrets واستردادها وتحديثها وحذفها وتطهيرها ونسخها احتياطيا واستعادتها وإدراجها. يدعم العميل أيضا إدراج DeleteedSecret Key Vault Azure الممكنة للحذف المبدئي.

الواجهات

BackupSecretOptions	خيارات ل <xref:backupSecretOptions>.
BeginDeleteSecretOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	واجهة تمثل KeyVault Secret محذوفة.
GetDeletedSecretOptions	خيارات ل getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	خيارات ل getSecret(string, GetSecretOptions).
KeyVaultSecret	واجهة تمثل KeyVault Secret، باسمها وقيمتها وSecretProperties.
KeyVaultSecretIdentifier	يمثل المقاطع التي تشكل معرفا سريا Key Vault.
ListDeletedSecretsOptions	خيارات ل listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	خيارات ل listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	خيارات ل listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	واجهة تتعقب إعدادات التكرار المصفح
PagedAsyncIterableIterator	واجهة تسمح بالتكرار غير المتزامن سواء حتى الاكتمال أو حسب الصفحة.
PollOperationState	يحتوي PollOperationState على قائمة تم استطلاعها لأصغر مجموعة من الخصائص اللازمة لتحديد أي استقصاء عملية طويلة الأمد. بينما تعمل فئة Poller كآلية تحكم محلية لبدء التشغيل والانتظار والإلغاء المحتمل لعملية تشغيل طويلة، توثق PollOperationState حالة عملية التشغيل الطويل البعيد. يجب تحديثه على الأقل عند بدء العملية، ومتى تنتهي، ومتى يتم إلغاؤها. على الرغم من ذلك، يمكن أن يكون للتطبيقات أي عدد آخر من الخصائص التي يمكن تحديثها لأسباب أخرى.
PollerLike	تمثيل تجريدي لأداة الاستقصاء، تهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.
PurgeDeletedSecretOptions	خيارات ل purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	خيارات ل restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	المعلمات الاختيارية المقبولة من قبل KeyVault's KeyClient
SecretPollerOptions	واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginDeleteSecret(string, BeginDeleteSecretOptions) و <xref:beginRecoverDeletedKey>.
SecretProperties	واجهة تمثل خصائص KeyVaultSecret.
SetSecretOptions	خيارات ل setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	خيارات ل updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

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

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. يضمن هذا المستوى إمكانية استرداد الكيان المحذوف أثناء الفاصل الزمني للاستبقاء، ويعكس أيضا حقيقة أنه لا يمكن إلغاء الاشتراك نفسه.

التعدادات

KnownDeletionRecoveryLevel

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

الوظائف

parseKeyVaultSecretIdentifier(string)

تحليل المعرف السري Key Vault المحدد. مثال على ذلك: https://.vault.azure.net/secrets// عند تحليل المعرف أعلاه، ترجع هذه الدالة: { sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>", vaultUrl: "https://<keyvault-name>.vault.azure.net", version: "<unique-version-id>", name: "<secret-name>" }

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

parseKeyVaultSecretIdentifier(string)

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

https://.vault.azure.net/secrets//

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

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

المعلمات

id

string

معرف سر Key Vault.

المرتجعات

KeyVaultSecretIdentifier