ApiOperationPolicy interface
代表 ApiOperationPolicy 的介面。
方法
方法詳細資料
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 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
選項參數。
傳回
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
原則的識別碼。
選項參數。
傳回
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
取得實體狀態 (Etag) 其識別碼所指定的 API 作業原則版本。
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>