ApiWiki interface

Package:

@azure/arm-apimanagement

Interface representing a ApiWiki.

Methods

createOrUpdate(string, string, string, WikiContract, ApiWikiCreateOrUpdateOptionalParams)	Creates a new Wiki for an API or updates an existing one.
delete(string, string, string, string, ApiWikiDeleteOptionalParams)	Deletes the specified Wiki from an API.
get(string, string, string, ApiWikiGetOptionalParams)	Gets the details of the Wiki for an API specified by its identifier.
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)	Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)	Updates the details of the Wiki for an API specified by its identifier.

Method Details

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

Creates a new Wiki for an API or updates an existing one.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API identifier. Must be unique in the current API Management service instance.

parameters

WikiContract

Create parameters.

options

ApiWikiCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ApiWikiCreateOrUpdateResponse>

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

Deletes the specified Wiki from an API.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options

ApiWikiDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

Gets the details of the Wiki for an API specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API identifier. Must be unique in the current API Management service instance.

options

ApiWikiGetOptionalParams

The options parameters.

Returns

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API identifier. Must be unique in the current API Management service instance.

options

ApiWikiGetEntityTagOptionalParams

The options parameters.

Returns

Promise<ApiWikiGetEntityTagHeaders>

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

Updates the details of the Wiki for an API specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API identifier. Must be unique in the current API Management service instance.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters

WikiUpdateContract

Wiki Update parameters.

options

ApiWikiUpdateOptionalParams

The options parameters.

Returns

Promise<ApiWikiUpdateResponse>