Documentation interface

Paket:

@azure/arm-apimanagement

Antarmuka yang mewakili Dokumentasi.

Metode

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	Membuat Dokumentasi baru atau memperbarui dokumen yang sudah ada.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	Menghapus Dokumentasi yang ditentukan dari API.
get(string, string, string, DocumentationGetOptionalParams)	Mendapatkan detail Dokumentasi yang ditentukan oleh pengidentifikasinya.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	Mendapatkan versi status entitas (Etag) dari Dokumentasi oleh pengidentifikasinya.
listByService(string, string, DocumentationListByServiceOptionalParams)	Mencantumkan semua Dokumentasi instans layanan API Management.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	Memperbarui detail Dokumentasi untuk API yang ditentukan oleh pengidentifikasinya.

Detail Metode

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

Membuat Dokumentasi baru atau memperbarui dokumen yang sudah ada.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

documentationId

string

Pengidentifikasi dokumentasi. Harus unik dalam instans layanan API Management saat ini.

parameters

DocumentationContract

Buat parameter.

options

DocumentationCreateOrUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<DocumentationCreateOrUpdateResponse>

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

Menghapus Dokumentasi yang ditentukan dari API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

documentationId

string

Pengidentifikasi dokumentasi. Harus unik dalam instans layanan API Management saat ini.

ifMatch

string

ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

options

DocumentationDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Mendapatkan detail Dokumentasi yang ditentukan oleh pengidentifikasinya.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

documentationId

string

Pengidentifikasi dokumentasi. Harus unik dalam instans layanan API Management saat ini.

options

DocumentationGetOptionalParams

Parameter opsi.

Mengembalikan

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Mendapatkan versi status entitas (Etag) dari Dokumentasi oleh pengidentifikasinya.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

documentationId

string

Pengidentifikasi dokumentasi. Harus unik dalam instans layanan API Management saat ini.

options

DocumentationGetEntityTagOptionalParams

Parameter opsi.

Mengembalikan

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Mencantumkan semua Dokumentasi instans layanan API Management.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

options

DocumentationListByServiceOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

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

Memperbarui detail Dokumentasi untuk API yang ditentukan oleh pengidentifikasinya.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

documentationId

string

Pengidentifikasi dokumentasi. Harus unik dalam instans layanan API Management saat ini.

ifMatch

string

ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

parameters

DocumentationUpdateContract

Parameter Pembaruan Dokumentasi.

options

DocumentationUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<DocumentationUpdateResponse>