Documentation interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل وثائق.

الأساليب

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	إنشاء وثائق جديدة أو تحديث مستند موجود.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	حذف الوثائق المحددة من واجهة برمجة التطبيقات.
get(string, string, string, DocumentationGetOptionalParams)	الحصول على تفاصيل الوثائق المحددة بواسطة معرفها.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	يحصل على إصدار حالة الكيان (Etag) من الوثائق بواسطة المعرف الخاص به.
listByService(string, string, DocumentationListByServiceOptionalParams)	يسرد كافة وثائق مثيل خدمة APIM.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	تحديث تفاصيل الوثائق لواجهة برمجة التطبيقات المحددة بواسطة معرفها.

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

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

documentationId

string

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

parameters

DocumentationContract

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

options

DocumentationCreateOrUpdateOptionalParams

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

المرتجعات

Promise<DocumentationCreateOrUpdateResponse>

delete(string, string, string, string, DocumentationDeleteOptionalParams)

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

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

documentationId

string

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

ifMatch

string

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

options

DocumentationDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

documentationId

string

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

options

DocumentationGetOptionalParams

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

المرتجعات

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

documentationId

string

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

options

DocumentationGetEntityTagOptionalParams

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

المرتجعات

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

يسرد كافة وثائق مثيل خدمة APIM.

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

options

DocumentationListByServiceOptionalParams

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

المرتجعات

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

documentationId

string

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

ifMatch

string

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

parameters

DocumentationUpdateContract

معلمات تحديث الوثائق.

options

DocumentationUpdateOptionalParams

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

المرتجعات

Promise<DocumentationUpdateResponse>