Documentation interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en dokumentation.

Metoder

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	Skapar en ny dokumentation eller uppdaterar en befintlig.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	Tar bort den angivna dokumentationen från ett API.
get(string, string, string, DocumentationGetOptionalParams)	Hämtar information om den dokumentation som anges av dess identifierare.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) av dokumentationen efter dess identifierare.
listByService(string, string, DocumentationListByServiceOptionalParams)	Visar en lista över alla dokumentationer för API Management tjänstinstans.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	Uppdateringar information om dokumentationen för ett API som anges av dess identifierare.

Metodinformation

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

Skapar en ny dokumentation eller uppdaterar en befintlig.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

documentationId

string

Dokumentationsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

parameters

DocumentationContract

Skapa parametrar.

options

DocumentationCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<DocumentationCreateOrUpdateResponse>

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

Tar bort den angivna dokumentationen från ett API.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

documentationId

string

Dokumentationsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran eller * för ovillkorlig uppdatering.

options

DocumentationDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Hämtar information om den dokumentation som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

documentationId

string

Dokumentationsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

DocumentationGetOptionalParams

Alternativparametrarna.

Returer

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) av dokumentationen efter dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

documentationId

string

Dokumentationsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

DocumentationGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Visar en lista över alla dokumentationer för API Management tjänstinstans.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

DocumentationListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

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

Uppdateringar information om dokumentationen för ett API som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

documentationId

string

Dokumentationsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran eller * för ovillkorlig uppdatering.

parameters

DocumentationUpdateContract

Parametrar för dokumentationsuppdatering.

options

DocumentationUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<DocumentationUpdateResponse>