Workspace interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل مساحة عمل.

الأساليب

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)	إنشاء مساحة عمل جديدة أو تحديث مساحة عمل موجودة.
delete(string, string, string, string, WorkspaceDeleteOptionalParams)	يحذف مساحة العمل المحددة.
get(string, string, string, WorkspaceGetOptionalParams)	يحصل على تفاصيل مساحة العمل المحددة بواسطة المعرف الخاص بها.
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)	يحصل على إصدار حالة الكيان (Etag) لمساحة العمل المحددة بواسطة المعرف الخاص بها.
listByService(string, string, WorkspaceListByServiceOptionalParams)	يسرد جميع مساحات العمل لمثيل خدمة إدارة واجهة برمجة التطبيقات.
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)	تحديث تفاصيل مساحة العمل المحددة بواسطة المعرف الخاص بها.

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

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

parameters

WorkspaceContract

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

options

WorkspaceCreateOrUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceCreateOrUpdateResponse>

delete(string, string, string, string, WorkspaceDeleteOptionalParams)

يحذف مساحة العمل المحددة.

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

ifMatch

string

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

options

WorkspaceDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, WorkspaceGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

options

WorkspaceGetOptionalParams

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

المرتجعات

Promise<WorkspaceGetResponse>

getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

options

WorkspaceGetEntityTagOptionalParams

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

المرتجعات

Promise<WorkspaceGetEntityTagHeaders>

listByService(string, string, WorkspaceListByServiceOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

options

WorkspaceListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

ifMatch

string

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

parameters

WorkspaceContract

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

options

WorkspaceUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceUpdateResponse>