Group interface

الحزمة:

@azure/arm-apimanagement

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

الأساليب

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)	إنشاء مجموعة أو تحديثها.
delete(string, string, string, string, GroupDeleteOptionalParams)	حذف مجموعة معينة من مثيل خدمة APIM.
get(string, string, string, GroupGetOptionalParams)	الحصول على تفاصيل المجموعة المحددة بواسطة معرفها.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)	الحصول على إصدار حالة الكيان (Etag) للمجموعة المحددة بواسطة معرفها.
listByService(string, string, GroupListByServiceOptionalParams)	يسرد مجموعة من المجموعات المعرفة داخل مثيل خدمة.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)	تحديث تفاصيل المجموعة المحددة بواسطة معرفها.

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

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

groupId

string

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

parameters

GroupCreateParameters

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

options

GroupCreateOrUpdateOptionalParams

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

المرتجعات

Promise<GroupCreateOrUpdateResponse>

delete(string, string, string, string, GroupDeleteOptionalParams)

حذف مجموعة معينة من مثيل خدمة APIM.

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

groupId

string

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

ifMatch

string

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

options

GroupDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, GroupGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

groupId

string

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

options

GroupGetOptionalParams

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

المرتجعات

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

groupId

string

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

options

GroupGetEntityTagOptionalParams

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

المرتجعات

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

options

GroupListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

groupId

string

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

ifMatch

string

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

parameters

GroupUpdateParameters

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

options

GroupUpdateOptionalParams

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

المرتجعات

Promise<GroupUpdateResponse>