ApiSchema interface
واجهة تمثل ApiSchema.
الأساليب
| begin |
إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات. |
| begin |
إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات. |
| delete(string, string, string, string, string, Api |
حذف تكوين المخطط في واجهة برمجة التطبيقات. |
| get(string, string, string, string, Api |
احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات. |
| get |
الحصول على إصدار حالة الكيان (Etag) من المخطط المحدد بواسطة المعرف الخاص به. |
| list |
احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات. |
تفاصيل الأسلوب
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- schemaId
-
string
معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- parameters
- SchemaContract
محتويات المخطط المراد تطبيقها.
معلمات الخيارات.
المرتجعات
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- schemaId
-
string
معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- parameters
- SchemaContract
محتويات المخطط المراد تطبيقها.
معلمات الخيارات.
المرتجعات
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
حذف تكوين المخطط في واجهة برمجة التطبيقات.
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- schemaId
-
string
معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- options
- ApiSchemaDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات.
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- schemaId
-
string
معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- ApiSchemaGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
الحصول على إصدار حالة الكيان (Etag) من المخطط المحدد بواسطة المعرف الخاص به.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- schemaId
-
string
معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- options
- ApiSchemaListByApiOptionalParams
معلمات الخيارات.