ProductWiki interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en ProductWiki.

Metoder

createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)	Skapar en ny Wiki för en produkt eller uppdaterar en befintlig.
delete(string, string, string, string, ProductWikiDeleteOptionalParams)	Tar bort den angivna Wiki-sidan från en produkt.
get(string, string, string, ProductWikiGetOptionalParams)	Hämtar information om Wiki för en produkt som anges av dess identifierare.
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) av Wiki för en produkt som anges av dess identifierare.
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)	Uppdateringar information om wikin för en produkt som anges av dess identifierare.

Metodinformation

createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)

Skapar en ny Wiki för en produkt eller uppdaterar en befintlig.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: WikiContract, options?: ProductWikiCreateOrUpdateOptionalParams): Promise<ProductWikiCreateOrUpdateResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

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

parameters

WikiContract

Skapa parametrar.

options

ProductWikiCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ProductWikiCreateOrUpdateResponse>

delete(string, string, string, string, ProductWikiDeleteOptionalParams)

Tar bort den angivna Wiki-sidan från en produkt.

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

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. 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 så bör det vara * för ovillkorlig uppdatering.

options

ProductWikiDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, ProductWikiGetOptionalParams)

Hämtar information om Wiki för en produkt som anges av dess identifierare.

function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetOptionalParams): Promise<ProductWikiGetResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

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

options

ProductWikiGetOptionalParams

Alternativparametrarna.

Returer

Promise<ProductWikiGetResponse>

getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) av Wiki för en produkt som anges av dess identifierare.

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetEntityTagOptionalParams): Promise<ProductWikiGetEntityTagHeaders>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

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

options

ProductWikiGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<ProductWikiGetEntityTagHeaders>

update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)

Uppdateringar information om wikin för en produkt som anges av dess identifierare.

function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ProductWikiUpdateOptionalParams): Promise<ProductWikiUpdateResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

productId

string

Produktidentifierare. 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 så bör det vara * för ovillkorlig uppdatering.

parameters

WikiUpdateContract

Wiki-uppdateringsparametrar.

options

ProductWikiUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ProductWikiUpdateResponse>