ApiTagDescription interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل ApiTagDescription.

الأساليب

createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)	إنشاء/تحديث وصف العلامة في نطاق واجهة برمجة التطبيقات.
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)	حذف وصف العلامة لواجهة برمجة التطبيقات.
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)	الحصول على وصف العلامة في نطاق واجهة برمجة التطبيقات
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)	يحصل على إصدار حالة الكيان للعلامة المحددة بواسطة معرفها.
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)	يسرد جميع أوصاف العلامات في نطاق واجهة برمجة التطبيقات. نموذج مشابه ل swagger - يتم تعريف tagDescription على مستوى واجهة برمجة التطبيقات ولكن قد يتم تعيين العلامة إلى العمليات

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

createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)

إنشاء/تحديث وصف العلامة في نطاق واجهة برمجة التطبيقات.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

tagDescriptionId

string

معرف وصف العلامة. يستخدم عند إنشاء tagDescription لاقتران API/Tag. استنادا إلى API وأسماء العلامات.

parameters

TagDescriptionCreateParameters

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

options

ApiTagDescriptionCreateOrUpdateOptionalParams

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

المرتجعات

Promise<ApiTagDescriptionCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)

حذف وصف العلامة لواجهة برمجة التطبيقات.

function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

tagDescriptionId

string

معرف وصف العلامة. يستخدم عند إنشاء tagDescription لاقتران API/Tag. استنادا إلى API وأسماء العلامات.

ifMatch

string

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

options

ApiTagDescriptionDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, string, ApiTagDescriptionGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

tagDescriptionId

string

معرف وصف العلامة. يستخدم عند إنشاء tagDescription لاقتران API/Tag. استنادا إلى API وأسماء العلامات.

options

ApiTagDescriptionGetOptionalParams

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

المرتجعات

Promise<ApiTagDescriptionGetResponse>

getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

tagDescriptionId

string

معرف وصف العلامة. يستخدم عند إنشاء tagDescription لاقتران API/Tag. استنادا إلى API وأسماء العلامات.

options

ApiTagDescriptionGetEntityTagOptionalParams

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

المرتجعات

Promise<ApiTagDescriptionGetEntityTagHeaders>

listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)

يسرد جميع أوصاف العلامات في نطاق واجهة برمجة التطبيقات. نموذج مشابه ل swagger - يتم تعريف tagDescription على مستوى واجهة برمجة التطبيقات ولكن قد يتم تعيين العلامة إلى العمليات

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

options

ApiTagDescriptionListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>