ApiOperation interface

套件:

@azure/arm-apimanagement

表示 ApiOperation 的介面。

方法

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)	在 API 中建立新的作業，或更新現有的作業。
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)	刪除 API 中指定的作業。
get(string, string, string, string, ApiOperationGetOptionalParams)	取得其識別碼所指定的 API 作業詳細數據。
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)	取得其標識碼所指定的 API 作業實體狀態 （Etag） 版本。
listByApi(string, string, string, ApiOperationListByApiOptionalParams)	列出指定之 API 的作業集合。
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)	更新其識別碼所指定 API 中作業的詳細數據。

方法詳細資料

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

在 API 中建立新的作業，或更新現有的作業。

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

apiId

string

API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

operationId

string

API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。

parameters

OperationContract

建立參數。

options

ApiOperationCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<ApiOperationCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

刪除 API 中指定的作業。

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

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

apiId

string

API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

operationId

string

API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。

ifMatch

string

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

options

ApiOperationDeleteOptionalParams

選項參數。

傳回

Promise<void>

get(string, string, string, string, ApiOperationGetOptionalParams)

取得其識別碼所指定的 API 作業詳細數據。

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

apiId

string

API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

operationId

string

API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。

options

ApiOperationGetOptionalParams

選項參數。

傳回

Promise<ApiOperationGetResponse>

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

取得其標識碼所指定的 API 作業實體狀態 （Etag） 版本。

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

apiId

string

API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

operationId

string

API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。

options

ApiOperationGetEntityTagOptionalParams

選項參數。

傳回

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

列出指定之 API 的作業集合。

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

apiId

string

API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

options

ApiOperationListByApiOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

更新其識別碼所指定 API 中作業的詳細數據。

function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

apiId

string

API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

operationId

string

API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。

ifMatch

string

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

parameters

OperationUpdateContract

API 作業更新參數。

options

ApiOperationUpdateOptionalParams

選項參數。

傳回

Promise<ApiOperationUpdateResponse>