Product interface

الحزمة:

@azure/arm-apimanagement

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

الأساليب

createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)	إنشاء منتج أو تحديثه.
delete(string, string, string, string, ProductDeleteOptionalParams)	حذف المنتج.
get(string, string, string, ProductGetOptionalParams)	الحصول على تفاصيل المنتج المحدد بواسطة معرفه.
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)	يحصل على إصدار حالة الكيان (Etag) من المنتج المحدد بواسطة المعرف الخاص به.
listByService(string, string, ProductListByServiceOptionalParams)	يسرد مجموعة من المنتجات في مثيل الخدمة المحدد.
listByTags(string, string, ProductListByTagsOptionalParams)	يسرد مجموعة من المنتجات المقترنة بالعلامات.
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)	تحديث تفاصيل المنتج الموجودة.

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

createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

productId

string

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

parameters

ProductContract

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

options

ProductCreateOrUpdateOptionalParams

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

المرتجعات

Promise<ProductCreateOrUpdateResponse>

delete(string, string, string, string, ProductDeleteOptionalParams)

حذف المنتج.

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

productId

string

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

ifMatch

string

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

options

ProductDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, ProductGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

productId

string

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

options

ProductGetOptionalParams

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

المرتجعات

Promise<ProductGetResponse>

getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

productId

string

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

options

ProductGetEntityTagOptionalParams

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

المرتجعات

Promise<ProductGetEntityTagHeaders>

listByService(string, string, ProductListByServiceOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

options

ProductListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>

listByTags(string, string, ProductListByTagsOptionalParams)

يسرد مجموعة من المنتجات المقترنة بالعلامات.

function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

options

ProductListByTagsOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)

تحديث تفاصيل المنتج الموجودة.

function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

productId

string

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

ifMatch

string

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

parameters

ProductUpdateParameters

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

options

ProductUpdateOptionalParams

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

المرتجعات

Promise<ProductUpdateResponse>