通过

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

ApiRelease interface

包:
@azure/arm-apimanagement

表示 ApiRelease 的接口。

方法

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)

为 API 创建新版本。
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

删除 API 中的指定版本。
get(string, string, string, string, ApiReleaseGetOptionalParams)

返回 API 版本的详细信息。
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

返回 API 版本的 etag。
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

列出 API 的所有版本。 在使 API 修订处于最新状态时，会创建 API 版本。 版本还用于回退到以前的修订。 结果将分页，并可由$top和$skip参数约束。
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

更新由其标识符指定的 API 版本的详细信息。

方法详细信息

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)

为 API 创建新版本。

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

releaseId

string

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

parameters
ApiReleaseContract

创建参数。

options
ApiReleaseCreateOrUpdateOptionalParams

选项参数。

返回

Promise<ApiReleaseCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

删除 API 中的指定版本。

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

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

releaseId

string

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

ifMatch

string

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

options
ApiReleaseDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, string, ApiReleaseGetOptionalParams)

返回 API 版本的详细信息。

function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

releaseId

string

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

options
ApiReleaseGetOptionalParams

选项参数。

返回

Promise<ApiReleaseGetResponse>

getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

返回 API 版本的 etag。

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

releaseId

string

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

options
ApiReleaseGetEntityTagOptionalParams

选项参数。

返回

Promise<ApiReleaseGetEntityTagHeaders>

listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

列出 API 的所有版本。 在使 API 修订处于最新状态时，会创建 API 版本。 版本还用于回退到以前的修订。 结果将分页，并可由$top和$skip参数约束。

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

options
ApiReleaseListByServiceOptionalParams

选项参数。

返回

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

更新由其标识符指定的 API 版本的详细信息。

function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

releaseId

string

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

ifMatch

string

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

parameters
ApiReleaseContract

API 发布更新参数。

options
ApiReleaseUpdateOptionalParams

选项参数。

返回

Promise<ApiReleaseUpdateResponse>