WorkspaceGroup interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل WorkspaceGroup.

الأساليب

createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)	إنشاء مجموعة أو تحديثها.
delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)	يحذف مجموعة معينة من مساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
get(string, string, string, string, WorkspaceGroupGetOptionalParams)	الحصول على تفاصيل المجموعة المحددة بواسطة معرفها.
getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)	الحصول على إصدار حالة الكيان (Etag) للمجموعة المحددة بواسطة معرفها.
listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)	يسرد مجموعة من المجموعات المحددة داخل مساحة عمل في مثيل خدمة.
update(string, string, string, string, string, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)	تحديث تفاصيل المجموعة المحددة بواسطة معرفها.

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

createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, parameters: GroupCreateParameters, options?: WorkspaceGroupCreateOrUpdateOptionalParams): Promise<WorkspaceGroupCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

groupId

string

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

parameters

GroupCreateParameters

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

options

WorkspaceGroupCreateOrUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceGroupCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

groupId

string

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

ifMatch

string

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

options

WorkspaceGroupDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, string, WorkspaceGroupGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetOptionalParams): Promise<WorkspaceGroupGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

groupId

string

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

options

WorkspaceGroupGetOptionalParams

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

المرتجعات

Promise<WorkspaceGroupGetResponse>

getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetEntityTagOptionalParams): Promise<WorkspaceGroupGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

groupId

string

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

options

WorkspaceGroupGetEntityTagOptionalParams

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

المرتجعات

Promise<WorkspaceGroupGetEntityTagHeaders>

listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

options

WorkspaceGroupListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

update(string, string, string, string, string, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: WorkspaceGroupUpdateOptionalParams): Promise<WorkspaceGroupUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

workspaceId

string

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

groupId

string

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

ifMatch

string

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

parameters

GroupUpdateParameters

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

options

WorkspaceGroupUpdateOptionalParams

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

المرتجعات

Promise<WorkspaceGroupUpdateResponse>