共用方式為

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)

取得實體狀態 (Etag) 其識別碼所指定的 API 原則版本。
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)

取得實體狀態 (Etag) 其識別碼所指定的 API 原則版本。

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>