@azure/arm-keyvault package
الفصول
| KeyVaultManagementClient |
الواجهات
| AccessPolicyEntry |
هوية لديها حق الوصول إلى خزنة المفاتيح. يجب أن تستخدم جميع الهويات في الصفيف نفس معرف المستأجر كمعرف مستأجر مخزن المفاتيح. |
| Action |
واجهة النموذج إجراء |
| Attributes |
سمات الكائن التي تديرها خدمة KeyVault. |
| CheckMhsmNameAvailabilityParameters |
المعلمات المستخدمة للتحقق من توفر اسم hsm المدار. |
| CheckMhsmNameAvailabilityResult |
استجابة عملية CheckMhsmNameAvailability. |
| CheckNameAvailabilityResult |
استجابة عملية CheckNameAvailability. |
| CloudError |
استجابة خطأ من موفر موارد Key Vault |
| CloudErrorBody |
استجابة خطأ من موفر موارد Key Vault |
| DeletedManagedHsm |
يمكن إنشاء أنواع موارد الوكيل الملموسة عن طريق تسمية هذا النوع بالاسم المستعار باستخدام نوع خاصية معين. |
| DeletedManagedHsmProperties |
خصائص HSM المدار المحذوف. |
| DeletedVault |
معلومات المخزن المحذوفة مع تفاصيل موسعة. |
| DeletedVaultProperties |
خصائص المخزن المحذوف. |
| DimensionProperties |
نوع العملية: الحصول على، والقراءة، والحذف، وما إلى ذلك. |
| ErrorModel |
خطأ الخادم. |
| IPRule |
قاعدة تحكم إمكانية وصول ذوي الاحتياجات الخاصة إلى مخزن من عنوان IP محدد أو نطاق IP. |
| Key |
المورد الرئيسي. |
| KeyAttributes |
سمات الكائن التي تديرها خدمة Azure Key Vault. |
| KeyCreateParameters |
المعلمات المستخدمة لإنشاء مفتاح. |
| KeyProperties |
خصائص المفتاح. |
| KeyReleasePolicy |
واجهة النموذج KeyReleasePolicy |
| KeyRotationPolicyAttributes |
واجهة النموذج KeyRotationPolicyAttributes |
| KeyVaultManagementClientOptionalParams |
معلمات اختيارية للعميل. |
| KeysCreateIfNotExistOptionalParams |
المعلمات الاختيارية. |
| KeysGetOptionalParams |
المعلمات الاختيارية. |
| KeysGetVersionOptionalParams |
المعلمات الاختيارية. |
| KeysListOptionalParams |
المعلمات الاختيارية. |
| KeysListVersionsOptionalParams |
المعلمات الاختيارية. |
| KeysOperations |
واجهة تمثل عمليات المفاتيح. |
| LifetimeAction |
واجهة النموذج LifetimeAction |
| LogSpecification |
مواصفات السجل للعملية. |
| ManagedHSMSecurityDomainProperties |
خصائص مجال الأمان ل hsm المدار. |
| ManagedHsm |
معلومات الموارد مع تفاصيل موسعة. |
| ManagedHsmAction |
واجهة النموذج ManagedHsmAction |
| ManagedHsmError |
استثناء الخطأ. |
| ManagedHsmKey |
المورد الرئيسي. |
| ManagedHsmKeyAttributes |
سمات الكائن التي تديرها خدمة Azure Key Vault. |
| ManagedHsmKeyCreateParameters |
المعلمات المستخدمة لإنشاء مفتاح. |
| ManagedHsmKeyProperties |
خصائص المفتاح. |
| ManagedHsmKeyReleasePolicy |
واجهة النموذج ManagedHsmKeyReleasePolicy |
| ManagedHsmKeyRotationPolicyAttributes |
واجهة النموذج ManagedHsmKeyRotationPolicyAttributes |
| ManagedHsmKeysCreateIfNotExistOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmKeysGetOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmKeysGetVersionOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmKeysListOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmKeysListVersionsOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmKeysOperations |
واجهة تمثل عمليات ManagedHsmKeys. |
| ManagedHsmLifetimeAction |
واجهة النموذج ManagedHsmLifetimeAction |
| ManagedHsmProperties |
خصائص تجمع HSM المدار |
| ManagedHsmRotationPolicy |
واجهة النموذج ManagedHsmRotationPolicy |
| ManagedHsmSku |
تفاصيل SKU |
| ManagedHsmTrigger |
واجهة النموذج ManagedHsmTrigger |
| ManagedHsmsCheckMhsmNameAvailabilityOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsCreateOrUpdateOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsDeleteOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsGetDeletedOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsGetOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsListByResourceGroupOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsListBySubscriptionOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsListDeletedOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsOperations |
واجهة تمثل عمليات ManagedHsms. |
| ManagedHsmsPurgeDeletedOptionalParams |
المعلمات الاختيارية. |
| ManagedHsmsUpdateOptionalParams |
المعلمات الاختيارية. |
| ManagedServiceIdentity |
هوية الخدمة المدارة (النظام المعين و/أو الهويات المعينة من قبل المستخدم) |
| MetricSpecification |
مواصفات القياس للعملية. |
| MhsmGeoReplicatedRegion |
منطقة تم توسيع مجموعة HSM المدارة هذه إليها. |
| MhsmNetworkRuleSet |
مجموعة من القواعد التي تحكم إمكانية وصول ذوي الاحتياجات الخاصة إلى الشبكة لتجمع hsm مدار. |
| MhsmPrivateEndpoint |
خصائص كائن نقطة النهاية الخاصة. |
| MhsmPrivateEndpointConnection |
مورد اتصال نقطة النهاية الخاصة. |
| MhsmPrivateEndpointConnectionItem |
عنصر اتصال نقطة النهاية الخاصة. |
| MhsmPrivateEndpointConnectionProperties |
خصائص مورد الاتصال الخاص بنقطة النهاية. |
| MhsmPrivateEndpointConnectionsDeleteOptionalParams |
المعلمات الاختيارية. |
| MhsmPrivateEndpointConnectionsGetOptionalParams |
المعلمات الاختيارية. |
| MhsmPrivateEndpointConnectionsListByResourceOptionalParams |
المعلمات الاختيارية. |
| MhsmPrivateEndpointConnectionsOperations |
واجهة تمثل عمليات MhsmPrivateEndpointConnections. |
| MhsmPrivateEndpointConnectionsPutOptionalParams |
المعلمات الاختيارية. |
| MhsmPrivateLinkResource |
مورد ارتباط خاص |
| MhsmPrivateLinkResourceListResult |
قائمة بموارد الارتباط الخاص |
| MhsmPrivateLinkResourceProperties |
خصائص مورد ارتباط خاص. |
| MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams |
المعلمات الاختيارية. |
| MhsmPrivateLinkResourcesOperations |
واجهة تمثل عمليات MhsmPrivateLinkResources. |
| MhsmPrivateLinkServiceConnectionState |
كائن يمثل حالة الموافقة على اتصال الارتباط الخاص. |
| MhsmRegionsListByResourceOptionalParams |
المعلمات الاختيارية. |
| MhsmRegionsOperations |
واجهة تمثل عمليات MhsmRegions. |
| MhsmServiceTagRule |
قاعدة تحكم إمكانية الوصول إلى مجموعة HSM المدارة من خلال علامات خدمة محددة. |
| MhsmVirtualNetworkRule |
قاعدة تحكم إمكانية الوصول إلى تجمع hsm مدار من شبكة ظاهرية معينة. |
| MhsmipRule |
قاعدة تحكم إمكانية الوصول إلى تجمع HSM مدار من عنوان IP معين أو نطاق IP. |
| NetworkRuleSet |
مجموعة من القواعد التي تحكم إمكانية وصول ذوي الاحتياجات الخاصة إلى الشبكة في المخزن. |
| Operation |
تعريف عملية Key Vault REST API. |
| OperationDisplay |
عرض بيانات التعريف المقترنة بالعملية. |
| OperationProperties |
خصائص التشغيل ، تشمل المواصفات المترية. |
| OperationsListOptionalParams |
المعلمات الاختيارية. |
| OperationsOperations |
واجهة تمثل عمليات العمليات. |
| PageSettings |
خيارات لأسلوب byPage |
| PagedAsyncIterableIterator |
واجهة تسمح بالتكرار غير المتزامن حتى الاكتمال والصفحة. |
| Permissions |
الأذونات التي تمتلكها الهوية للمفاتيح والأسرار والشهادات والتخزين. |
| PrivateEndpoint |
خصائص كائن نقطة النهاية الخاصة. |
| PrivateEndpointConnection |
مورد اتصال نقطة النهاية الخاصة. |
| PrivateEndpointConnectionItem |
عنصر اتصال نقطة النهاية الخاصة. |
| PrivateEndpointConnectionProperties |
خصائص مورد الاتصال الخاص بنقطة النهاية. |
| PrivateEndpointConnectionsDeleteOptionalParams |
المعلمات الاختيارية. |
| PrivateEndpointConnectionsGetOptionalParams |
المعلمات الاختيارية. |
| PrivateEndpointConnectionsListByResourceOptionalParams |
المعلمات الاختيارية. |
| PrivateEndpointConnectionsOperations |
واجهة تمثل عمليات PrivateEndpointConnections. |
| PrivateEndpointConnectionsPutOptionalParams |
المعلمات الاختيارية. |
| PrivateLinkResource |
مورد ارتباط خاص |
| PrivateLinkResourceListResult |
قائمة بموارد الارتباط الخاص |
| PrivateLinkResourceProperties |
خصائص مورد ارتباط خاص. |
| PrivateLinkResourcesListByVaultOptionalParams |
المعلمات الاختيارية. |
| PrivateLinkResourcesOperations |
واجهة تمثل عمليات PrivateLinkResources. |
| PrivateLinkServiceConnectionState |
كائن يمثل حالة الموافقة على اتصال الارتباط الخاص. |
| ProxyResource |
تعريف نموذج المورد لمورد وكيل Azure Resource Manager. لن تحتوي على علامات وموقع |
| Resource |
الحقول الشائعة التي يتم إرجاعها في الاستجابة لكافة موارد Azure Resource Manager |
| RestorePollerOptions | |
| RotationPolicy |
واجهة النموذج سياسة الدوران |
| Secret |
معلومات الموارد مع تفاصيل موسعة. |
| SecretAttributes |
سمات الإدارة السرية. |
| SecretCreateOrUpdateParameters |
معلمات لإنشاء سر أو تحديثه |
| SecretPatchParameters |
معلمات لتصحيح البيانات السرية |
| SecretPatchProperties |
خصائص السر |
| SecretProperties |
خصائص السر |
| SecretsCreateOrUpdateOptionalParams |
المعلمات الاختيارية. |
| SecretsGetOptionalParams |
المعلمات الاختيارية. |
| SecretsListOptionalParams |
المعلمات الاختيارية. |
| SecretsOperations |
واجهة تمثل عمليات الأسرار. |
| SecretsUpdateOptionalParams |
المعلمات الاختيارية. |
| ServiceSpecification |
خاصية واحدة من العمليات، تتضمن مواصفات السجل. |
| SimplePollerLike |
استقصاء بسيط يمكن استخدامه لاستقصاء عملية طويلة الأمد. |
| Sku |
تفاصيل SKU |
| SystemData |
بيانات التعريف المتعلقة بإنشاء المورد والتعديل الأخير له. |
| TrackedResource |
تعريف نموذج المورد لمورد المستوى الأعلى ل Azure Resource Manager الذي يحتوي على "علامات" و"موقع" |
| Trigger |
واجهة النموذج الزناد |
| UserAssignedIdentity |
خصائص الهوية المعينة من قبل المستخدم |
| Vault |
معلومات الموارد مع تفاصيل موسعة. |
| VaultAccessPolicyParameters |
معلمات لتحديث نهج الوصول في مخزن |
| VaultAccessPolicyProperties |
خصائص نهج الوصول إلى المخزن |
| VaultCheckNameAvailabilityParameters |
المعلمات المستخدمة للتحقق من توفر اسم المخزن. |
| VaultCreateOrUpdateParameters |
معلمات لإنشاء مخزن أو تحديثه |
| VaultPatchParameters |
معلمات لإنشاء مخزن أو تحديثه |
| VaultPatchProperties |
خصائص المخزن |
| VaultProperties |
خصائص المخزن |
| VaultsCheckNameAvailabilityOptionalParams |
المعلمات الاختيارية. |
| VaultsCreateOrUpdateOptionalParams |
المعلمات الاختيارية. |
| VaultsDeleteOptionalParams |
المعلمات الاختيارية. |
| VaultsGetDeletedOptionalParams |
المعلمات الاختيارية. |
| VaultsGetOptionalParams |
المعلمات الاختيارية. |
| VaultsListByResourceGroupOptionalParams |
المعلمات الاختيارية. |
| VaultsListBySubscriptionOptionalParams |
المعلمات الاختيارية. |
| VaultsListDeletedOptionalParams |
المعلمات الاختيارية. |
| VaultsListOptionalParams |
المعلمات الاختيارية. |
| VaultsOperations |
واجهة تمثل عمليات Vaults. |
| VaultsPurgeDeletedOptionalParams |
المعلمات الاختيارية. |
| VaultsUpdateAccessPolicyOptionalParams |
المعلمات الاختيارية. |
| VaultsUpdateOptionalParams |
المعلمات الاختيارية. |
| VirtualNetworkRule |
قاعدة تحكم إمكانية الوصول إلى مخزن من شبكة ظاهرية معينة. |
النوع أسماء مستعارة
| AccessPolicyUpdateKind |
نوع الوصولالسياسةتحديثالنوع |
| ActionsRequired |
رسالة تشير إلى ما إذا كانت التغييرات على موفر الخدمة تتطلب أي تحديثات على المستهلك. القيم المعروفة التي تدعمها الخدمةبلا |
| ActivationStatus |
حالة التفعيل القيم المعروفة التي تدعمها الخدمة
Active: تجمع HSM المدار نشط. |
| AzureSupportedClouds |
القيم المدعومة لإعداد السحابة كنوع حرفي للسلسلة |
| CertificatePermissions |
نوع الشهادات الأذونات |
| ContinuablePage |
واجهة تصف صفحة من النتائج. |
| CreateMode |
وضع إنشاء المخزن للإشارة إلى ما إذا كان المخزن بحاجة إلى استرداد أم لا. |
| CreatedByType |
نوع الكيان الذي أنشأ المورد. القيم المعروفة التي تدعمها الخدمة
user: تم إنشاء الكيان بواسطة مستخدم. |
| DeletionRecoveryLevel |
مستوى استعادة الحذف الساري حاليا للكائن. إذا احتوت على 'قابل للتطهير'، يمكن للمستخدم المميز حذف الكائن بشكل دائم؛ وإلا، فقط النظام يمكنه تطهير الجسم في نهاية فترة الاحتفاظ. القيم المعروفة التي تدعمها الخدمة
القابلة للإزالة |
| GeoReplicationRegionProvisioningState |
حالة التوفير الحالية. القيم المعروفة التي تدعمها الخدمة
التوفير المسبق |
| JsonWebKeyCurveName |
اسم المنحنى الناقص. للحصول على قيم صالحة، راجع JsonWebKeyCurveName. الافتراضي لمفاتيح EC وEC-HSM هو P-256 القيم المعروفة التي تدعمها الخدمة
P-256 |
| JsonWebKeyOperation |
عمليات مفتاح الويب المسموح بها في JSON للمفتاح. لمزيد من المعلومات، راجع JsonWebKeyOperation. القيم المعروفة التي تدعمها الخدمةتشفير |
| JsonWebKeyType |
نوع المفتاح. للحصول على قيم صالحة، راجع JsonWebKeyType. القيم المعروفة التي تدعمها الخدمة
EC |
| KeyPermissions |
نوع المفاتيح الأمور |
| KeyRotationPolicyActionType |
نوع الإجراء. |
| ManagedHsmSkuFamily |
عائلة SKU من تجمع HSM المدار القيم المعروفة التي تدعمها الخدمة
B |
| ManagedHsmSkuName |
SKU لتجمع HSM المدار |
| ManagedServiceIdentityType |
نوع هوية الخدمة المدارة (حيث يسمح بكل من الأنواع SystemAssigned وUserAssigned). القيم المعروفة التي تدعمها الخدمة
بلا: لا توجد هوية مدارة. |
| NetworkRuleAction |
الإجراء الافتراضي عندما لا تتطابق أي قاعدة من ipRules ومن virtualNetworkRules. يتم استخدام هذا فقط بعد تقييم خاصية التجاوز. القيم المعروفة التي تدعمها الخدمةالسماح |
| NetworkRuleBypassOptions |
يوضح حركة المرور التي يمكنها تجاوز قواعد الشبكة. يمكن أن يكون هذا "AzureServices" أو "None". إذا لم يتم تحديد الافتراضي هو "AzureServices". القيم المعروفة التي تدعمها الخدمة
AzureServices |
| PrivateEndpointConnectionProvisioningState |
حالة التوفير الحالية. القيم المعروفة التي تدعمها الخدمةنجاح |
| PrivateEndpointServiceConnectionStatus |
حالة اتصال نقطة النهاية الخاصة. القيم المعروفة التي تدعمها الخدمة
معلق |
| ProvisioningState |
حالة التوفير. القيم المعروفة التي تدعمها الخدمة
نجح: تم توفير تجمع HSM المدار بالكامل. |
| PublicNetworkAccess |
التحكم في الإذن إلى HSM المدار من الشبكات العامة. القيم المعروفة التي تدعمها الخدمة
ممكن |
| Reason |
السبب في عدم إمكانية استخدام اسم الخزنة. عنصر السبب يعاد فقط إذا كان NameAvailable خاطئا. القيم المعروفة التي تدعمها الخدمة
اسم الحساب غير صالح |
| SecretPermissions |
نوع الأصوات السرية |
| SkuFamily |
اسم عائلة SKU القيم المعروفة التي تدعمها الخدمة
|
| SkuName |
اسم SKU لتحديد ما إذا كان مخزن المفاتيح هو مخزن قياسي أو مخزن متميز. |
| StoragePermissions |
نوع التخزينصلاحيات |
| VaultProvisioningState |
حالة توفير المخزن. القيم المعروفة التي تدعمها الخدمةنجاح |
التعدادات
| AzureClouds |
تعداد لوصف بيئات Azure Cloud. |
| KnownActionsRequired |
رسالة تشير إلى ما إذا كانت التغييرات على موفر الخدمة تتطلب أي تحديثات على المستهلك. |
| KnownActivationStatus |
حالة التفعيل |
| KnownCertificatePermissions |
القيم المعروفة CertificatePermissions التي تقبلها الخدمة. |
| KnownCreatedByType |
نوع الكيان الذي أنشأ المورد. |
| KnownDeletionRecoveryLevel |
مستوى استعادة الحذف الساري حاليا للكائن. إذا احتوت على 'قابل للتطهير'، يمكن للمستخدم المميز حذف الكائن بشكل دائم؛ وإلا، فقط النظام يمكنه تطهير الجسم في نهاية فترة الاحتفاظ. |
| KnownGeoReplicationRegionProvisioningState |
حالة التوفير الحالية. |
| KnownJsonWebKeyCurveName |
اسم المنحنى الناقص. للحصول على قيم صالحة، راجع JsonWebKeyCurveName. الافتراضي للمفاتيح EC ومفاتيح EC-HSM هو P-256 |
| KnownJsonWebKeyOperation |
عمليات مفتاح الويب المسموح بها في JSON للمفتاح. لمزيد من المعلومات، راجع JsonWebKeyOperation. |
| KnownJsonWebKeyType |
نوع المفتاح. للحصول على قيم صالحة، راجع JsonWebKeyType. |
| KnownKeyPermissions |
القيم المعروفة KeyPermissions التي تقبلها الخدمة. |
| KnownManagedHsmSkuFamily |
عائلة SKU لتجمع HSM المدار |
| KnownManagedServiceIdentityType |
نوع هوية الخدمة المدارة (حيث يسمح بكل من الأنواع SystemAssigned وUserAssigned). |
| KnownNetworkRuleAction |
الإجراء الافتراضي عندما لا تتطابق أي قاعدة من ipRules ومن virtualNetworkRules. يتم استخدام هذا فقط بعد تقييم خاصية التجاوز. |
| KnownNetworkRuleBypassOptions |
يوضح حركة المرور التي يمكنها تجاوز قواعد الشبكة. يمكن أن يكون هذا "AzureServices" أو "None". إذا لم يتم تحديد الافتراضي هو "AzureServices". |
| KnownPrivateEndpointConnectionProvisioningState |
حالة التوفير الحالية. |
| KnownPrivateEndpointServiceConnectionStatus |
حالة اتصال نقطة النهاية الخاصة. |
| KnownProvisioningState |
حالة التوفير. |
| KnownPublicNetworkAccess |
التحكم في الإذن إلى HSM المدار من الشبكات العامة. |
| KnownReason |
السبب في عدم إمكانية استخدام اسم الخزنة. عنصر السبب يعاد فقط إذا كان NameAvailable خاطئا. |
| KnownSecretPermissions |
القيم المعروفة SecretPermissions التي تقبلها الخدمة. |
| KnownSkuFamily |
اسم عائلة SKU |
| KnownStoragePermissions |
القيم المعروفة StoragePermissions التي تقبلها الخدمة. |
| KnownVaultProvisioningState |
حالة توفير المخزن. |
| KnownVersions |
إصدارات واجهة برمجة التطبيقات المتوفرة. |
الوظائف
| restore |
إنشاء استقصاء من الحالة المتسلسلة لأداة استقصاء أخرى. يمكن أن يكون هذا مفيدا عندما تريد إنشاء استقصاءات على مضيف مختلف أو يحتاج إلى إنشاء أداة استقصاء بعد أن لا تكون الأصلية في النطاق. |
تفاصيل الوظيفة
restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
إنشاء استقصاء من الحالة المتسلسلة لأداة استقصاء أخرى. يمكن أن يكون هذا مفيدا عندما تريد إنشاء استقصاءات على مضيف مختلف أو يحتاج إلى إنشاء أداة استقصاء بعد أن لا تكون الأصلية في النطاق.
function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
المعلمات
- client
- KeyVaultManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
المرتجعات
PollerLike<OperationState<TResult>, TResult>