ApiWiki interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en ApiWiki.

Metoder

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)	Skapar en ny Wiki för ett API eller uppdaterar en befintlig.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)	Tar bort den angivna Wiki-sidan från ett API.
get(string, string, string, ApiWikiGetOptionalParams)	Hämtar information om Wiki för ett API som anges av dess identifierare.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) av Wikin för ett API som anges av dess identifierare.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)	Uppdateringar information om Wiki för ett API som anges av dess identifierare.

Metodinformation

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)

Skapar en ny Wiki för ett API eller uppdaterar en befintlig.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: WikiContract, options?: ApiWikiCreateOrUpdateOptionalParams): Promise<ApiWikiCreateOrUpdateResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

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

parameters

WikiContract

Skapa parametrar.

options

ApiWikiCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiWikiCreateOrUpdateResponse>

delete(string, string, string, string, ApiWikiDeleteOptionalParams)

Tar bort den angivna Wiki-sidan från ett API.

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

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-identifierare. 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

ApiWikiDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Hämtar information om Wiki för ett API som anges av dess identifierare.

function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetOptionalParams): Promise<ApiWikiGetResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

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

options

ApiWikiGetOptionalParams

Alternativparametrarna.

Returer

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) av Wikin för ett API som anges av dess identifierare.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiWikiGetEntityTagOptionalParams): Promise<ApiWikiGetEntityTagHeaders>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

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

options

ApiWikiGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<ApiWikiGetEntityTagHeaders>

update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ApiWikiUpdateOptionalParams): Promise<ApiWikiUpdateResponse>

Parametrar

resourceGroupName

string

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

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-identifierare. 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

ApiWikiUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiWikiUpdateResponse>