@azure/keyvault-admin package

الفصول

KeyVaultAccessControlClient

يوفر KeyVaultAccessControlClient أساليب لإدارة التحكم في الوصول وتعيينات الأدوار في أي مثيل Azure Key Vault معين. يدعم العميل إنشاء الأدوار واستردادها وحذفها.
KeyVaultBackupClient

يوفر KeyVaultBackupClient أساليب لإنشاء نسخ احتياطية واستعادة النسخ الاحتياطية لأي مثيل Azure Key Vault معين. يدعم هذا العميل إنشاء النسخ الاحتياطية الكاملة والاستعادة الانتقائية لمفاتيح معينة والاستعادة الكاملة لمثيلات Key Vault.
KeyVaultSettingsClient

يوفر KeyVaultSettingsClient أساليب غير متزامنة لإنشاء إعدادات Azure Key Vault وتحديثها والحصول عليها وإدراجها.

الواجهات

AccessControlClientOptions

المعلمات الاختيارية المقبولة من قبل AccessControlClient في Key Vault
BooleanKeyVaultSetting

إعداد Key Vault من النوع المنطقي. للتحقق مما إذا كان KeyVaultSetting معينا منطقيا، استخدم isBooleanSetting.
CreateRoleAssignmentOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)
DeleteRoleAssignmentOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)
DeleteRoleDefinitionOptions

واجهة تمثل المعلمات الاختيارية التي تم تمريرها إلى deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).
GetRoleAssignmentOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى getRoleAssignment(string, string, GetRoleAssignmentOptions)
GetRoleDefinitionOptions

واجهة تمثل المعلمات الاختيارية التي تم تمريرها إلى getRoleDefinition(string, string, GetRoleDefinitionOptions).
GetSettingOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى getSetting
KeyVaultAdminPollOperationState

واجهة تمثل حالة عملية Key Vault Admin Poller.
KeyVaultBackupClientOptions

المعلمات الاختيارية المقبولة من قبل KeyVaultBackupClient
KeyVaultBackupPollerOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginBackup(string, string, KeyVaultBeginBackupOptions)
KeyVaultBackupResult

واجهة تمثل نتيجة عملية النسخ الاحتياطي.
KeyVaultBeginBackupOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginBackup
KeyVaultBeginPreBackupOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginPreBackup
KeyVaultBeginPreRestoreOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginPreRestore
KeyVaultBeginRestoreOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginRestore
KeyVaultBeginSelectiveKeyRestoreOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى beginSelectiveKeyRestore
KeyVaultPermission

قائمة بأذونات Key Vault.
KeyVaultRestoreOperationState

واجهة تمثل الخصائص المتاحة للجمهور لحالة عملية استقصاء Key Vault للاستعادة.
KeyVaultRestoreResult

واجهة تمثل نتيجة عملية الاستعادة.
KeyVaultRoleAssignment

تعيين دور Key Vault.
KeyVaultRoleAssignmentProperties

خصائص تعيين الدور.
KeyVaultRoleDefinition

تعريف دور Key Vault.
KeyVaultSelectiveKeyRestoreOperationState

واجهة تمثل الخصائص المتاحة للجمهور لحالة عملية استقصاء Key Vault للاستعادة.
KeyVaultSelectiveKeyRestoreResult

واجهة تمثل نتيجة عملية استعادة مفتاح انتقائية.
KeyVaultSetting

إعداد Key Vault.
ListRoleAssignmentsOptions

واجهة تمثل المعلمات الاختيارية التي تم تمريرها إلى listRoleAssignments(string, ListRoleAssignmentsOptions).
ListRoleAssignmentsPageSettings

وسيطات لاسترداد الصفحة التالية من نتائج البحث.
ListRoleDefinitionsOptions

واجهة تمثل المعلمات الاختيارية التي تم تمريرها إلى listRoleDefinitions(string, ListRoleDefinitionsOptions).
ListRoleDefinitionsPageSettings

وسيطات لاسترداد الصفحة التالية من نتائج البحث.
ListSettingsOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى <xref:KeyVaultSettingsClient.listSettings>
ListSettingsResponse

واجهة تمثل الاستجابة التي تم إرجاعها بواسطة <xref:KeyVaultSettingsClient.listSettings>
PollerLike

استقصاء بسيط يمكن استخدامه لاستقصاء عملية طويلة الأمد.
SetRoleDefinitionOptions

واجهة تمثل المعلمات الاختيارية التي تم تمريرها إلى setRoleDefinition(string, SetRoleDefinitionOptions).
SettingsClientOptions

المعلمات الاختيارية المقبولة من قبل KeyVaultSettingsClient.
UpdateSettingOptions

واجهة تمثل المعلمات الاختيارية التي يمكن تمريرها إلى updateSetting

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

KeyVaultBackupOperationState

واجهة تمثل الخصائص المتاحة للجمهور لحالة عملية استقصاء Key Vault للنسخ الاحتياطي.
KeyVaultDataAction

الأذونات المدعومة لإجراءات البيانات.
يمكن استخدام <xref:KnownDataAction> بالتبادل مع DataAction، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

Microsoft.KeyVault/managedHsm/keys/read/action: قراءة بيانات تعريف مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: تحديث مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: قراءة مفتاح HSM المحذوف.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: استرداد مفتاح HSM المحذوف.
Microsoft.KeyVault/managedHsm/keys/backup/action: مفاتيح HSM للنسخ الاحتياطي.
Microsoft.KeyVault/managedHsm/keys/restore/action: استعادة مفاتيح HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: حذف تعيين الدور.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: الحصول على تعيين الدور.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: إنشاء تعيين الدور أو تحديثه.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: الحصول على تعريف الدور.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: إنشاء تعريف الدور أو تحديثه.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: حذف تعريف الدور.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: تشفير باستخدام مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: فك التشفير باستخدام مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: التفاف باستخدام مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: إلغاء التدبير باستخدام مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: تسجيل الدخول باستخدام مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: تحقق باستخدام مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/create: إنشاء مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/delete: حذف مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: تصدير مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: حرر مفتاح HSM باستخدام إصدار المفتاح الآمن.
Microsoft.KeyVault/managedHsm/keys/import/action: استيراد مفتاح HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: إزالة مفتاح HSM محذوف.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: تنزيل مجال أمان HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: تحقق من حالة تنزيل مجال أمان HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: تحميل مجال أمان HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: تحقق من حالة ملف تبادل مجال أمان HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: تنزيل مفتاح نقل مجال أمان HSM.
Microsoft.KeyVault/managedHsm/backup/start/action: بدء النسخ الاحتياطي ل HSM.
Microsoft.KeyVault/managedHsm/restore/start/action: بدء استعادة HSM.
Microsoft.KeyVault/managedHsm/backup/status/action: قراءة حالة النسخ الاحتياطي ل HSM.
Microsoft.KeyVault/managedHsm/restore/status/action: قراءة حالة استعادة HSM.
Microsoft.KeyVault/managedHsm/rng/action: إنشاء أرقام عشوائية.
KeyVaultRoleScope

نطاق الدور.
يمكن استخدام <xref:KnownRoleScope> بالتبادل مع RoleScope، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

/: النطاق العمومي
/keys: نطاق المفاتيح
OperationStatus

حالة عملية طويلة الأمد.
يمكن استخدام <xref:KnownOperationStatus> بالتبادل مع OperationStatus، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

InProgress: العملية قيد التقدم.
بنجاح: اكتملت العملية بنجاح.
تم إلغاء: تم إلغاء العملية.
فشل : فشلت العملية.
SUPPORTED_API_VERSIONS

إصدارات واجهة برمجة التطبيقات المدعومة

التعدادات

KnownKeyVaultDataAction

الأذونات المدعومة لإجراءات البيانات.
KnownKeyVaultRoleScope

نطاق الدور.

الوظائف

isBooleanSetting(KeyVaultSetting)

تحديد ما إذا كان KeyVaultSetting معين هو BooleanKeyVaultSetting، أي أن له قيمة منطقية.

المتغيرات

LATEST_API_VERSION

أحدث إصدار مدعوم من واجهة برمجة تطبيقات خدمة Key Vault.
SDK_VERSION

الإصدار الحالي من مجموعة تطوير تطوير الاتجاهات لمسؤول Key Vault.

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

isBooleanSetting(KeyVaultSetting)

تحديد ما إذا كان KeyVaultSetting معين هو BooleanKeyVaultSetting، أي أن له قيمة منطقية.

function isBooleanSetting(setting: KeyVaultSetting): setting

المعلمات

setting
KeyVaultSetting

المرتجعات

setting

تفاصيل المُتغيّر

LATEST_API_VERSION

أحدث إصدار مدعوم من واجهة برمجة تطبيقات خدمة Key Vault.

LATEST_API_VERSION: "2025-07-01"

النوع

"2025-07-01"

SDK_VERSION

الإصدار الحالي من مجموعة تطوير تطوير الاتجاهات لمسؤول Key Vault.

SDK_VERSION: string

النوع

string