GatewayApi interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل GatewayApi.

الأساليب

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)	إضافة واجهة برمجة تطبيقات إلى البوابة المحددة.
delete(string, string, string, string, GatewayApiDeleteOptionalParams)	حذف واجهة برمجة التطبيقات المحددة من البوابة المحددة.
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)	التحقق من أن كيان واجهة برمجة التطبيقات المحدد بواسطة المعرف مقترن بكيان البوابة.
listByService(string, string, string, GatewayApiListByServiceOptionalParams)	يسرد مجموعة من واجهات برمجة التطبيقات المقترنة ببوابة.

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

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

إضافة واجهة برمجة تطبيقات إلى البوابة المحددة.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

gatewayId

string

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

apiId

string

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

options

GatewayApiCreateOrUpdateOptionalParams

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

المرتجعات

Promise<ApiContract>

delete(string, string, string, string, GatewayApiDeleteOptionalParams)

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

function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

gatewayId

string

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

apiId

string

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

options

GatewayApiDeleteOptionalParams

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

المرتجعات

Promise<void>

getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

gatewayId

string

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

apiId

string

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

options

GatewayApiGetEntityTagOptionalParams

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

المرتجعات

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

gatewayId

string

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

options

GatewayApiListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>