WorkspaceBackend interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل WorkspaceBackend.

الأساليب

createOrUpdate(string, string, string, string, BackendContract, WorkspaceBackendCreateOrUpdateOptionalParams)	إنشاء خلفية أو تحديثها.
delete(string, string, string, string, string, WorkspaceBackendDeleteOptionalParams)	حذف الواجهة الخلفية المحددة.
get(string, string, string, string, WorkspaceBackendGetOptionalParams)	يحصل على تفاصيل الواجهة الخلفية المحددة بواسطة معرفها.
getEntityTag(string, string, string, string, WorkspaceBackendGetEntityTagOptionalParams)	الحصول على إصدار حالة الكيان (Etag) للواجهة الخلفية المحددة بواسطة معرفها.
listByWorkspace(string, string, string, WorkspaceBackendListByWorkspaceOptionalParams)	يسرد مجموعة من الخلفيات في مساحة العمل المحددة.
update(string, string, string, string, string, BackendUpdateParameters, WorkspaceBackendUpdateOptionalParams)	تحديث خلفية موجودة.

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

createOrUpdate(string, string, string, string, BackendContract, WorkspaceBackendCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, parameters: BackendContract, options?: WorkspaceBackendCreateOrUpdateOptionalParams): Promise<WorkspaceBackendCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

backendId

string

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

parameters

BackendContract

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

options

WorkspaceBackendCreateOrUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceBackendCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceBackendDeleteOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

backendId

string

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

ifMatch

string

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

options

WorkspaceBackendDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, string, WorkspaceBackendGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetOptionalParams): Promise<WorkspaceBackendGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

backendId

string

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

options

WorkspaceBackendGetOptionalParams

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

المرتجعات

Promise<WorkspaceBackendGetResponse>

getEntityTag(string, string, string, string, WorkspaceBackendGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetEntityTagOptionalParams): Promise<WorkspaceBackendGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

backendId

string

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

options

WorkspaceBackendGetEntityTagOptionalParams

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

المرتجعات

Promise<WorkspaceBackendGetEntityTagHeaders>

listByWorkspace(string, string, string, WorkspaceBackendListByWorkspaceOptionalParams)

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

function listByWorkspace(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceBackendListByWorkspaceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

options

WorkspaceBackendListByWorkspaceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

update(string, string, string, string, string, BackendUpdateParameters, WorkspaceBackendUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: WorkspaceBackendUpdateOptionalParams): Promise<WorkspaceBackendUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

backendId

string

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

ifMatch

string

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

parameters

BackendUpdateParameters

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

options

WorkspaceBackendUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceBackendUpdateResponse>