共用方式為

Policy interface

  • 參考
套件:
@azure/arm-apimanagement

代表原則的介面。

方法

createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)

建立或更新 Api 管理服務的全域原則設定。
delete(string, string, string, string, PolicyDeleteOptionalParams)

刪除 Api 管理服務的全域原則設定。
get(string, string, string, PolicyGetOptionalParams)

取得 Api 管理服務的全域原則定義。
getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)

取得 Api 管理服務中全域原則定義的實體狀態 （Etag） 版本。
listByService(string, string, PolicyListByServiceOptionalParams)

列出 Api 管理服務的所有全域原則定義。

方法詳細資料

createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)

建立或更新 Api 管理服務的全域原則設定。

function createOrUpdate(resourceGroupName: string, serviceName: string, policyId: string, parameters: PolicyContract, options?: PolicyCreateOrUpdateOptionalParams): Promise<PolicyCreateOrUpdateResponse>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

policyId

string

原則的標識碼。

parameters
PolicyContract

要套用的原則內容。

options
PolicyCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<PolicyCreateOrUpdateResponse>

delete(string, string, string, string, PolicyDeleteOptionalParams)

刪除 Api 管理服務的全域原則設定。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

policyId

string

原則的標識碼。

ifMatch

string

實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。

options
PolicyDeleteOptionalParams

選項參數。

傳回

Promise<void>

get(string, string, string, PolicyGetOptionalParams)

取得 Api 管理服務的全域原則定義。

function get(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetOptionalParams): Promise<PolicyGetResponse>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

policyId

string

原則的標識碼。

options
PolicyGetOptionalParams

選項參數。

傳回

Promise<PolicyGetResponse>

getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)

取得 Api 管理服務中全域原則定義的實體狀態 （Etag） 版本。

function getEntityTag(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetEntityTagOptionalParams): Promise<PolicyGetEntityTagHeaders>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

policyId

string

原則的標識碼。

options
PolicyGetEntityTagOptionalParams

選項參數。

傳回

Promise<PolicyGetEntityTagHeaders>

listByService(string, string, PolicyListByServiceOptionalParams)

列出 Api 管理服務的所有全域原則定義。

function listByService(resourceGroupName: string, serviceName: string, options?: PolicyListByServiceOptionalParams): Promise<PolicyCollection>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

serviceName

string

API 管理服務的名稱。

options
PolicyListByServiceOptionalParams

選項參數。

傳回

Promise<PolicyCollection>