通过

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

ApiPolicy interface

  • 参考
包:
@azure/arm-apimanagement

表示 ApiPolicy 的接口。

方法

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

为 API 创建或更新策略配置。
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

删除 Api 上的策略配置。
get(string, string, string, string, ApiPolicyGetOptionalParams)

获取 API 级别的策略配置。
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

获取由其标识符指定的 API 策略的实体状态 （Etag） 版本。
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

获取 API 级别的策略配置。

方法详细信息

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

为 API 创建或更新策略配置。

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

policyId

string

策略的标识符。

parameters
PolicyContract

要应用的策略内容。

options
ApiPolicyCreateOrUpdateOptionalParams

选项参数。

返回

Promise<ApiPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

删除 Api 上的策略配置。

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

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

policyId

string

策略的标识符。

ifMatch

string

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

options
ApiPolicyDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, string, ApiPolicyGetOptionalParams)

获取 API 级别的策略配置。

function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

policyId

string

策略的标识符。

options
ApiPolicyGetOptionalParams

选项参数。

返回

Promise<ApiPolicyGetResponse>

getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

获取由其标识符指定的 API 策略的实体状态 （Etag） 版本。

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

policyId

string

策略的标识符。

options
ApiPolicyGetEntityTagOptionalParams

选项参数。

返回

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

获取 API 级别的策略配置。

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

API 修订标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

options
ApiPolicyListByApiOptionalParams

选项参数。

返回

Promise<PolicyCollection>