你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ApiWiki interface
表示 ApiWiki 的接口。
方法
| create |
为 API 创建新的 Wiki 或更新现有 Wiki。 |
| delete(string, string, string, string, Api |
从 API 中删除指定的 Wiki。 |
| get(string, string, string, Api |
获取由其标识符指定的 API 的 Wiki 的详细信息。 |
| get |
获取由其标识符指定的 API 的 Wiki 实体状态 （Etag） 版本。 |
| update(string, string, string, string, Wiki |
更新由其标识符指定的 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
创建参数。
选项参数。
返回
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 管理服务实例中必须是唯一的。
选项参数。
返回
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>