WorkspaceApiSchema interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل WorkspaceApiSchema.

الأساليب

beginCreateOrUpdate(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)	إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات.
beginCreateOrUpdateAndWait(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)	إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات.
delete(string, string, string, string, string, string, WorkspaceApiSchemaDeleteOptionalParams)	حذف تكوين المخطط في واجهة برمجة التطبيقات.
get(string, string, string, string, string, WorkspaceApiSchemaGetOptionalParams)	احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات.
getEntityTag(string, string, string, string, string, WorkspaceApiSchemaGetEntityTagOptionalParams)	الحصول على إصدار حالة الكيان (Etag) من المخطط المحدد بواسطة المعرف الخاص به.
listByApi(string, string, string, string, WorkspaceApiSchemaListByApiOptionalParams)	احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات.

تفاصيل الأسلوب

beginCreateOrUpdate(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)

إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

workspaceId

string

معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

schemaId

string

معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

parameters

SchemaContract

محتويات المخطط المراد تطبيقها.

options

WorkspaceApiSchemaCreateOrUpdateOptionalParams

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

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)

إنشاء أو تحديث تكوين المخطط لواجهة برمجة التطبيقات.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<WorkspaceApiSchemaCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

workspaceId

string

معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

schemaId

string

معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

parameters

SchemaContract

محتويات المخطط المراد تطبيقها.

options

WorkspaceApiSchemaCreateOrUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceApiSchemaCreateOrUpdateResponse>

delete(string, string, string, string, string, string, WorkspaceApiSchemaDeleteOptionalParams)

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

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, ifMatch: string, options?: WorkspaceApiSchemaDeleteOptionalParams): Promise<void>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

workspaceId

string

معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

schemaId

string

معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

ifMatch

string

ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.

options

WorkspaceApiSchemaDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, string, string, WorkspaceApiSchemaGetOptionalParams)

احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetOptionalParams): Promise<WorkspaceApiSchemaGetResponse>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

workspaceId

string

معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

schemaId

string

معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

options

WorkspaceApiSchemaGetOptionalParams

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

المرتجعات

Promise<WorkspaceApiSchemaGetResponse>

getEntityTag(string, string, string, string, string, WorkspaceApiSchemaGetEntityTagOptionalParams)

الحصول على إصدار حالة الكيان (Etag) من المخطط المحدد بواسطة المعرف الخاص به.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetEntityTagOptionalParams): Promise<WorkspaceApiSchemaGetEntityTagHeaders>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

workspaceId

string

معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

schemaId

string

معرف معرف المخطط. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

options

WorkspaceApiSchemaGetEntityTagOptionalParams

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

المرتجعات

Promise<WorkspaceApiSchemaGetEntityTagHeaders>

listByApi(string, string, string, string, WorkspaceApiSchemaListByApiOptionalParams)

احصل على تكوين المخطط على مستوى واجهة برمجة التطبيقات.

function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

workspaceId

string

معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

options

WorkspaceApiSchemaListByApiOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>