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

ApiOperationPolicy interface

表示 ApiOperationPolicy 的接口。

方法

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)

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

delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)

删除 Api作中的策略配置。

get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)

获取 API作级别的策略配置。

getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)

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

listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)

获取 API作级别的策略配置列表。

方法详细信息

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

operationId

string

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

policyId

string

策略的标识符。

parameters
PolicyContract

要应用的策略内容。

返回

delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)

删除 Api作中的策略配置。

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

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

operationId

string

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

policyId

string

策略的标识符。

ifMatch

string

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

options
ApiOperationPolicyDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)

获取 API作级别的策略配置。

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

operationId

string

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

policyId

string

策略的标识符。

options
ApiOperationPolicyGetOptionalParams

选项参数。

返回

getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

operationId

string

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

policyId

string

策略的标识符。

返回

listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)

获取 API作级别的策略配置列表。

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>

参数

resourceGroupName

string

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

serviceName

string

API 管理服务的名称。

apiId

string

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

operationId

string

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

返回

Promise<PolicyCollection>