Apis interface
表示 Api 的介面。
方法
方法詳細資料
createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)
建立新的或更新現有的 API。
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, resource: Api, options?: ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
Azure API 中心服務的名稱。
- workspaceName
-
string
工作區的名稱。
- apiName
-
string
API 的名稱。
- resource
- Api
資源建立參數。
- options
- ApisCreateOrUpdateOptionalParams
選項參數。
傳回
Promise<ApisCreateOrUpdateResponse>
delete(string, string, string, string, ApisDeleteOptionalParams)
刪除指定的 API。
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
Azure API 中心服務的名稱。
- workspaceName
-
string
工作區的名稱。
- apiName
-
string
API 的名稱。
- options
- ApisDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, string, ApisGetOptionalParams)
傳回 API 的詳細數據。
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisGetOptionalParams): Promise<ApisGetResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
Azure API 中心服務的名稱。
- workspaceName
-
string
工作區的名稱。
- apiName
-
string
API 的名稱。
- options
- ApisGetOptionalParams
選項參數。
傳回
Promise<ApisGetResponse>
head(string, string, string, string, ApisHeadOptionalParams)
檢查指定的 API 是否存在。
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisHeadOptionalParams): Promise<ApisHeadResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
Azure API 中心服務的名稱。
- workspaceName
-
string
工作區的名稱。
- apiName
-
string
API 的名稱。
- options
- ApisHeadOptionalParams
選項參數。
傳回
Promise<ApisHeadResponse>
list(string, string, string, ApisListOptionalParams)
傳回 API 的集合。
function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
Azure API 中心服務的名稱。
- workspaceName
-
string
工作區的名稱。
- options
- ApisListOptionalParams
選項參數。