通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ProductWiki interface

  • 参考
包:
@azure/arm-apimanagement

表示 ProductWiki 的接口。

方法

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

为产品创建新的 Wiki 或更新现有 Wiki。
delete(string, string, string, string, ProductWikiDeleteOptionalParams)

从产品中删除指定的 Wiki。
get(string, string, string, ProductWikiGetOptionalParams)

获取由其标识符指定的产品的 Wiki 的详细信息。
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)

获取由其标识符指定的产品的 Wiki 实体状态 （Etag） 版本。
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)

更新由其标识符指定的产品的 Wiki 的详细信息。

方法详细信息

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

为产品创建新的 Wiki 或更新现有 Wiki。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

productId

string

产品标识符。 当前 API 管理服务实例中必须是唯一的。

parameters
WikiContract

创建参数。

options
ProductWikiCreateOrUpdateOptionalParams

选项参数。

返回

Promise<ProductWikiCreateOrUpdateResponse>

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

从产品中删除指定的 Wiki。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

productId

string

产品标识符。 当前 API 管理服务实例中必须是唯一的。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

options
ProductWikiDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, ProductWikiGetOptionalParams)

获取由其标识符指定的产品的 Wiki 的详细信息。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

productId

string

产品标识符。 当前 API 管理服务实例中必须是唯一的。

options
ProductWikiGetOptionalParams

选项参数。

返回

Promise<ProductWikiGetResponse>

getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)

获取由其标识符指定的产品的 Wiki 实体状态 （Etag） 版本。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

productId

string

产品标识符。 当前 API 管理服务实例中必须是唯一的。

options
ProductWikiGetEntityTagOptionalParams

选项参数。

返回

Promise<ProductWikiGetEntityTagHeaders>

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

更新由其标识符指定的产品的 Wiki 的详细信息。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

productId

string

产品标识符。 当前 API 管理服务实例中必须是唯一的。

ifMatch

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配，或者它应为 * 进行无条件更新。

parameters
WikiUpdateContract

Wiki 更新参数。

options
ProductWikiUpdateOptionalParams

选项参数。

返回

Promise<ProductWikiUpdateResponse>