SchemaContract interface
تفاصيل تعاقد مخطط واجهة برمجة التطبيقات.
- يمتد
الخصائص
| components | تعريفات الأنواع. يستخدم لمخططات Swagger/OpenAPI v2/v3 فقط، فارغة بخلاف ذلك. |
| content |
يجب أن يكون نوع وسائط صالحا يستخدم في رأس نوع المحتوى كما هو محدد في RFC 2616. نوع الوسائط لمستند المخطط (على سبيل المثال، application/json، application/xml).
|
| definitions | تعريفات الأنواع. يستخدم لمخططات Swagger/OpenAPI v1 فقط، فارغة بخلاف ذلك. |
| provisioning |
ملاحظة حالة التوفير: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| value | تم إلغاء سلسلة Json التي تعرف المستند الذي يمثل المخطط. يستخدم للمخططات غير Swagger/OpenAPI. |
الخصائص الموروثة
| id | معرف المورد المؤهل بالكامل للمورد. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| name | اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
| type | نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم. |
تفاصيل الخاصية
components
تعريفات الأنواع. يستخدم لمخططات Swagger/OpenAPI v2/v3 فقط، فارغة بخلاف ذلك.
components?: Record<string, unknown>
قيمة الخاصية
Record<string, unknown>
contentType
يجب أن يكون نوع وسائط صالحا يستخدم في رأس نوع المحتوى كما هو محدد في RFC 2616. نوع الوسائط لمستند المخطط (على سبيل المثال، application/json، application/xml).
-
Swaggerاستخدام application/vnd.ms-azure-apim.swagger.definitions+json - WSDL المخطط استخدام المخططOpenApi - application/vnd.ms-azure-apim.xsd+xml استخدام المخططapplication/vnd.oai.openapi.components+jsonWADL Schema - استخدام - gRPC Schemaapplication/vnd.ms-azure-apim.wadl.grammars+xml - text/protobufOData Schemaapplication/vnd.ms-azure-apim.odata.schema
استخدام الاستخدام .
contentType?: string
قيمة الخاصية
string
definitions
تعريفات الأنواع. يستخدم لمخططات Swagger/OpenAPI v1 فقط، فارغة بخلاف ذلك.
definitions?: Record<string, unknown>
قيمة الخاصية
Record<string, unknown>
provisioningState
ملاحظة حالة التوفير: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
provisioningState?: string
قيمة الخاصية
string
value
تم إلغاء سلسلة Json التي تعرف المستند الذي يمثل المخطط. يستخدم للمخططات غير Swagger/OpenAPI.
value?: string
قيمة الخاصية
string
تفاصيل الخاصية الموروثة
id
معرف المورد المؤهل بالكامل للمورد. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
id?: string
قيمة الخاصية
string
موروث منProxyResource.id
name
اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
name?: string
قيمة الخاصية
string
موروث منProxyResource.name
type
نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
type?: string
قيمة الخاصية
string
موروث منProxyResource.type