Backend interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل خلفية.

الأساليب

createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)	إنشاء خلفية أو تحديثها.
delete(string, string, string, string, BackendDeleteOptionalParams)	حذف الواجهة الخلفية المحددة.
get(string, string, string, BackendGetOptionalParams)	يحصل على تفاصيل الواجهة الخلفية المحددة بواسطة معرفها.
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)	الحصول على إصدار حالة الكيان (Etag) للواجهة الخلفية المحددة بواسطة معرفها.
listByService(string, string, BackendListByServiceOptionalParams)	يسرد مجموعة من الخلفيات في مثيل الخدمة المحدد.
reconnect(string, string, string, BackendReconnectOptionalParams)	يقوم بإعلام بوابة إدارة واجهة برمجة التطبيقات لإنشاء اتصال جديد بالواجهة الخلفية بعد المهلة المحددة. إذا لم يتم تحديد مهلة، يتم استخدام مهلة دقيقتين.
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)	تحديث خلفية موجودة.

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

createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)

إنشاء خلفية أو تحديثها.

function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

backendId

string

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

parameters

BackendContract

إنشاء معلمات.

options

BackendCreateOrUpdateOptionalParams

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

المرتجعات

Promise<BackendCreateOrUpdateResponse>

delete(string, string, string, string, BackendDeleteOptionalParams)

حذف الواجهة الخلفية المحددة.

function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

backendId

string

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

ifMatch

string

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

options

BackendDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, BackendGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

backendId

string

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

options

BackendGetOptionalParams

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

المرتجعات

Promise<BackendGetResponse>

getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

backendId

string

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

options

BackendGetEntityTagOptionalParams

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

المرتجعات

Promise<BackendGetEntityTagHeaders>

listByService(string, string, BackendListByServiceOptionalParams)

يسرد مجموعة من الخلفيات في مثيل الخدمة المحدد.

function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

options

BackendListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

reconnect(string, string, string, BackendReconnectOptionalParams)

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

function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

backendId

string

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

options

BackendReconnectOptionalParams

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

المرتجعات

Promise<void>

update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)

تحديث خلفية موجودة.

function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

backendId

string

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

ifMatch

string

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

parameters

BackendUpdateParameters

تحديث المعلمات.

options

BackendUpdateOptionalParams

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

المرتجعات

Promise<BackendUpdateResponse>