ApiWiki interface

Balíček:

@azure/arm-apimanagement

Rozhraní představující apiWiki.

Metody

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)	Vytvoří nový wikiweb pro rozhraní API nebo aktualizuje existující.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)	Odstraní zadaný wiki z rozhraní API.
get(string, string, string, ApiWikiGetOptionalParams)	Získá podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)	Získá verzi stavu entity (Etag) wiki pro rozhraní API určené jeho identifikátorem.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)	Aktualizuje podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem.

Podrobnosti metody

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

Vytvoří nový wikiweb pro rozhraní API nebo aktualizuje existující.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

parameters

WikiContract

Vytvořte parametry.

options

ApiWikiCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiWikiCreateOrUpdateResponse>

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

Odstraní zadaný wiki z rozhraní API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

ifMatch

string

ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

options

ApiWikiDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Získá podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

options

ApiWikiGetOptionalParams

Parametry možností.

Návraty

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Získá verzi stavu entity (Etag) wiki pro rozhraní API určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

options

ApiWikiGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<ApiWikiGetEntityTagHeaders>

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

Aktualizuje podrobnosti wikiwebu pro rozhraní API určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

apiId

string

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

ifMatch

string

ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

parameters

WikiUpdateContract

Parametry aktualizace wikiwebu

options

ApiWikiUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiWikiUpdateResponse>