WorkspaceApi interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل WorkspaceApi.

الأساليب

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	إنشاء واجهة برمجة تطبيقات جديدة أو تحديث واجهة برمجة تطبيقات محددة موجودة لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	إنشاء واجهة برمجة تطبيقات جديدة أو تحديث واجهة برمجة تطبيقات محددة موجودة لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)	يحذف واجهة برمجة التطبيقات المحددة لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
get(string, string, string, string, WorkspaceApiGetOptionalParams)	يحصل على تفاصيل واجهة برمجة التطبيقات المحددة بواسطة معرفها.
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)	الحصول على إصدار حالة الكيان (Etag) من واجهة برمجة التطبيقات المحددة بواسطة معرفها.
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)	يسرد جميع واجهات برمجة التطبيقات لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)	يقوم بتحديث واجهة برمجة التطبيقات المحددة لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.

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

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

apiId

string

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

parameters

ApiCreateOrUpdateParameter

إنشاء معلمات أو تحديثها.

options

WorkspaceApiCreateOrUpdateOptionalParams

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

المرتجعات

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

beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

apiId

string

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

parameters

ApiCreateOrUpdateParameter

إنشاء معلمات أو تحديثها.

options

WorkspaceApiCreateOrUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceApiCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)

يحذف واجهة برمجة التطبيقات المحددة لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

apiId

string

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

ifMatch

string

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

options

WorkspaceApiDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, string, WorkspaceApiGetOptionalParams)

يحصل على تفاصيل واجهة برمجة التطبيقات المحددة بواسطة معرفها.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

apiId

string

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

options

WorkspaceApiGetOptionalParams

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

المرتجعات

Promise<WorkspaceApiGetResponse>

getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

apiId

string

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

options

WorkspaceApiGetEntityTagOptionalParams

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

المرتجعات

Promise<WorkspaceApiGetEntityTagHeaders>

listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)

يسرد جميع واجهات برمجة التطبيقات لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

options

WorkspaceApiListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)

يقوم بتحديث واجهة برمجة التطبيقات المحددة لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

apiId

string

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

ifMatch

string

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

parameters

ApiUpdateContract

معلمات عقد تحديث واجهة برمجة التطبيقات.

options

WorkspaceApiUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceApiUpdateResponse>