@azure/arm-apicenter package

الفصول

AzureAPICenter

الواجهات

Api

كيان واجهة برمجة التطبيقات.

ApiDefinition

كيان تعريف واجهة برمجة التطبيقات.

ApiDefinitionListResult

استجابة عملية قائمة ApiDefinition.

ApiDefinitionProperties

كيان خصائص تعريف واجهة برمجة التطبيقات.

ApiDefinitionPropertiesSpecification

تفاصيل مواصفات واجهة برمجة التطبيقات.

ApiDefinitions

واجهة تمثل ApiDefinitions.

ApiDefinitionsCreateOrUpdateHeaders

تعريف الرؤوس لعملية ApiDefinitions_createOrUpdate.

ApiDefinitionsCreateOrUpdateOptionalParams

المعلمات الاختيارية.

ApiDefinitionsDeleteOptionalParams

المعلمات الاختيارية.

ApiDefinitionsExportSpecificationHeaders

تعريف الرؤوس لعملية ApiDefinitions_exportSpecification.

ApiDefinitionsExportSpecificationOptionalParams

المعلمات الاختيارية.

ApiDefinitionsGetHeaders

تعريف الرؤوس لعملية ApiDefinitions_get.

ApiDefinitionsGetOptionalParams

المعلمات الاختيارية.

ApiDefinitionsHeadOptionalParams

المعلمات الاختيارية.

ApiDefinitionsImportSpecificationHeaders

تعريف الرؤوس لعملية ApiDefinitions_importSpecification.

ApiDefinitionsImportSpecificationOptionalParams

المعلمات الاختيارية.

ApiDefinitionsListNextOptionalParams

المعلمات الاختيارية.

ApiDefinitionsListOptionalParams

المعلمات الاختيارية.

ApiListResult

استجابة عملية قائمة واجهة برمجة التطبيقات.

ApiProperties

خصائص واجهة برمجة التطبيقات.

ApiSpecExportResult

نتيجة تصدير مواصفات واجهة برمجة التطبيقات.

ApiSpecImportRequest

خصائص كيان مصدر مواصفات واجهة برمجة التطبيقات.

ApiSpecImportRequestSpecification

تفاصيل مواصفات واجهة برمجة التطبيقات.

ApiVersion

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

ApiVersionListResult

استجابة عملية قائمة ApiVersion.

ApiVersionProperties

كيان خصائص إصدار واجهة برمجة التطبيقات.

ApiVersions

واجهة تمثل ApiVersions.

ApiVersionsCreateOrUpdateHeaders

تعريف الرؤوس لعملية ApiVersions_createOrUpdate.

ApiVersionsCreateOrUpdateOptionalParams

المعلمات الاختيارية.

ApiVersionsDeleteOptionalParams

المعلمات الاختيارية.

ApiVersionsGetHeaders

تعريف الرؤوس لعملية ApiVersions_get.

ApiVersionsGetOptionalParams

المعلمات الاختيارية.

ApiVersionsHeadOptionalParams

المعلمات الاختيارية.

ApiVersionsListNextOptionalParams

المعلمات الاختيارية.

ApiVersionsListOptionalParams

المعلمات الاختيارية.

Apis

واجهة تمثل Apis.

ApisCreateOrUpdateHeaders

تعريف الرؤوس لعملية Apis_createOrUpdate.

ApisCreateOrUpdateOptionalParams

المعلمات الاختيارية.

ApisDeleteOptionalParams

المعلمات الاختيارية.

ApisGetHeaders

تعريف الرؤوس لعملية Apis_get.

ApisGetOptionalParams

المعلمات الاختيارية.

ApisHeadOptionalParams

المعلمات الاختيارية.

ApisListNextOptionalParams

المعلمات الاختيارية.

ApisListOptionalParams

المعلمات الاختيارية.

AzureAPICenterOptionalParams

المعلمات الاختيارية.

Contact

معلومات جهة الاتصال

Deployment

كيان توزيع واجهة برمجة التطبيقات.

DeploymentListResult

استجابة عملية قائمة التوزيع.

DeploymentProperties

خصائص كيان توزيع واجهة برمجة التطبيقات.

DeploymentServer

ملقم

Deployments

واجهة تمثل عمليات النشر.

DeploymentsCreateOrUpdateHeaders

تعريف الرؤوس لعملية Deployments_createOrUpdate.

DeploymentsCreateOrUpdateOptionalParams

المعلمات الاختيارية.

DeploymentsDeleteOptionalParams

المعلمات الاختيارية.

DeploymentsGetHeaders

تعريف الرؤوس لعملية Deployments_get.

DeploymentsGetOptionalParams

المعلمات الاختيارية.

DeploymentsHeadOptionalParams

المعلمات الاختيارية.

DeploymentsListNextOptionalParams

المعلمات الاختيارية.

DeploymentsListOptionalParams

المعلمات الاختيارية.

Environment

كيان البيئة.

EnvironmentListResult

استجابة عملية قائمة البيئة.

EnvironmentProperties

كيان خصائص البيئة.

EnvironmentServer

معلومات الخادم للبيئة.

Environments

واجهة تمثل بيئات.

EnvironmentsCreateOrUpdateHeaders

تعريف الرؤوس لعملية Environments_createOrUpdate.

EnvironmentsCreateOrUpdateOptionalParams

المعلمات الاختيارية.

EnvironmentsDeleteOptionalParams

المعلمات الاختيارية.

EnvironmentsGetHeaders

تعريف الرؤوس لعملية Environments_get.

EnvironmentsGetOptionalParams

المعلمات الاختيارية.

EnvironmentsHeadOptionalParams

المعلمات الاختيارية.

EnvironmentsListNextOptionalParams

المعلمات الاختيارية.

EnvironmentsListOptionalParams

المعلمات الاختيارية.

ErrorAdditionalInfo

خطأ إدارة الموارد معلومات إضافية.

ErrorDetail

تفاصيل الخطأ.

ErrorResponse

استجابة الخطأ الشائعة لجميع واجهات برمجة تطبيقات Azure Resource Manager لإرجاع تفاصيل الخطأ للعمليات الفاشلة. (يتبع هذا أيضا تنسيق استجابة خطأ OData.).

ExternalDocumentation

وثائق خارجية إضافية لواجهة برمجة التطبيقات.

License

معلومات الترخيص لواجهة برمجة التطبيقات.

ManagedServiceIdentity

هوية الخدمة المدارة (النظام المعين و/أو الهويات المعينة من قبل المستخدم)

MetadataAssignment

بيانات تعريف التعيين

MetadataSchema

كيان مخطط بيانات التعريف. يستخدم لتعريف بيانات التعريف للكيانات في كتالوج واجهة برمجة التطبيقات.

MetadataSchemaExportRequest

طلب تصدير مخطط بيانات التعريف.

MetadataSchemaExportResult

نتيجة تصدير مخطط بيانات التعريف.

MetadataSchemaListResult

استجابة عملية قائمة MetadataSchema.

MetadataSchemaProperties

خصائص مخطط بيانات التعريف.

MetadataSchemas

واجهة تمثل MetadataSchemas.

MetadataSchemasCreateOrUpdateHeaders

تعريف الرؤوس لعملية MetadataSchemas_createOrUpdate.

MetadataSchemasCreateOrUpdateOptionalParams

المعلمات الاختيارية.

MetadataSchemasDeleteOptionalParams

المعلمات الاختيارية.

MetadataSchemasGetHeaders

تعريف الرؤوس لعملية MetadataSchemas_get.

MetadataSchemasGetOptionalParams

المعلمات الاختيارية.

MetadataSchemasHeadOptionalParams

المعلمات الاختيارية.

MetadataSchemasListNextOptionalParams

المعلمات الاختيارية.

MetadataSchemasListOptionalParams

المعلمات الاختيارية.

Onboarding

معلومات الإلحاق

Operation

تفاصيل عملية REST API، التي تم إرجاعها من واجهة برمجة تطبيقات عمليات موفر الموارد

OperationDisplay

معلومات العرض المترجمة لهذه العملية المعينة.

OperationListResult

قائمة بعمليات REST API التي يدعمها موفر موارد Azure. يحتوي على ارتباط URL للحصول على المجموعة التالية من النتائج.

Operations

واجهة تمثل عمليات.

OperationsListNextOptionalParams

المعلمات الاختيارية.

OperationsListOptionalParams

المعلمات الاختيارية.

ProxyResource

تعريف نموذج المورد لمورد وكيل Azure Resource Manager. لن تحتوي على علامات وموقع

Resource

الحقول الشائعة التي يتم إرجاعها في الاستجابة لكافة موارد Azure Resource Manager

Service

كيان الخدمة.

ServiceListResult

استجابة عملية قائمة الخدمة.

ServiceProperties

خصائص الخدمة.

ServiceUpdate

النوع المستخدم لعمليات التحديث للخدمة.

Services

واجهة تمثل خدمات.

ServicesCreateOrUpdateOptionalParams

المعلمات الاختيارية.

ServicesDeleteOptionalParams

المعلمات الاختيارية.

ServicesExportMetadataSchemaHeaders

تعريف الرؤوس لعملية Services_exportMetadataSchema.

ServicesExportMetadataSchemaOptionalParams

المعلمات الاختيارية.

ServicesGetOptionalParams

المعلمات الاختيارية.

ServicesListByResourceGroupNextOptionalParams

المعلمات الاختيارية.

ServicesListByResourceGroupOptionalParams

المعلمات الاختيارية.

ServicesListBySubscriptionNextOptionalParams

المعلمات الاختيارية.

ServicesListBySubscriptionOptionalParams

المعلمات الاختيارية.

ServicesUpdateOptionalParams

المعلمات الاختيارية.

SystemData

بيانات التعريف المتعلقة بإنشاء المورد والتعديل الأخير له.

TermsOfService

شروط الخدمة لواجهة برمجة التطبيقات.

TrackedResource

تعريف نموذج المورد لمورد المستوى الأعلى ل Azure Resource Manager الذي يحتوي على "علامات" و"موقع"

UserAssignedIdentity

خصائص الهوية المعينة من قبل المستخدم

Workspace

كيان مساحة العمل.

WorkspaceListResult

استجابة عملية قائمة مساحة العمل.

WorkspaceProperties

خصائص مساحة العمل.

Workspaces

واجهة تمثل مساحات عمل.

WorkspacesCreateOrUpdateHeaders

تعريف الرؤوس لعملية Workspaces_createOrUpdate.

WorkspacesCreateOrUpdateOptionalParams

المعلمات الاختيارية.

WorkspacesDeleteOptionalParams

المعلمات الاختيارية.

WorkspacesGetHeaders

تعريف الرؤوس لعملية Workspaces_get.

WorkspacesGetOptionalParams

المعلمات الاختيارية.

WorkspacesHeadOptionalParams

المعلمات الاختيارية.

WorkspacesListNextOptionalParams

المعلمات الاختيارية.

WorkspacesListOptionalParams

المعلمات الاختيارية.

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

ActionType

تعريف قيم ActionType.
يمكن استخدام KnownActionType بالتبادل مع ActionType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

الداخلية

ApiDefinitionsCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

ApiDefinitionsExportSpecificationResponse

يحتوي على بيانات استجابة لعملية exportSpecification.

ApiDefinitionsGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

ApiDefinitionsHeadResponse

يحتوي على بيانات استجابة لعملية الرأس.

ApiDefinitionsListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

ApiDefinitionsListResponse

يحتوي على بيانات استجابة لعملية القائمة.

ApiKind

تعريف قيم ApiKind.
KnownApiKind يمكن استخدامها بالتبادل مع ApiKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

بقية: Api نقل الحالة التمثيلية
graphql: واجهة برمجة تطبيقات لغة استعلام Graph
grpc: واجهة برمجة تطبيقات gRPC
soap: API SOAP
webhook: خطاف الويب
websocket: مقبس الويب

ApiSpecExportResultFormat

تعريف قيم ApiSpecExportResultFormat.
KnownApiSpecExportResultFormat يمكن استخدامها بالتبادل مع ApiSpecExportResultFormat، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

المضمنة: المحتوى المضمن لمستند المواصفات.
الارتباط: الارتباط إلى نتيجة عملية التصدير. عنوان URL صالح لمدة 5 دقائق.

ApiSpecImportSourceFormat

تعريف قيم ApiSpecImportSourceFormat.
KnownApiSpecImportSourceFormat يمكن استخدامها بالتبادل مع ApiSpecImportSourceFormat، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

المضمنة: المحتوى المضمن لمستند المواصفات.
الارتباط: الارتباط إلى مستند مواصفات مستضاف على عنوان إنترنت يمكن الوصول إليه بشكل عام.

ApiVersionsCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

ApiVersionsGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

ApiVersionsHeadResponse

يحتوي على بيانات استجابة لعملية الرأس.

ApiVersionsListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

ApiVersionsListResponse

يحتوي على بيانات استجابة لعملية القائمة.

ApisCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

ApisGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

ApisHeadResponse

يحتوي على بيانات استجابة لعملية الرأس.

ApisListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

ApisListResponse

يحتوي على بيانات استجابة لعملية القائمة.

CreatedByType

تعريف قيم CreatedByType.
KnownCreatedByType يمكن استخدامها بالتبادل مع CreatedByType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

المستخدم
تطبيق
ManagedIdentity
مفتاح

DeploymentState

تعريف قيم DeploymentState.
يمكن استخدام KnownDeploymentState بالتبادل مع DeploymentState، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

النشطة: الحالة النشطة
غير نشط: حالة غير نشطة

DeploymentsCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

DeploymentsGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

DeploymentsHeadResponse

يحتوي على بيانات استجابة لعملية الرأس.

DeploymentsListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

DeploymentsListResponse

يحتوي على بيانات استجابة لعملية القائمة.

EnvironmentKind

يحدد قيم EnvironmentKind.
KnownEnvironmentKind يمكن استخدامها بالتبادل مع EnvironmentKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

التطوير: بيئة التطوير
اختبار: بيئة الاختبار
التقسيم المرحلي: بيئة التقسيم المرحلي
الإنتاج: بيئة الإنتاج

EnvironmentServerType

تعريف قيم EnvironmentServerType.
KnownEnvironmentServerType يمكن استخدامها بالتبادل مع EnvironmentServerType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

إدارة واجهة برمجة تطبيقات Azure: خادم إدارة واجهة برمجة التطبيقات
خدمة حساب Azure: خادم الحساب
Apigee API Management: خادم Apigee
AWS API Gateway: خادم AWS Api Gateway
بوابة واجهة برمجة تطبيقات: خادم بوابة واجهة برمجة تطبيقات كونغ
Kubernetes: خادم Kubernetes
MuleSoft API Management: خادم Mulesoft Api Management

EnvironmentsCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

EnvironmentsGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

EnvironmentsHeadResponse

يحتوي على بيانات استجابة لعملية الرأس.

EnvironmentsListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

EnvironmentsListResponse

يحتوي على بيانات استجابة لعملية القائمة.

LifecycleStage

تعريف قيم LifecycleStage.
يمكن استخدام KnownLifecycleStage بالتبادل مع LifecycleStage، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

تصميم: مرحلة التصميم
التطوير: مرحلة التطوير
اختبار: مرحلة الاختبار
معاينة: في المعاينة
الإنتاج: في الإنتاج
مهمل: مرحلة مهملة
موقوفة: مرحلة موقوفة

ManagedServiceIdentityType

تعريف قيم ManagedServiceIdentityType.
KnownManagedServiceIdentityType يمكن استخدامها بالتبادل مع ManagedServiceIdentityType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

بلا
SystemAssigned
المستخدم المعين
SystemAssigned,UserAssigned

MetadataAssignmentEntity

تعريف قيم MetadataAssignmentEntity.
يمكن استخدام KnownMetadataAssignmentEntity بالتبادل مع MetadataAssignmentEntity، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

api: معين إلى واجهة برمجة التطبيقات
البيئة: تم التعيين إلى البيئة
النشر: تم التعيين إلى النشر

MetadataSchemaExportFormat

تعريف قيم MetadataSchemaExportFormat.
KnownMetadataSchemaExportFormat يمكن استخدامها بالتبادل مع MetadataSchemaExportFormat، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

المضمنة: المحتوى غير المضمن لمستند مخطط.
الارتباط: الارتباط إلى مستند مخطط. عنوان URL صالح لمدة 5 دقائق.

MetadataSchemasCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

MetadataSchemasGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

MetadataSchemasHeadResponse

يحتوي على بيانات استجابة لعملية الرأس.

MetadataSchemasListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

MetadataSchemasListResponse

يحتوي على بيانات استجابة لعملية القائمة.

OperationsListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

OperationsListResponse

يحتوي على بيانات استجابة لعملية القائمة.

Origin

تعريف قيم الأصل.
يمكن استخدام KnownOrigin بالتبادل مع Origin، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

المستخدم
النظام
المستخدم، النظام

ProvisioningState

تعريف قيم ProvisioningState.
KnownProvisioningState يمكن استخدامها بالتبادل مع ProvisioningState، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

نجح: تم إنشاء المورد.
فشل : فشل إنشاء الموارد.
تم إلغاء: تم إلغاء إنشاء الموارد.

ServicesCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

ServicesExportMetadataSchemaResponse

يحتوي على بيانات الاستجابة لعملية exportMetadataSchema.

ServicesGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

ServicesListByResourceGroupNextResponse

يحتوي على بيانات الاستجابة لعملية listByResourceGroupNext.

ServicesListByResourceGroupResponse

يحتوي على بيانات الاستجابة لعملية listByResourceGroup.

ServicesListBySubscriptionNextResponse

يحتوي على بيانات الاستجابة لعملية listBySubscriptionNext.

ServicesListBySubscriptionResponse

يحتوي على بيانات الاستجابة لعملية listBySubscription.

ServicesUpdateResponse

يحتوي على بيانات الاستجابة لعملية التحديث.

Versions

تعريف قيم الإصدارات.
يمكن استخدام KnownVersions بالتبادل مع الإصدارات، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

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

2024-03-01: إصدار الخدمة الأولي

WorkspacesCreateOrUpdateResponse

يحتوي على بيانات الاستجابة لعملية createOrUpdate.

WorkspacesGetResponse

يحتوي على بيانات استجابة لعملية الحصول على.

WorkspacesHeadResponse

يحتوي على بيانات استجابة لعملية الرأس.

WorkspacesListNextResponse

يحتوي على بيانات الاستجابة لعملية listNext.

WorkspacesListResponse

يحتوي على بيانات استجابة لعملية القائمة.

التعدادات

KnownActionType

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

KnownApiKind

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

KnownApiSpecExportResultFormat

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

KnownApiSpecImportSourceFormat

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

KnownCreatedByType

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

KnownDeploymentState

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

KnownEnvironmentKind

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

KnownEnvironmentServerType

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

KnownLifecycleStage

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

KnownManagedServiceIdentityType

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

KnownMetadataAssignmentEntity

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

KnownMetadataSchemaExportFormat

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

KnownOrigin

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

KnownProvisioningState

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

KnownVersions

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

الوظائف

getContinuationToken(unknown)

بالنظر إلى .value الأخيرة التي ينتجها مكرر byPage، ترجع رمز متابعة يمكن استخدامه لبدء الترحيل من تلك النقطة لاحقا.

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

getContinuationToken(unknown)

بالنظر إلى .value الأخيرة التي ينتجها مكرر byPage، ترجع رمز متابعة يمكن استخدامه لبدء الترحيل من تلك النقطة لاحقا.

function getContinuationToken(page: unknown): string | undefined

المعلمات

page

unknown

كائن من الوصول إلى value على IteratorResult من مكرر byPage.

المرتجعات

string | undefined

رمز المتابعة الذي يمكن تمريره إلى byPage() أثناء المكالمات المستقبلية.