WorkspaceApi interface
表示 WorkspaceApi 的介面。
方法
| begin |
在 API 管理服務實例中建立新的或更新工作區的現有指定 API。 |
| begin |
在 API 管理服務實例中建立新的或更新工作區的現有指定 API。 |
| delete(string, string, string, string, string, Workspace |
刪除 API 管理服務實例中工作區的指定 API。 |
| get(string, string, string, string, Workspace |
取得其識別碼所指定的 API 詳細數據。 |
| get |
取得其標識碼所指定 API 的實體狀態 （Etag） 版本。 |
| list |
列出 API 管理服務實例中工作區的所有 API。 |
| update(string, string, string, string, string, Api |
更新 API 管理服務實例中工作區的指定 API。 |
方法詳細資料
beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
在 API 管理服務實例中建立新的或更新工作區的現有指定 API。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- parameters
- ApiCreateOrUpdateParameter
建立或更新參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
在 API 管理服務實例中建立新的或更新工作區的現有指定 API。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- parameters
- ApiCreateOrUpdateParameter
建立或更新參數。
選項參數。
傳回
Promise<WorkspaceApiCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)
刪除 API 管理服務實例中工作區的指定 API。
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, options?: WorkspaceApiDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- options
- WorkspaceApiDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, string, WorkspaceApiGetOptionalParams)
取得其識別碼所指定的 API 詳細數據。
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- options
- WorkspaceApiGetOptionalParams
選項參數。
傳回
Promise<WorkspaceApiGetResponse>
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)
取得其標識碼所指定 API 的實體狀態 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
選項參數。
傳回
Promise<WorkspaceApiGetEntityTagHeaders>
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)
列出 API 管理服務實例中工作區的所有 API。
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。
傳回
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)
更新 API 管理服務實例中工作區的指定 API。
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- workspaceId
-
string
工作區標識碼。 目前 API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂標識碼。 目前 API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- parameters
- ApiUpdateContract
API 更新合約參數。
- options
- WorkspaceApiUpdateOptionalParams
選項參數。
傳回
Promise<WorkspaceApiUpdateResponse>