Documentation interface

Csomag:

@azure/arm-apimanagement

Dokumentációt képviselő felület.

Metódusok

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	Létrehoz egy új dokumentációt, vagy frissít egy meglévőt.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	Törli a megadott dokumentációt egy API-ból.
get(string, string, string, DocumentationGetOptionalParams)	Lekéri az azonosító által megadott dokumentáció részleteit.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	Lekéri a dokumentáció entitásállapotának (Etag) verzióját az azonosítója alapján.
listByService(string, string, DocumentationListByServiceOptionalParams)	Felsorolja az API Management szolgáltatáspéldány összes dokumentációját.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	Frissíti az azonosító által megadott API dokumentációjának részleteit.

Metódus adatai

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

Létrehoz egy új dokumentációt, vagy frissít egy meglévőt.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

documentationId

string

Dokumentáció azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

parameters

DocumentationContract

Paraméterek létrehozása.

options

DocumentationCreateOrUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<DocumentationCreateOrUpdateResponse>

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

Törli a megadott dokumentációt egy API-ból.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

documentationId

string

Dokumentáció azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

options

DocumentationDeleteOptionalParams

A beállítások paraméterei.

Válaszok

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Lekéri az azonosító által megadott dokumentáció részleteit.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

documentationId

string

Dokumentáció azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

DocumentationGetOptionalParams

A beállítások paraméterei.

Válaszok

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Lekéri a dokumentáció entitásállapotának (Etag) verzióját az azonosítója alapján.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

documentationId

string

Dokumentáció azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

DocumentationGetEntityTagOptionalParams

A beállítások paraméterei.

Válaszok

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Felsorolja az API Management szolgáltatáspéldány összes dokumentációját.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

options

DocumentationListByServiceOptionalParams

A beállítások paraméterei.

Válaszok

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

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

Frissíti az azonosító által megadott API dokumentációjának részleteit.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

documentationId

string

Dokumentáció azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

parameters

DocumentationUpdateContract

Dokumentációfrissítési paraméterek.

options

DocumentationUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<DocumentationUpdateResponse>