共用方式為

ApiWiki interface

  • 參考
套件:
@azure/arm-apimanagement

表示 ApiWiki 的介面。

方法

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

為 API 建立新的 Wiki，或更新現有的 Wiki。
delete(string, string, string, string, ApiWikiDeleteOptionalParams)

從 API 刪除指定的 Wiki。
get(string, string, string, ApiWikiGetOptionalParams)

取得其識別碼所指定 API 的 Wiki 詳細數據。
getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

取得其標識碼所指定 API 的 Wiki 實體狀態 （Etag） 版本。
update(string, string, string, string, WikiUpdateContract, ApiWikiUpdateOptionalParams)

針對其標識碼所指定的 API，更新 Wiki 的詳細數據。

方法詳細資料

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

為 API 建立新的 Wiki，或更新現有的 Wiki。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

apiId

string

API 識別碼。 目前 API 管理服務實例中必須是唯一的。

parameters
WikiContract

建立參數。

options
ApiWikiCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<ApiWikiCreateOrUpdateResponse>

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

從 API 刪除指定的 Wiki。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

apiId

string

API 識別碼。 目前 API 管理服務實例中必須是唯一的。

ifMatch

string

實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。

options
ApiWikiDeleteOptionalParams

選項參數。

傳回

Promise<void>

get(string, string, string, ApiWikiGetOptionalParams)

取得其識別碼所指定 API 的 Wiki 詳細數據。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

apiId

string

API 識別碼。 目前 API 管理服務實例中必須是唯一的。

options
ApiWikiGetOptionalParams

選項參數。

傳回

Promise<ApiWikiGetResponse>

getEntityTag(string, string, string, ApiWikiGetEntityTagOptionalParams)

取得其標識碼所指定 API 的 Wiki 實體狀態 （Etag） 版本。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

apiId

string

API 識別碼。 目前 API 管理服務實例中必須是唯一的。

options
ApiWikiGetEntityTagOptionalParams

選項參數。

傳回

Promise<ApiWikiGetEntityTagHeaders>

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

針對其標識碼所指定的 API，更新 Wiki 的詳細數據。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

apiId

string

API 識別碼。 目前 API 管理服務實例中必須是唯一的。

ifMatch

string

實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。

parameters
WikiUpdateContract

Wiki 更新參數。

options
ApiWikiUpdateOptionalParams

選項參數。

傳回

Promise<ApiWikiUpdateResponse>