WorkspaceApiOperation interface
表示 WorkspaceApiOperation 的介面。
方法
方法詳細資料
createOrUpdate(string, string, string, string, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)
在 API 中建立新的作業，或更新現有的作業。
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, parameters: OperationContract, options?: WorkspaceApiOperationCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- operationId
-
string
API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。
- parameters
- OperationContract
建立參數。
選項參數。
傳回
delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)
刪除 API 中指定的作業。
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, options?: WorkspaceApiOperationDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- operationId
-
string
API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
選項參數。
傳回
Promise<void>
get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)
取得其識別碼所指定的 API 作業詳細數據。
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetOptionalParams): Promise<WorkspaceApiOperationGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- operationId
-
string
API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<WorkspaceApiOperationGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)
取得其標識碼所指定的 API 作業實體狀態 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetEntityTagOptionalParams): Promise<WorkspaceApiOperationGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- operationId
-
string
API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。
傳回
listByApi(string, string, string, string, WorkspaceApiOperationListByApiOptionalParams)
列出指定之 API 的作業集合。
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
選項參數。
傳回
update(string, string, string, string, string, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)
更新其識別碼所指定 API 中作業的詳細數據。
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: WorkspaceApiOperationUpdateOptionalParams): Promise<WorkspaceApiOperationUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- operationId
-
string
API 內的作業標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- parameters
- OperationUpdateContract
API 作業更新參數。
選項參數。
傳回
Promise<WorkspaceApiOperationUpdateResponse>