共用方式為

GatewayApi interface

  • 參考
套件:
@azure/arm-apimanagement

代表 GatewayApi 的介面。

方法

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

將 API 新增至指定的閘道。
delete(string, string, string, string, GatewayApiDeleteOptionalParams)

從指定的閘道刪除指定的 API。
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

檢查識別碼所指定的 API 實體是否與閘道實體相關聯。
listByService(string, string, string, GatewayApiListByServiceOptionalParams)

列出與閘道相關聯的 API 集合。

方法詳細資料

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

將 API 新增至指定的閘道。

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

gatewayId

string

閘道實體識別碼。 目前API 管理服務實例中必須是唯一的。 不得有值 'managed'

apiId

string

API 識別碼。 目前API 管理服務實例中必須是唯一的。

options
GatewayApiCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<ApiContract>

delete(string, string, string, string, GatewayApiDeleteOptionalParams)

從指定的閘道刪除指定的 API。

function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

gatewayId

string

閘道實體識別碼。 目前API 管理服務實例中必須是唯一的。 不得有值 'managed'

apiId

string

API 識別碼。 目前API 管理服務實例中必須是唯一的。

options
GatewayApiDeleteOptionalParams

選項參數。

傳回

Promise<void>

getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

檢查識別碼所指定的 API 實體是否與閘道實體相關聯。

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

gatewayId

string

閘道實體識別碼。 目前API 管理服務實例中必須是唯一的。 不得有值 'managed'

apiId

string

API 識別碼。 目前API 管理服務實例中必須是唯一的。

options
GatewayApiGetEntityTagOptionalParams

選項參數。

傳回

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

列出與閘道相關聯的 API 集合。

function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

參數

resourceGroupName

string

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

serviceName

string

API 管理服務的名稱。

gatewayId

string

閘道實體識別碼。 目前API 管理服務實例中必須是唯一的。 不得有值 'managed'

options
GatewayApiListByServiceOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>